Interface Builder<P>

A Container-like object used for providing values for a Module.

Type Parameters

P extends Graph = Empty

Hierarchy

Builder

Index

Methods

addScope apply bind detectCycles provide provideAsync provideInstance

Methods

addScope

addScope<S>(...scope): Builder<Provide<P, S extends any
? DepPair<S, never>
: never>>
Adds the given Scopes to this container. Any dependencies with this scope will be instantiated when first requested and memoized within this container.
Type Parameters
- S extends Scope
Parameters
- Rest ...scope: S[]
  
  The scope or scopes to add to this container
Returns Builder<Provide<P, S extends any
? DepPair<S, never>
: never>>
This container, now typed to include the added scopes

See
addScope
- Defined in src/lib/Container.ts:1033

apply

apply<M>(...modules): Builder<Merge<P, Provides<M>>>
Applies the given Modules or Items to this container. All scopes and dependencies provided with the modules will be applied to this container.
Type Parameters
- M extends Item[]
Parameters
- Rest ...modules: M
  
  The modules to apply to the container.
Returns Builder<Merge<P, Provides<M>>>
This container, now typed to include all types provided within the given modules

See
apply
- Defined in src/lib/Container.ts:1039

bind

bind<K, Src>(key, src): Builder<Provide<P, DepPair<ToBaseResource<K>, DepsOf<Src>> | DepPair<IsSync<ToBaseResource<K>>, IsSyncDepsOf<Src>>>>
Binds the resolved value of src to key. In other words, when key is requested, src will be used to provide the value. Equivalent to provide(key, Inject.from(src))
Type Parameters
- K extends ResourceKey
- Src extends any
Parameters
- key: K
  
  The key or class of the type to be provided
- src: Src
  
  The DependencyKey to use to when key is requested
Returns Builder<Provide<P, DepPair<ToBaseResource<K>, DepsOf<Src>> | DepPair<IsSync<ToBaseResource<K>>, IsSyncDepsOf<Src>>>>
This container, now typed to include the provided type and its dependencies

See
bind
- Defined in src/lib/Container.ts:1020

detectCycles

detectCycles(): Builder<P>
Returns Builder<P>

Deprecated
- Defined in src/lib/Container.ts:1042

provide

provide<K, SrcK, D, Sync, S>(key, ...args): Builder<Provide<P, PairForProvide<K, D, S> | PairForProvideIsSync<K, Sync, S>>>
Specifies how to resolve the target type of the given key or class.
Type Parameters
- K extends ResourceKey
  
  The type of the key or class object
- SrcK extends DependencyKey = never
  
  Identifies the source data for the provider
- D = DepsOf<SrcK>
  
  Identifies the dependencies of the provided type
- Sync = RequireSync<D>
  
  Identifies the dependencies for the type to be resolved synchronously
- S extends Scope = never
Parameters
- key: K
  
  The key or class of the type to be provided
- Rest ...args: [init: ComputedKey<Target<K>, any, D, Sync, P>] | [deps: SrcK, init: ((deps) => Target<K>)] | [init: (() => Target<K>)] | [scope: NonEmptyScopeList<S>, init: ComputedKey<Target<K>, any, D, Sync, P>] | [scope: NonEmptyScopeList<S>, deps: SrcK, init: ((deps) => Target<K>)] | [scope: NonEmptyScopeList<S>, init: (() => Target<K>)]
  The remaining arguments. These include:
  - scope (optional): The Scope or ScopeList to which to bind the provided value And one of the following:
  - init: A function returning the provided value, or a ComputedKey yielding the provided value
  - deps, init:
    
    deps: An object specifying which dependencies are required to provide the value
    
    init: A function that accepts the dependencies specified by deps and returns the provided value
Returns Builder<Provide<P, PairForProvide<K, D, S> | PairForProvideIsSync<K, Sync, S>>>
This container, now typed to include the provided type and its dependencies

See
provide
- Defined in src/lib/Container.ts:966

provideAsync

provideAsync<T, K, SrcK, D, S>(key, ...args): Builder<Provide<P, PairForProvide<K, D, S> | PairForProvideNotSync<K>>>
Specifies how to asynchronously resolve the target type of the given key or class. The signature is the same as provide, except that a Promise to the target type can be provided. The provided type cannot be directly requested through request. It can, however be requested through requestAsync or by using key.Async().
Type Parameters
- T
- K extends ResourceKey<Awaited<T>>
  
  The type of the key or class object
- SrcK extends DependencyKey = never
  
  Identifies the source data for the provider
- D = DepsOf<SrcK>
  
  Identifies the dependencies of the provided type
- S extends Scope = never
Parameters
- key: K
  
  The key or class of the type to be provided
- Rest ...args: [init: ComputedKey<T, any, D, any, P>] | [deps: SrcK, init: ((deps) => T)] | [init: (() => T)] | [scope: NonEmptyScopeList<S>, init: ComputedKey<T, any, D, any, P>] | [scope: NonEmptyScopeList<S>, deps: SrcK, init: ((deps) => T)] | [scope: NonEmptyScopeList<S>, init: (() => T)]
  The remaining arguments. These include:
  - scope (optional): The Scope or ScopeList to which to bind the provided value And one of the following:
  - init: An async function returning the provided value, or a ComputedKey yielding the provided value or a promise
  - deps, init:
    
    deps: An object specifying which dependencies are required to provide the value
    
    init: An async function that accepts the dependencies specified by deps and returns the provided value
Returns Builder<Provide<P, PairForProvide<K, D, S> | PairForProvideNotSync<K>>>
This container, now typed to include the provided type and its dependencies

See
provideAsync
- Defined in src/lib/Container.ts:991

provideInstance

provideInstance<K>(key, instance): Builder<Provide<P, DepPair<IsSync<ToBaseResource<K>>, never> | DepPair<ToBaseResource<K>, never>>>
Provides an instance of the target type for the given key or class.
Type Parameters
- K extends ResourceKey
  
  The type of the key or class object
Parameters
- key: K
  
  The key or class of the type to be provided
- instance: Target<K>
  
  The provided instance
Returns Builder<Provide<P, DepPair<IsSync<ToBaseResource<K>>, never> | DepPair<ToBaseResource<K>, never>>>
This container, now typed to include the provided type and its dependencies

See
provideInstance
- Defined in src/lib/Container.ts:1012

Interface Builder<P>

Type Parameters

P extends Graph = Empty

Hierarchy

Index

Methods

Methods

addScope

Type Parameters

S extends Scope

Parameters

Rest ...scope: S[]

Returns Builder<Provide<P, S extends any ? DepPair<S, never> : never>>

See

apply

Type Parameters

M extends Item[]

Parameters

Rest ...modules: M

Returns Builder<Merge<P, Provides<M>>>

See

bind

Type Parameters

K extends ResourceKey

Src extends any

Parameters

key: K

src: Src

Returns Builder<Provide<P, DepPair<ToBaseResource<K>, DepsOf<Src>> | DepPair<IsSync<ToBaseResource<K>>, IsSyncDepsOf<Src>>>>

See

detectCycles

Returns Builder<P>

Deprecated

provide

Type Parameters

K extends ResourceKey

SrcK extends DependencyKey = never

D = DepsOf<SrcK>

Sync = RequireSync<D>

S extends Scope = never

Parameters

key: K

Returns Builder<Provide<P, PairForProvide<K, D, S> | PairForProvideIsSync<K, Sync, S>>>

See

provideAsync

Type Parameters

T

K extends ResourceKey<Awaited<T>>

SrcK extends DependencyKey = never

D = DepsOf<SrcK>

S extends Scope = never

Parameters

key: K

Rest ...args: [init: ComputedKey<T, any, D, any, P>] | [deps: SrcK, init: ((deps) => T)] | [init: (() => T)] | [scope: NonEmptyScopeList<S>, init: ComputedKey<T, any, D, any, P>] | [scope: NonEmptyScopeList<S>, deps: SrcK, init: ((deps) => T)] | [scope: NonEmptyScopeList<S>, init: (() => T)]

Returns Builder<Provide<P, PairForProvide<K, D, S> | PairForProvideNotSync<K>>>

See

provideInstance

Type Parameters

K extends ResourceKey

Parameters

key: K

instance: Target<K>

Returns Builder<Provide<P, DepPair<IsSync<ToBaseResource<K>>, never> | DepPair<ToBaseResource<K>, never>>>

See

Settings

Member Visibility

Theme

On This Page

`Rest` ...scope: S[]

Returns Builder<Provide<P, S extends any
? DepPair<S, never>
: never>>

`Rest` ...modules: M

`Rest` ...args: [init: ComputedKey<T, any, D, any, P>] | [deps: SrcK, init: ((deps) => T)] | [init: (() => T)] | [scope: NonEmptyScopeList<S>, init: ComputedKey<T, any, D, any, P>] | [scope: NonEmptyScopeList<S>, deps: SrcK, init: ((deps) => T)] | [scope: NonEmptyScopeList<S>, init: (() => T)]