Class Container<KnownBindings>

Initialize the container with optional configuration

Define an emitter instance to use

Create a container resolver to resolve bindings, or make classes.

const resolver = container.createResolver()
await resolver.make(CLASS_CONSTRUCTOR)
Copy

Bind values with the resolver. Resolver values are isolated from the container.

resolver.bindValue(HttpContext, new HttpContext())
await resolver.make(UsersController)
Copy

Find if the container has a binding registered using the "bind", the "singleton", or the "bindValue" methods.

Find if the container has a binding registered using the "bind", the "singleton", or the "bindValue" methods.

Find if the container has all the bindings registered using the "bind", the "singleton", or the "bindValue" methods.

Find if the container has all the bindings registered using the "bind", the "singleton", or the "bindValue" methods.

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 container.make('route')
await container.make(Database)
Copy

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 container.make('route')
await container.make(Database)
Copy

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 container.call(await container.make(UsersController), 'index')
Copy

Register an alias for a binding. The value can be a reference to an existing binding or to a class constructor that will instantiate to the same value as the alias.

Register a binding inside the container. The method receives a key-value pair.

• Key can be a string, symbol or a constructor.
• The value is always a factory function to construct the dependency.

container.bind('route', () => new Route())
await container.make('route')

container.bind(Route, () => new Route())
await container.make(Route)

const routeSymbol = Symbol('route')
container.bind(routeSymbol, () => new Route())
await container.make(routeSymbol)
Copy

Register a binding inside the container. The method receives a key-value pair.

• Key can be a string, symbol or a constructor.
• The value is always a factory function to construct the dependency.

container.bind('route', () => new Route())
await container.make('route')

container.bind(Route, () => new Route())
await container.make(Route)

const routeSymbol = Symbol('route')
container.bind(routeSymbol, () => new Route())
await container.make(routeSymbol)
Copy

Register a binding as a value

container.bindValue(Route, new Route())
Copy

Register a binding as a value

container.bindValue(Route, new Route())
Copy

Register a binding as a single. The singleton method is same as the bind method, but the factory function is invoked only once.

container.singleton('route', () => new Route())
await container.make('route')

container.singleton(Route, () => new Route())
await container.make(Route)

const routeSymbol = Symbol('route')
container.singleton(routeSymbol, () => new Route())
await container.make(routeSymbol)
Copy

Register a binding as a single. The singleton method is same as the bind method, but the factory function is invoked only once.

container.singleton('route', () => new Route())
await container.make('route')

container.singleton(Route, () => new Route())
await container.make(Route)

const routeSymbol = Symbol('route')
container.singleton(routeSymbol, () => new Route())
await container.make(routeSymbol)
Copy

Define a fake implementation for a binding or a class constructor. Fakes have the highest priority when resolving dependencies from the container.

Restore binding by removing its swap

Restore mentioned or all bindings by removing their swaps

Define hooks to be executed after a binding has been resolved from the container.

The hooks are executed for

• Bindings
• Only once for singletons
• And class constructor

In other words, the hooks are not executed for direct values registered with the container

Define hooks to be executed after a binding has been resolved from the container.

The hooks are executed for

• Bindings
• Only once for singletons
• And class constructor

In other words, the hooks are not executed for direct values registered with the container

Create a contextual builder to define contextual bindings

Add a contextual binding for a given class constructor. A contextual takes a parent, parent's dependency and a callback to self resolve the dependency.

For example:

• When "UsersController"
• Asks for "Hash class"
• Provide "Argon2" implementation