Skip to content

⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric Count
🔧 Functions 3
📦 Imports 4
📊 Variables & Constants 1
🟢 Vue Composition API 2
📐 Interfaces 2
📑 Type Aliases 3

📚 Table of Contents

🛠️ File Location:

📂 packages/core/computedInject/index.ts

📦 Imports

Name Source
ComputedRef vue
InjectionKey vue
computed vue
inject vue

Variables & Constants

Name Type Kind Value Exported
source T let/var inject(key) as T | undefined ✗

Vue Composition API

Name Type Reactive Variables Composables
computed computed none none
computed computed none none

Functions

computedInject(key: InjectionKey<T> | string, getter: ComputedInjectGetter<T, K>): ComputedRef<K | undefined>

Code 
export function computedInject<T, K = any>(
  key: InjectionKey<T> | string,
  getter: ComputedInjectGetter<T, K>
): ComputedRef<K | undefined>
  • Parameters:
  • key: InjectionKey<T> | string
  • getter: ComputedInjectGetter<T, K>
  • Return Type: ComputedRef<K | undefined>

get(ctx: any): K

Code 
ctx => options.get(source, ctx)
  • Parameters:
  • ctx: any
  • Return Type: K
  • Calls:
  • options.get

get(ctx: any): K

Code 
ctx => options.get(source, ctx)
  • Parameters:
  • ctx: any
  • Return Type: K
  • Calls:
  • options.get

Interfaces

WritableComputedInjectOptions<T, K>

Interface Code 
export interface WritableComputedInjectOptions<T, K> {
  get: ComputedInjectGetter<T, K>
  set: ComputedInjectSetter<K>
}

Properties

Name Type Optional Description
get ComputedInjectGetter<T, K> ✗
set ComputedInjectSetter<K> ✗

WritableComputedInjectOptionsWithDefault<T, K>

Interface Code 
export interface WritableComputedInjectOptionsWithDefault<T, K> {
  get: ComputedInjectGetterWithDefault<T, K>
  set: ComputedInjectSetter<K>
}

Properties

Name Type Optional Description
get ComputedInjectGetterWithDefault<T, K> ✗
set ComputedInjectSetter<K> ✗

Type Aliases

ComputedInjectGetter<T, K>

type ComputedInjectGetter<T, K> = (source: T | undefined, ctx?: any) => K;

ComputedInjectGetterWithDefault<T, K>

type ComputedInjectGetterWithDefault<T, K> = (source: T, ctx?: any) => K;

ComputedInjectSetter<T>

type ComputedInjectSetter<T> = (v: T) => void;