Class ContainerResolver<KnownBindings>

Container resolver exposes the APIs to resolve bindings. You can think of resolver as an isolated container instance, with only the APIs to resolve bindings.

const container = new Container()
const resolver = container.createResolver()

await resolver.make(BINDING_NAME)
await resolver.make(CLASS_CONSTRUCTOR)

Type Parameters

KnownBindings extends Record<any, any>

Index

Constructors

constructor

Methods

hasBinding hasAllBindings resolveFor make call bindValue

Constructors

constructor

new ContainerResolver<KnownBindings extends Record<any, any>>(
    container: {
        bindings: Bindings;
        bindingValues: BindingValues;
        swaps: Swaps;
        hooks: Hooks;
        aliases: Map<
            keyof KnownBindings,
            keyof KnownBindings
            | AbstractConstructor<any>,
        >;
        contextualBindings: Map<Constructor<any>, ContextualBindings>;
    },
    options: ContainerOptions,
): ContainerResolver<KnownBindings>
Initialize the container resolver with container bindings and options
Type Parameters
- KnownBindings extends Record<any, any>
Parameters
- container: {
      bindings: Bindings;
      bindingValues: BindingValues;
      swaps: Swaps;
      hooks: Hooks;
      aliases: Map<
          keyof KnownBindings,
          keyof KnownBindings
          | AbstractConstructor<any>,
      >;
      contextualBindings: Map<Constructor<any>, ContextualBindings>;
  }
- options: ContainerOptions
Returns ContainerResolver<KnownBindings>
- Defined in src/resolver.ts:108

Methods

hasBinding

hasBinding<Binding extends string | number | symbol>(binding: Binding): boolean
Find if the resolver has a binding registered using the "bind", the "singleton", or the "bindValue" methods.
Type Parameters
- Binding extends string | number | symbol
Parameters
- binding: Binding
Returns boolean
True if binding exists, false otherwise
- Defined in src/resolver.ts:402
hasBinding(binding: BindingKey): boolean
Find if the resolver has a binding registered using the "bind", the "singleton", or the "bindValue" methods.
Parameters
- binding: BindingKey
Returns boolean
True if binding exists, false otherwise
- Defined in src/resolver.ts:403

hasAllBindings

hasAllBindings<Binding extends string | number | symbol>(
bindings: Binding[],
): boolean
Find if the resolver has all the bindings registered using the "bind", the "singleton", or the "bindValue" methods.
Type Parameters
- Binding extends string | number | symbol
Parameters
- bindings: Binding[]
Returns boolean
True if all bindings exist, false otherwise
- Defined in src/resolver.ts:419
hasAllBindings(bindings: BindingKey[]): boolean
Find if the resolver has all the bindings registered using the "bind", the "singleton", or the "bindValue" methods.
Parameters
- bindings: BindingKey[]
Returns boolean
True if all bindings exist, false otherwise
- Defined in src/resolver.ts:420

resolveFor

resolveFor<Binding>(
    parent: unknown,
    binding: Binding,
    runtimeValues?: any[],
    createError?: ErrorCreator,
): Promise<Make<Binding>>
Resolves binding in context of a parent. The method is same as the "make" method, but instead takes a parent class constructor.
Type Parameters
- Binding
Parameters
- parent: unknown
- binding: Binding
- OptionalruntimeValues: any[]
- createError: ErrorCreator = ...
Returns Promise<Make<Binding>>
- Defined in src/resolver.ts:430

make

make<Binding extends string | number | symbol>(
    binding: Binding,
    runtimeValues?: any[],
    createError?: ErrorCreator,
): Promise<
    Binding extends string
    | symbol
        ? KnownBindings[Binding<Binding>]
        : Make<Binding>,
>
Resolves the binding or constructor a class instance as follows.
- Resolve the binding from the values (if registered)
- Resolve the binding from the bindings (if registered)
- If binding is a class, then create a instance of it. The constructor dependencies are further resolved as well.
- All other values are returned as it is.
```
await resolver.make('route')
await resolver.make(Database)
```
Type Parameters
- Binding extends string | number | symbol
Parameters
- binding: Binding
- OptionalruntimeValues: any[]
- OptionalcreateError: ErrorCreator
Returns Promise<
    Binding extends string
    | symbol
        ? KnownBindings[Binding<Binding>]
        : Make<Binding>,
>
- Defined in src/resolver.ts:465
make<Binding>(
    binding: Binding,
    runtimeValues?: any[],
    createError?: ErrorCreator,
): Promise<Make<Binding>>
Resolves the binding or constructor a class instance as follows.
- Resolve the binding from the values (if registered)
- Resolve the binding from the bindings (if registered)
- If binding is a class, then create a instance of it. The constructor dependencies are further resolved as well.
- All other values are returned as it is.
```
await resolver.make('route')
await resolver.make(Database)
```
Type Parameters
- Binding
Parameters
- binding: Binding
- OptionalruntimeValues: any[]
- OptionalcreateError: ErrorCreator
Returns Promise<Make<Binding>>
- Defined in src/resolver.ts:470

call

call<Value extends Record<any, any>, Method extends string | number | symbol>(
    value: Value,
    method: Method,
    runtimeValues?: any[],
    createError?: ErrorCreator,
): Promise<ReturnType<Value[Method]>>
Call a method on an object by injecting its dependencies. The method dependencies are resolved in the same manner as a class constructor dependencies.
```
await resolver.call(await resolver.make(UsersController), 'index')
```
Type Parameters
- Value extends Record<any, any>
- Method extends string | number | symbol
Parameters
- value: Value
- method: Method
- OptionalruntimeValues: any[]
- createError: ErrorCreator = ...
Returns Promise<ReturnType<Value[Method]>>
- Defined in src/resolver.ts:499

bindValue

bindValue<Binding extends string | number | symbol>(
binding: Binding extends string | symbol ? Binding<Binding> : never,
value: KnownBindings[Binding],
): void
Register a binding as a value
```
container.bindValue(Route, new Route())
```
Type Parameters
- Binding extends string | number | symbol
Parameters
- binding: Binding extends string | symbol ? Binding<Binding> : never
  Need to narrow down the "Binding" for the case where "KnownBindings" are <any, any>
- value: KnownBindings[Binding]
Returns void
Binds the value to the resolver
- Defined in src/resolver.ts:547
bindValue<Binding extends AbstractConstructor<any>>(
binding: Binding,
value: InstanceType<Binding>,
): void
Register a binding as a value
```
container.bindValue(Route, new Route())
```
Type Parameters
- Binding extends AbstractConstructor<any>
Parameters
- binding: Binding
- value: InstanceType<Binding>
Returns void
Binds the value to the resolver
- Defined in src/resolver.ts:554

Class ContainerResolver<KnownBindings>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ContainerResolver<KnownBindings>

Methods

hasBinding

Type Parameters

Parameters

Returns boolean

Parameters

Returns boolean

hasAllBindings

Type Parameters

Parameters

Returns boolean

Parameters

Returns boolean

resolveFor

Type Parameters

Parameters

Returns Promise<Make<Binding>>

make

Type Parameters

Parameters

Returns Promise< Binding extends string | symbol ? KnownBindings[Binding<Binding>] : Make<Binding>,>

Type Parameters

Parameters

Returns Promise<Make<Binding>>

call

Type Parameters

Parameters

Returns Promise<ReturnType<Value[Method]>>

bindValue

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

Settings

On This Page

Returns Promise<
Binding extends string
| symbol
? KnownBindings[Binding<Binding>]
: Make<Binding>,
>