provide() — vue Function Reference

Architecture documentation for the provide() function in apiInject.ts from the vue codebase.

Function typescript VueCore GlobalAPI calls 1

Entity Profile

VueCore→ GlobalAPI→ provide() — vue Function Reference

Dependency Diagram

graph TD
  edf6e84a_a9b3_f218_50da_70c66a6fd2b4["provide()"]
  83b69f04_ff47_67cf_7f1c_542b323e1eb5["apiInject.ts"]
  edf6e84a_a9b3_f218_50da_70c66a6fd2b4 -->|defined in| 83b69f04_ff47_67cf_7f1c_542b323e1eb5
  6d02ba8b_00f1_96e7_030f_48516ba393f8["resolveProvided()"]
  edf6e84a_a9b3_f218_50da_70c66a6fd2b4 -->|calls| 6d02ba8b_00f1_96e7_030f_48516ba393f8
  style edf6e84a_a9b3_f218_50da_70c66a6fd2b4 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/v3/apiInject.ts lines 7–16

export function provide<T>(key: InjectionKey<T> | string | number, value: T) {
  if (!currentInstance) {
    if (__DEV__) {
      warn(`provide() can only be used inside setup().`)
    }
  } else {
    // TS doesn't allow symbol as index type
    resolveProvided(currentInstance)[key as string] = value
  }
}