Class PartialContainer<Services, Dependencies>

In order to create a [Container], the InjectableFunctions maintained by the PartialContainer must be memoized into Factories that can resolve their dependencies and return the correct Service.

In particular, this requires access to a "parent" Container to avoid infinite looping in cases where Service A depends on Service A – this is allowed (as long as the parent container provides Service A), but requires access to the parent Container to provide the parent implementation of Service A.

This also means that Services provided by a PartialContainer to a Container via this function will always be scoped to the Container. In other words, if a PartialContainer containing Service A is provided to both Container X and Container Y, when Service A is resolved by Container X the InjectableFunction used to create Service A will be invoked – and when Service A is resolved by Container Y, the InjectableFunction will be invoked again.

Create a new PartialContainer which provides a Service created by a pre-built InjectableFunction.

Tip: Prefer the inline forms provides('token', () => value) or provides('token', ['dep'] as const, (dep) => value) instead.

Create a new PartialContainer which provides a Service created by a zero-argument factory function.

Example

const partial = new PartialContainer({}).provides('Logger', () => new Logger());
const container = Container.provides(partial);
Copy

Create a new PartialContainer which provides a Service created by a factory function with dependencies. Dependencies that are not already provided by this PartialContainer will be tracked and must be fulfilled by the Container this PartialContainer is eventually provided to.

Example

const partial = new PartialContainer({})
  .provides('ApiClient', ['config'] as const, (config: Config) => new ApiClient(config));

// 'config' must be provided by the Container
const container = Container.providesValue('config', myConfig).provides(partial);
Copy

Merges services from another PartialContainer into this one. Dependencies from both containers are combined, with any dependencies satisfied by the other container's services removed.

Example

const authModule = new PartialContainer({})
  .providesClass('AuthService', AuthService);

const apiModule = new PartialContainer({})
  .providesClass('ApiClient', ApiClient)
  .provides(authModule);
Copy

Merges services from a Container into this PartialContainer. Since Container services are fully resolved, they add no new dependencies and may satisfy existing ones.

Example

const configContainer = Container.fromObject({ apiUrl: '...', timeout: 5000 });
const partial = new PartialContainer({})
  .providesClass('ApiClient', ApiClient)
  .provides(configContainer); // satisfies ApiClient's config dependencies
Copy

Create a new PartialContainer which provides the given class as a Service, all of the class's dependencies will be resolved by the parent Container.

Example:

class Foo {
 static dependencies = ['bar'] as const;
 constructor(public bar: string) {}
}

const partial = new PartialContainer({}).providesClass("foo", Foo);
const foo = Container.providesValue("bar", "bar value").provides(partial).get("foo");
console.log(foo.bar); // "bar value"
Copy

Create a new PartialContainer which provides the given value as a Service.

Example:

const partial = new PartialContainer({}).providesValue("value", 42);
const value = Container.provides(partial).get("value");
console.log(value); // 42
Copy

Creates a new PartialContainer from a plain object containing service definitions. Each property of the object is registered as a value service with no dependencies.

Example

const partial = PartialContainer.fromObject({ apiUrl: "https://api.example.com", timeout: 5000 });
const container = Container.provides(partial);
console.log(container.get('apiUrl')); // "https://api.example.com"
Copy