@libreworks/container
@libreworks/container
@libreworks/container
@libreworks/container
+
A simple asynchronous dependency injection container and event target.
-Installation
npm install @libreworks/container
+Installation
+npm install @libreworks/container
This library conforms to ECMAScript Modules (ESM). You can import this module using ESM or TypeScript syntax.
@@ -12,13 +14,17 @@ InstallationCopy
If you're using CommonJS, you must use dynamic imports instead.
-Usage
You can use this library to create a graph of objects with intertwined dependencies. These objects and values can even be produced asynchronously.
-Container
A container provides named values.
+Usage
+You can use this library to create a graph of objects with intertwined dependencies. These objects and values can even be produced asynchronously.
+Container
+A container provides named values.
import { Foobar } from "your-package-name-here";
// Assume we created a Container.
declare const container: Container;
// Retrieve a value by its name.
const myObject: Foobar = await container.get("MyObject");
// Retrieve multiple values by their names.
const allObjects: Foobar[] = await container.getAll(["MyObject", "Another"]);
// Retrieve values by tag.
const taggedByMe: Foobar[] = await container.getAllTagged("my-tag");
Events
The Container class extends the EventTarget class (see MDN docs).
Builder
In order to put together a Container, you can use the Builder class.
Events
+The Container class extends the EventTarget class (see MDN docs).
Builder
+In order to put together a Container, you can use the Builder class.
const builder = new Builder()
// Register a constant
.constant("ExampleValue", "Lorem ipsum dolor sit amet")
// Register an array.
.constant("my.numbers", [1, 2, 3, 5, 8, 13, 21])
// Register an object created synchronously.
.register("RandomName", () => AnotherClass.doSomething())
// Register an object created asynchronously.
.register(
"an-async-value",
async (c) => {
const myNumbers = await c.get("my.numbers");
return await createNewThingy(myNumbers);
},
["my-tag", "AnotherTag", "Yet another"]
);
const container = await builder.build();
// Use the get method's generic type if you prefer.
const anAsyncValue = await container.get<MyClassName>("an-async-value");
BuilderEager Creation
Normally, values are lazy-loaded; they are created on-demand. However, you can provide the @eager tag when you call the register method to ensure your objects initialize themselves when the container is created.
Eager Creation
+Normally, values are lazy-loaded; they are created on-demand. However, you can provide the @eager tag when you call the register method to ensure your objects initialize themselves when the container is created.
const builder = new Builder().register("FooBar", () => new Thingy(), [
"@eager",
]);
const container = await builder.build();
// Thingy has already been instantiated.