2020-09-05 00:00:37 +08:00
|
|
|
import { isFunction } from '@vue/shared'
|
2019-06-19 17:31:49 +08:00
|
|
|
import { currentInstance } from './component'
|
2021-03-06 00:10:06 +08:00
|
|
|
import { currentRenderingInstance } from './componentRenderContext'
|
2019-08-21 03:51:55 +08:00
|
|
|
import { warn } from './warning'
|
2019-06-19 17:31:49 +08:00
|
|
|
|
2019-08-16 22:02:53 +08:00
|
|
|
export interface InjectionKey<T> extends Symbol {}
|
2019-06-19 17:31:49 +08:00
|
|
|
|
2020-12-01 05:36:02 +08:00
|
|
|
export function provide<T>(key: InjectionKey<T> | string | number, value: T) {
|
2019-06-19 17:31:49 +08:00
|
|
|
if (!currentInstance) {
|
2019-08-31 03:05:39 +08:00
|
|
|
if (__DEV__) {
|
2019-09-04 06:11:04 +08:00
|
|
|
warn(`provide() can only be used inside setup().`)
|
2019-08-31 03:05:39 +08:00
|
|
|
}
|
2019-06-19 17:31:49 +08:00
|
|
|
} else {
|
2019-06-19 22:48:22 +08:00
|
|
|
let provides = currentInstance.provides
|
|
|
|
// by default an instance inherits its parent's provides object
|
|
|
|
// but when it needs to provide values of its own, it creates its
|
|
|
|
// own provides object using parent provides object as prototype.
|
|
|
|
// this way in `inject` we can simply look up injections from direct
|
|
|
|
// parent and let the prototype chain do the work.
|
|
|
|
const parentProvides =
|
|
|
|
currentInstance.parent && currentInstance.parent.provides
|
|
|
|
if (parentProvides === provides) {
|
|
|
|
provides = currentInstance.provides = Object.create(parentProvides)
|
|
|
|
}
|
2019-10-09 00:43:13 +08:00
|
|
|
// TS doesn't allow symbol as index type
|
|
|
|
provides[key as string] = value
|
2019-06-19 17:31:49 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-20 02:45:11 +08:00
|
|
|
export function inject<T>(key: InjectionKey<T> | string): T | undefined
|
2020-09-05 00:00:37 +08:00
|
|
|
export function inject<T>(
|
|
|
|
key: InjectionKey<T> | string,
|
|
|
|
defaultValue: T,
|
2020-09-15 09:26:28 +08:00
|
|
|
treatDefaultAsFactory?: false
|
|
|
|
): T
|
|
|
|
export function inject<T>(
|
|
|
|
key: InjectionKey<T> | string,
|
|
|
|
defaultValue: T | (() => T),
|
|
|
|
treatDefaultAsFactory: true
|
2020-09-05 00:00:37 +08:00
|
|
|
): T
|
2019-10-22 23:26:48 +08:00
|
|
|
export function inject(
|
|
|
|
key: InjectionKey<any> | string,
|
2020-09-05 00:00:37 +08:00
|
|
|
defaultValue?: unknown,
|
|
|
|
treatDefaultAsFactory = false
|
2019-10-22 23:26:48 +08:00
|
|
|
) {
|
2019-11-06 11:35:24 +08:00
|
|
|
// fallback to `currentRenderingInstance` so that this can be called in
|
|
|
|
// a functional component
|
|
|
|
const instance = currentInstance || currentRenderingInstance
|
|
|
|
if (instance) {
|
2020-10-20 08:45:48 +08:00
|
|
|
// #2400
|
|
|
|
// to support `app.use` plugins,
|
|
|
|
// fallback to appContext's `provides` if the intance is at root
|
|
|
|
const provides =
|
|
|
|
instance.parent == null
|
|
|
|
? instance.vnode.appContext && instance.vnode.appContext.provides
|
|
|
|
: instance.parent.provides
|
|
|
|
|
|
|
|
if (provides && (key as string | symbol) in provides) {
|
2019-10-09 00:43:13 +08:00
|
|
|
// TS doesn't allow symbol as index type
|
|
|
|
return provides[key as string]
|
2020-03-31 03:24:55 +08:00
|
|
|
} else if (arguments.length > 1) {
|
2020-09-05 00:00:37 +08:00
|
|
|
return treatDefaultAsFactory && isFunction(defaultValue)
|
2021-06-10 00:02:05 +08:00
|
|
|
? defaultValue.call(instance.proxy)
|
2020-09-05 00:00:37 +08:00
|
|
|
: defaultValue
|
2019-08-21 03:51:55 +08:00
|
|
|
} else if (__DEV__) {
|
2019-10-26 22:52:29 +08:00
|
|
|
warn(`injection "${String(key)}" not found.`)
|
2019-08-21 03:51:55 +08:00
|
|
|
}
|
2019-09-04 06:11:04 +08:00
|
|
|
} else if (__DEV__) {
|
2019-11-06 11:35:24 +08:00
|
|
|
warn(`inject() can only be used inside setup() or functional components.`)
|
2019-06-19 17:31:49 +08:00
|
|
|
}
|
|
|
|
}
|