Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(inject): add treatDefaultAsFactory argument #503

Merged
merged 1 commit into from
Sep 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions src/apis/inject.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ComponentInstance } from '../component'
import { hasOwn, warn, currentVMInFn } from '../utils'
import { hasOwn, warn, currentVMInFn, isFunction } from '../utils'
import { getCurrentInstance } from '../runtimeContext'

const NOT_FOUND = {}
Expand Down Expand Up @@ -38,10 +38,15 @@ export function provide<T>(key: InjectionKey<T> | string, value: T): void {
}

export function inject<T>(key: InjectionKey<T> | string): T | undefined
export function inject<T>(key: InjectionKey<T> | string, defaultValue: T): T
export function inject<T>(
key: InjectionKey<T> | string,
defaultValue: T,
treatDefaultAsFactory?: boolean
): T
export function inject(
key: InjectionKey<any> | string,
defaultValue?: unknown
defaultValue?: unknown,
treatDefaultAsFactory = false
) {
if (!key) {
return defaultValue
Expand All @@ -55,12 +60,14 @@ export function inject(

const val = resolveInject(key, vm)
if (val !== NOT_FOUND) {
return val;
return val
}

if (defaultValue === undefined && __DEV__) {
warn(`Injection "${String(key)}" not found`, vm)
}

return defaultValue
return treatDefaultAsFactory && isFunction(defaultValue)
? defaultValue()
: defaultValue
}
21 changes: 21 additions & 0 deletions test/apis/inject.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,25 @@ describe('Hooks provide/inject', () => {
expect(obj1.msg).toBe('foo')
expect(obj2.msg).toBe('bar')
})

it('should call default value as factory', () => {
const State = Symbol()
let fn = jest.fn()
new Vue({
template: `<child/>`,
setup() {},
provide: {
X: { msg: 'bar' },
},
components: {
child: {
setup() {
inject(State, fn, true)
},
template: `<div/>`,
},
},
}).$mount()
expect(fn).toHaveBeenCalled()
})
})