Context - Documentation

new Context(name)

Creates new context instance.

Source:

context.js, line 10

Parameters:

Name	Type	Description
`name`	`string`	The context's name. This can be later used to fetch the instance from the repository. See Context.get, and Context.delete

Methods

(static) delete(name)

Removes a context instance with the given name from the repository.

Source:

context.js, line 29

Parameters:

Name	Type	Description
`name`	`string`	The context's name.

(static) get(name) → {Context|undefined}

Finds a context instance with the given name and return it. Returns undefined if not found.

Source:

context.js, line 20

Parameters:

Name	Type	Description
`name`	`string`	The context's name.

Returns:

Type:: Context | undefined

The context instance.

provide(key) → {Provider}

Creates and returns a new provider instance. The instance will be used as a provider for the dependency with the key. That is, when resolving dependency with the key, the returned provider will be used. See Provider API to customize provision settings.

Source:

context.js, line 61

Parameters:

Name	Type	Description
`key`	`string`	The key to register the provider.

Returns:

Type:: Provider

The new provider instance.

Example

context.provide('logger').as(console.log);

resolve(key) → {Promise.<any>}

Finds and returns the depedency with the given key.

Source:

context.js, line 78

Parameters:

Name	Type	Description
`key`	`string`	The dependency's key.

Throws:

Throws when no valid provider has been registered for the key.
Type DependencyError

Returns:

Type:: Promise.<any>

The resolved dependency.

Example

context.resolve('logger').then(log => log('Hello world'));

resolveAll(condopt) → {Promise.<Array.<any>>}

Resolves any dependencies that match the given condition.

Source:

context.js, line 101

Parameters:

Name	Type	Attributes	Description
`cond`	`Condition`	<optional>	The condition to match.

Returns:

Type:: Promise.<Array.<any>>

The dependencies matching the condition.

Example

context.resolveAll(['log', 'debug']).then(([log, debug]) => {
  debug('Print greeting message');
  log('Hello world');
});

using(cond, consumer)

Wraps function to automatically resolve dependencies and inject into arguments.

Source:

context.js, line 153

Parameters:

Name	Type	Description
`cond`	`Condition`
`consumer`	`function`

Example

const greet = context.using(['log', 'debug'], (log, debug, name) => {
  debug('Print greeting message');
  log(`Hello ${name}`);
});

greet('world');