${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rClass Builder
Index
Constructors
Methods
build
+Builder | @libreworks/container
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Class Builder
Assembles configuration for a dependency injection container.
+Methods
build
Builds a new container and resets the builder to a default state.
-Returns Promise<Container>
The Promised container.
-
constant
Registers a constant value as a component.
-Type Parameters
- T
Parameters
- name: string
The name of the component.
- - value: T
The static value to register as the component.
-
Returns this
provides a fluent interface.
-
has
Determines if a named component has been added to the builder.
-Parameters
- name: string
The component name to check.
-
Returns boolean
Whether the component factory is present.
-- name: string
register
Registers a component.
+
+Constructors
+constructor
+-
+
-
+
+++
Creates a new Builder.
+++Parameters
+-
+
- logger: Logger = nullLogger
+
The logger instance.
+
Returns Builder
- logger: Logger = nullLogger
+
+Methods
+build
+-
+
-
+
+++
Builds a new container and resets the builder to a default state.
+Returns Promise<Container>
The Promised container.
+
constant
+-
+
-
+
+++
Registers a constant value as a component.
++ +Type Parameters
+-
+
- T
++Parameters
+-
+
- name: string
+
The name of the component.
+
+ - value: T
+
The static value to register as the component.
+
Returns this
provides a fluent interface.
+
has
+-
+
-
+
+++
Determines if a named component has been added to the builder.
+++Parameters
+-
+
- name: string
+
The component name to check.
+
Returns boolean
Whether the component factory is present.
+ - name: string
+
register
+-
+
-
+
++
Registers a component.
The
factoryparameter must be aFunctionthat returns the component. You can provide an async function or one that returns aPromise.The
tagsparameter must be anArrayofstringvalues. There are a few @@ -24,9 +114,56 @@@eager- The component will be instantiated when the container is built.
Type Parameters
- T
Parameters
Returns this
provides a fluent interface.
-
reset
Abandons registered components and resets the builder to a default state.
-Returns void
Type Parameters
+-
+
- T
+
+Parameters
+Returns this
provides a fluent interface.
+reset
+-
+
-
+
+++
Abandons registered components and resets the builder to a default state.
+Returns void
Class Container
A simplistic asynchronous dependency injection container.
-Hierarchy
- EventTarget
- Container
Index
Constructors
Methods
addContainer | @libreworks/container
+
+
+
+
+
+
+
+
+
+
+
+
add
+
+
+
+add
+ dispatch
+dispatch
+ get
get
get
+
+
+get
+
+
+get
+
+
+get
+
+
+ remove
+remove
+
+
+
+Class Container
A simplistic asynchronous dependency injection container.
+Hierarchy
+-
+
- EventTarget
+
-
+
- Container
Methods
add
- addEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | AddEventListenerOptions,
): voidThe
+addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
+Methods
+add
+-
+
-
+addEventListener(+
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | AddEventListenerOptions,
): void+The
-addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
Optionaloptions: boolean | AddEventListenerOptions
Returns void
dispatch
- +
The
+dispatchEvent()method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.++Parameters
+-
+
- type: string +
- callback: EventListenerOrEventListenerObject | null +
Optionaloptions: boolean | AddEventListenerOptions
Returns void
dispatch
+-
+
-
+
++
The
-dispatchEvent()method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.Parameters
- event: Event
Returns boolean
get
Gets a named component from the container.
-Type Parameters
- T = any
Parameters
- name: string
The component name.
-
Returns Promise<T>
A promise that resolves to the registered component
-
get
Gets multiple named components from the container.
-Type Parameters
- T = any
Parameters
- names: ArrayLike<string> | Iterable<string, any, any>
The component names.
-
Returns Promise<T[]>
A Promise that resolves to the registered components
-
get
Gets any components registered under a specific tag.
-Type Parameters
- T = any
Parameters
- tag: string
The tag.
-
Returns Promise<T[]>
A Promise that resolves to the tagged components.
-
get
Gets the names of all registered components.
-Returns string[]
The registered component names.
-
has
- +
Checks if the container holds a named component.
+++Parameters
+-
+
- event: Event
Returns boolean
get
+-
+
-
+
+++
Gets a named component from the container.
++ +Type Parameters
+-
+
- T = any
++Parameters
+-
+
- name: string
+
The component name.
+
Returns Promise<T>
A promise that resolves to the registered component
+ +
get
+-
+
-
+
+++
Gets multiple named components from the container.
++ +Type Parameters
+-
+
- T = any
++Parameters
+-
+
- names: ArrayLike<string> | Iterable<string, any, any>
+
The component names.
+
Returns Promise<T[]>
A Promise that resolves to the registered components
+ +
get
+-
+
-
+
+++
Gets any components registered under a specific tag.
++ +Type Parameters
+-
+
- T = any
++Parameters
+-
+
- tag: string
+
The tag.
+
Returns Promise<T[]>
A Promise that resolves to the tagged components.
+
get
+-
+
-
+
+++
Gets the names of all registered components.
+Returns string[]
The registered component names.
+
has
+-
+
-
+
++
Checks if the container holds a named component.
If this method returns
-true, invokinggetwith the same parameter will not throw aRangeError.Parameters
- name: string
The component name.
-
Returns boolean
Whether the component exists in the container
- - name: string
remove
- removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | EventListenerOptions,
): void+The
+removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.++Parameters
+-
+
- name: string
+
The component name.
+
Returns boolean
Whether the component exists in the container
+ - name: string
+
remove
+-
+
-
+removeEventListener(+
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | EventListenerOptions,
): void+The
-removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
Optionaloptions: boolean | EventListenerOptions
Returns void
+
+Parameters
+-
+
- type: string +
- callback: EventListenerOrEventListenerObject | null +
Optionaloptions: boolean | EventListenerOptions
Returns void
Class Provider<T>
A named object that provides a value.
-Type Parameters
- T = any
Index
Constructors
Accessors
name
+Provider | @libreworks/container
+
+
+
Methods
+provide
+
+Constructors
+constructor
+
+Accessors
+name
+-
+
-
+get name(): string++
Returns string
The component name.
+
tags
+-
+
-
+get tags(): Set<string>++
Returns Set<string>
The tags for the component.
+
+Methods
+provide
+-
+
-
+
+++
Instantiates the component.
+If the factory function itself throws an Error or a rejected promise, this +result is cached and the factory will not be invoked a second time.
+++Parameters
+-
+
- container: Container
+
The container object.
+
Returns Promise<T>
the component as produced by the factory function.
+ - container: Container
+
@libreworks/container
Hierarchy Summary
+
+
diff --git a/docs/index.html b/docs/index.html
index 4d48bd7..a1288e6 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,7 +1,17 @@
-
+
+
+
+@libreworks/container
Hierarchy Summary
@libreworks/container
@libreworks/container
+
+
+
+Eager Creationconst builder = new Builder().register("FooBar", () => new Thingy(), [
+
+@libreworks/container
@libreworks/container
A simple asynchronous dependency injection container and event target.
@@ -37,4 +47,38 @@Eager Creationconst builder = new Builder().register("FooBar", () => new Thingy(), [
"@eager",
]);
const container = await builder.build();
// Thingy has already been instantiated.
-
+
+
+
+
diff --git a/package.json b/package.json
index 18c3193..b959559 100644
--- a/package.json
+++ b/package.json
@@ -6,25 +6,26 @@
"url": "https://github.com/libreworks/container.git"
},
"scripts": {
- "build": "npx projen build",
- "bump": "npx projen bump",
- "clobber": "npx projen clobber",
- "compile": "npx projen compile",
- "default": "npx projen default",
- "docgen": "npx projen docgen",
- "eject": "npx projen eject",
- "eslint": "npx projen eslint",
- "package": "npx projen package",
- "post-compile": "npx projen post-compile",
- "post-upgrade": "npx projen post-upgrade",
- "pre-compile": "npx projen pre-compile",
- "release": "npx projen release",
- "test": "npx projen test",
- "test:watch": "npx projen test:watch",
- "unbump": "npx projen unbump",
- "upgrade": "npx projen upgrade",
- "watch": "npx projen watch",
- "projen": "npx projen"
+ "build": "projen build",
+ "bump": "projen bump",
+ "bump:releasable-commits": "projen bump:releasable-commits",
+ "clobber": "projen clobber",
+ "compile": "projen compile",
+ "default": "projen default",
+ "docgen": "projen docgen",
+ "eject": "projen eject",
+ "eslint": "projen eslint",
+ "package": "projen package",
+ "post-compile": "projen post-compile",
+ "post-upgrade": "projen post-upgrade",
+ "pre-compile": "projen pre-compile",
+ "release": "projen release",
+ "test": "projen test",
+ "test:watch": "projen test:watch",
+ "unbump": "projen unbump",
+ "upgrade": "projen upgrade",
+ "watch": "projen watch",
+ "projen": "projen"
},
"author": {
"name": "LibreWorks Contributors",
@@ -43,14 +44,14 @@
"eslint-config-prettier": "^9.1.2",
"eslint-import-resolver-typescript": "^3.10.1",
"eslint-plugin-import": "^2.32.0",
- "eslint-plugin-prettier": "^5.5.5",
+ "eslint-plugin-prettier": "^5.5.6",
"jest": "^29.7.0",
- "jest-junit": "^16",
- "prettier": "^3.8.1",
- "projen": "^0.99.21",
- "ts-jest": "^29.4.6",
- "tsx": "^4.21.0",
- "typedoc": "^0.28.17",
+ "jest-junit": "^17",
+ "prettier": "^3.9.6",
+ "projen": "^0.103.23",
+ "ts-jest": "^29.4.12",
+ "tsx": "^4.23.13",
+ "typedoc": "^0.28.20",
"typescript": "^5.9.3"
},
"dependencies": {
@@ -121,7 +122,7 @@
"^.+\\.ts$": [
"ts-jest",
{
- "tsconfig": "tsconfig.dev.json",
+ "tsconfig": "test/tsconfig.json",
"useEsm": true,
"useESM": true
}
diff --git a/src/builder.ts b/src/builder.ts
index f0c72c6..a387e4b 100644
--- a/src/builder.ts
+++ b/src/builder.ts
@@ -24,7 +24,7 @@ export class Builder {
/**
* Abandons registered components and resets the builder to a default state.
*/
- reset() {
+ public reset() {
this.#providers.clear();
this.#eager.clear();
this.#logger.debug("The container builder is now in the default state");
@@ -36,7 +36,7 @@ export class Builder {
* @param name - The component name to check.
* @return Whether the component factory is present.
*/
- has(name: string): boolean {
+ public has(name: string): boolean {
return this.#providers.has(name);
}
@@ -90,18 +90,25 @@ export class Builder {
*/
public async build(): Promise
Assembles configuration for a dependency injection container.
-