@codefast/di 0.6.2 → 0.7.1

package/src/core/registry.ts

@@ -1,10 +1,13 @@
 import type { Binding } from "#/core/binding";
 import { bindingSlotEquals, bindingSlotToString } from "#/core/binding";
+import { getOrInsert } from "#/core/map-upsert";
 import type { BindingTag } from "#/core/tag";
 import type { Token } from "#/core/token";
 import type { BindingIdentifier, Constructor, DependencyKey } from "#/core/types";
 
 /**
+ * One container's binding store, indexed by token, binding id, and slot for fast lookup.
+ *
  * @since 0.3.16-canary.0
  */
 export class BindingRegistry {
@@ -235,7 +238,8 @@ export class BindingRegistry {
     if (criterion === undefined) {
       return;
     }
-    const byCriterion = (this.#simpleTagged ??= new Map()).getOrInsert(tokenKey, new Map<BindingTag, Binding>());
+    this.#simpleTagged ??= new Map();
+    const byCriterion = getOrInsert(this.#simpleTagged, tokenKey, new Map<BindingTag, Binding>());
     byCriterion.set(criterion, binding);
   }
 
@@ -261,8 +265,9 @@ export class BindingRegistry {
     if (firstCriterion === undefined) {
       return;
     }
-    const buckets = (this.#multiTagged ??= new Map()).getOrInsert(tokenKey, new Map<BindingTag, Array<Binding>>());
-    buckets.getOrInsert(firstCriterion, []).push(binding);
+    this.#multiTagged ??= new Map();
+    const buckets = getOrInsert(this.#multiTagged, tokenKey, new Map<BindingTag, Array<Binding>>());
+    getOrInsert(buckets, firstCriterion, []).push(binding);
   }
 
   #deindexMultiTaggedBinding(tokenKey: DependencyKey, binding: Binding): void {
@@ -287,7 +292,8 @@ export class BindingRegistry {
     if (name === undefined) {
       return;
     }
-    const bindingsByName = (this.#simpleNamed ??= new Map()).getOrInsert(tokenKey, new Map<string, Binding>());
+    this.#simpleNamed ??= new Map();
+    const bindingsByName = getOrInsert(this.#simpleNamed, tokenKey, new Map<string, Binding>());
     bindingsByName.set(name, binding);
   }
 

package/src/core/token.ts

@@ -3,6 +3,8 @@ import type { Constructor } from "#/core/constructor-type";
 declare const TOKEN_BRAND: unique symbol;
 
 /**
+ * A branded identifier carrying the value type its bindings resolve to.
+ *
  * @since 0.3.16-canary.0
  */
 export interface Token<out Value> {
@@ -11,6 +13,8 @@ export interface Token<out Value> {
 }
 
 /**
+ * Creates a named `Token` for the given value type.
+ *
  * @since 0.3.16-canary.0
  */
 export function token<Value>(name: string): Token<Value> {
@@ -18,6 +22,8 @@ export function token<Value>(name: string): Token<Value> {
 }
 
 /**
+ * Returns the display name of a token or class used as a dependency key.
+ *
  * @since 0.3.16-canary.0
  */
 export function tokenName(dependency: Token<unknown> | Constructor): string {

package/src/core/types.ts

@@ -16,6 +16,8 @@ export type DependencyKey = Token<unknown> | Constructor;
 // ── BindingScope ─────────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * The lifetime a binding's instances are cached under.
+ *
  * @since 0.3.16-canary.0
  */
 export type BindingScope = "singleton" | "transient" | "scoped";
@@ -24,6 +26,8 @@ export type BindingScope = "singleton" | "transient" | "scoped";
 
 declare const BINDING_ID_BRAND: unique symbol;
 /**
+ * A branded string that uniquely identifies one binding.
+ *
  * @since 0.3.16-canary.0
  */
 export type BindingIdentifier = string & { readonly [BINDING_ID_BRAND]: true };
@@ -31,6 +35,8 @@ export type BindingIdentifier = string & { readonly [BINDING_ID_BRAND]: true };
 // ── BindingKind ──────────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * The strategy a binding produces values with, set by the `to*()` call that created it.
+ *
  * @since 0.3.16-canary.0
  */
 export type BindingKind = "class" | "dynamic" | "dynamic-async" | "resolved" | "resolved-async" | "constant" | "alias";
@@ -38,11 +44,15 @@ export type BindingKind = "class" | "dynamic" | "dynamic-async" | "resolved" | "
 // ── Handlers ─────────────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * A hook that runs after an instance is created and returns the instance to hand out.
+ *
  * @since 0.3.16-canary.0
  */
 export type ActivationHandler<Value> = (ctx: ResolutionContext, instance: Value) => Value | Promise<Value>;
 
 /**
+ * A hook that runs when a cached instance is released from its scope.
+ *
  * @since 0.3.16-canary.0
  */
 export type DeactivationHandler<Value> = (instance: Value) => void | Promise<void>;
@@ -50,6 +60,8 @@ export type DeactivationHandler<Value> = (instance: Value) => void | Promise<voi
 // ── ResolveOptions ───────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * Slot-selection criteria — a name and tags — that narrow which binding a resolve call matches.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ResolveOptions {
@@ -67,6 +79,8 @@ export interface ResolveOptions {
 // ── ResolutionFrame ──────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * One entry of the resolution stack: the token, scope, binding, and slot being resolved.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ResolutionFrame {
@@ -84,6 +98,8 @@ export interface ResolutionFrame {
 // ── ConstraintContext ────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * The resolution-time view — path, stack, parent, and ancestors — a `BindingConstraint` inspects.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ConstraintContext {
@@ -105,6 +121,8 @@ export type BindingConstraint = (ctx: ConstraintContext) => boolean;
 // ── ResolutionContext ────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * The container view a dynamic factory or activation handler resolves further dependencies through.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ResolutionContext {
@@ -123,6 +141,8 @@ export interface ResolutionContext {
 // ── TokenValue ───────────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * The value type a token or class constructor resolves to.
+ *
  * @since 0.3.16-canary.0
  */
 export type TokenValue<Type> =

package/src/decorators/inject.ts

@@ -35,6 +35,8 @@ type ClassAccessorDecorator<This, Value> = (
 ) => ClassAccessorDecoratorResult<This, Value> | void;
 
 /**
+ * Creates a dual-role value: an injection descriptor that also works as a class accessor decorator.
+ *
  * @since 0.3.16-canary.0
  */
 export function inject<Value>(

package/src/decorators/injectable.ts

@@ -7,6 +7,8 @@ import type { ParamMetadata } from "#/metadata/metadata-types";
 // ── AutoRegisterRegistry ─────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * The collector `@injectable` registers a class into, for a container to bind later.
+ *
  * @since 0.3.16-canary.0
  */
 export interface AutoRegisterRegistry {
@@ -15,6 +17,8 @@ export interface AutoRegisterRegistry {
 }
 
 /**
+ * Creates an empty auto-register registry.
+ *
  * @since 0.3.16-canary.0
  */
 export function createAutoRegisterRegistry(): AutoRegisterRegistry {
@@ -32,6 +36,8 @@ export function createAutoRegisterRegistry(): AutoRegisterRegistry {
 // ── InjectableOptions ────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * Auto-registration options `@injectable` accepts alongside its deps list.
+ *
  * @since 0.3.16-canary.0
  */
 export interface InjectableOptions {
@@ -83,6 +89,8 @@ export function injectable<const Deps extends ReadonlyArray<InjectableDependency
 ) => void;
 
 /**
+ * Writes the declared dependencies into the class's metadata and optionally auto-registers it.
+ *
  * @since 0.6.0
  */
 export function injectable(

package/src/decorators/lifecycle-decorators.ts

@@ -25,6 +25,8 @@ function recordLifecycleMethod(phase: "postConstruct" | "preDestroy"): MethodDec
 }
 
 /**
+ * Marks an instance method to run after the container constructs and wires the instance.
+ *
  * @since 0.3.16-canary.0
  */
 export function postConstruct(): MethodDecorator {
@@ -32,6 +34,8 @@ export function postConstruct(): MethodDecorator {
 }
 
 /**
+ * Marks an instance method to run when the instance's container or scope is disposed.
+ *
  * @since 0.3.16-canary.0
  */
 export function preDestroy(): MethodDecorator {

package/src/errors/errors.ts

@@ -1,6 +1,8 @@
 import type { BindingIdentifier, BindingScope, ResolveOptions } from "#/core/types";
 
 /**
+ * Base class for every error the library throws, each carrying a machine-readable `code`.
+ *
  * @since 0.3.16-canary.0
  */
 export abstract class DiError extends Error {
@@ -13,6 +15,8 @@ export abstract class DiError extends Error {
 }
 
 /**
+ * An internal assertion failure — a library bug, never caller misuse.
+ *
  * @since 0.3.16-canary.0
  */
 export class InternalError extends DiError {
@@ -24,6 +28,8 @@ export class InternalError extends DiError {
 }
 
 /**
+ * A token with no binding at all, even after walking the parent container chain.
+ *
  * @since 0.3.16-canary.0
  */
 export class TokenNotBoundError extends DiError {
@@ -50,6 +56,8 @@ function describeResolveOptions(options: ResolveOptions): string {
 }
 
 /**
+ * A token that has bindings, none of whose slots match the given `ResolveOptions`.
+ *
  * @since 0.3.16-canary.0
  */
 export class NoMatchingBindingError extends DiError {
@@ -69,6 +77,8 @@ export class NoMatchingBindingError extends DiError {
 }
 
 /**
+ * Two or more candidate bindings that matched without the more-specific rule deciding a winner.
+ *
  * @since 0.3.16-canary.0
  */
 export class AmbiguousBindingError extends DiError {
@@ -86,6 +96,8 @@ export class AmbiguousBindingError extends DiError {
 }
 
 /**
+ * A dependency cycle detected along the resolution path, alias chains included.
+ *
  * @since 0.3.16-canary.0
  */
 export class CircularDependencyError extends DiError {
@@ -99,6 +111,8 @@ export class CircularDependencyError extends DiError {
 }
 
 /**
+ * A sync `resolve()` of a token whose factory — or a dependency's factory — is async.
+ *
  * @since 0.3.16-canary.0
  */
 export class AsyncResolutionError extends DiError {
@@ -120,6 +134,8 @@ export class AsyncResolutionError extends DiError {
 }
 
 /**
+ * A sync `unbind()` of a binding whose `onDeactivation` handler is async.
+ *
  * @since 0.3.16-canary.0
  */
 export class AsyncDeactivationError extends DiError {
@@ -133,6 +149,8 @@ export class AsyncDeactivationError extends DiError {
 }
 
 /**
+ * The tokens, scopes, and resolution path describing a captive-dependency violation.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ScopeViolationDetails {
@@ -144,6 +162,8 @@ export interface ScopeViolationDetails {
 }
 
 /**
+ * A captive dependency — a longer-lived binding depending on a shorter-lived one.
+ *
  * @since 0.3.16-canary.0
  */
 export class ScopeViolationError extends DiError {
@@ -251,6 +271,8 @@ export class InvalidMetadataError extends DiError {
 }
 
 /**
+ * A class the container must construct but that carries no `@injectable()` metadata.
+ *
  * @since 0.3.16-canary.0
  */
 export class MissingMetadataError extends DiError {
@@ -266,6 +288,8 @@ export class MissingMetadataError extends DiError {
 }
 
 /**
+ * A sync `load()` given a module that needs async setup.
+ *
  * @since 0.3.16-canary.0
  */
 export class AsyncModuleLoadError extends DiError {
@@ -279,6 +303,8 @@ export class AsyncModuleLoadError extends DiError {
 }
 
 /**
+ * A synchronous disposal attempt on a container whose `onDeactivation` handlers may be async.
+ *
  * @since 0.3.16-canary.0
  */
 export class SyncDisposalNotSupportedError extends DiError {
@@ -292,6 +318,8 @@ export class SyncDisposalNotSupportedError extends DiError {
 }
 
 /**
+ * A `scoped` binding resolved from a container with no child scope context.
+ *
  * @since 0.3.16-canary.0
  */
 export class MissingScopeContextError extends DiError {
@@ -355,6 +383,8 @@ export class ChainNotRegisteredError extends DiError {
 }
 
 /**
+ * A `rebind()` of a token that has no own binding in this container.
+ *
  * @since 0.3.16-canary.0
  */
 export class RebindUnboundTokenError extends DiError {
@@ -410,6 +440,8 @@ export class StaticMemberDecoratorError extends DiError {
 }
 
 /**
+ * An operation attempted on a container that has already been disposed.
+ *
  * @since 0.3.16-canary.0
  */
 export class DisposedContainerError extends DiError {
@@ -421,6 +453,8 @@ export class DisposedContainerError extends DiError {
 }
 
 /**
+ * A `@postConstruct` or `onActivation` hook that returned a `Promise` on a sync resolution path.
+ *
  * @since 0.3.16-canary.0
  */
 export class AsyncActivationError extends DiError {

package/src/injection/descriptor.ts

@@ -4,6 +4,8 @@ import type { BindingTag, Constructor, TokenValue } from "#/core/types";
 import type { DependencySlot } from "#/injection/resolve-options";
 
 /**
+ * Slot-selection options — a name and tags — a declared dependency narrows its binding with.
+ *
  * @since 0.3.16-canary.0
  */
 export interface InjectOptions {
@@ -31,6 +33,8 @@ export interface InjectionDescriptor<out Value = unknown> extends DependencySlot
 }
 
 /**
+ * A dependency as declared: a bare token, a class, or a full injection descriptor.
+ *
  * @since 0.3.16-canary.0
  */
 export type InjectableDependency<Value = unknown> = Token<Value> | Constructor<Value> | InjectionDescriptor<Value>;
@@ -60,6 +64,8 @@ export type ResolvedDependencyValue<Dependency> = Dependency extends { readonly
 type DescribedValue<Dependency> = Dependency extends InjectionDescriptor<infer Value> ? Value : TokenValue<Dependency>;
 
 /**
+ * Returns whether the value is an `InjectionDescriptor`, dual-role `inject()` functions included.
+ *
  * @since 0.3.16-canary.0
  */
 export function isInjectionDescriptor(value: unknown): value is InjectionDescriptor {
@@ -81,6 +87,8 @@ export function isInjectionDescriptor(value: unknown): value is InjectionDescrip
 }
 
 /**
+ * Normalises a declared dependency to a plain `InjectionDescriptor`.
+ *
  * @since 0.3.16-canary.0
  */
 export function normalizeToDescriptor(dependency: InjectableDependency): InjectionDescriptor {
@@ -172,6 +180,8 @@ export function buildInjectionDescriptor<Value>(
 }
 
 /**
+ * Creates a descriptor that resolves to `undefined` instead of throwing when no binding matches.
+ *
  * @since 0.3.16-canary.0
  */
 export function optional<Value>(
@@ -189,6 +199,8 @@ export function optional<Value>(
 }
 
 /**
+ * Creates a descriptor that resolves every matching binding for the token into an array.
+ *
  * @since 0.3.16-canary.0
  */
 export function injectAll<Value>(

package/src/introspection/dependency-graph.ts

@@ -43,6 +43,8 @@ export interface GraphEdge {
 }
 
 /**
+ * A container's dependency graph as plain JSON — nodes, edges, and whether the parent is included.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ContainerGraphJson {
@@ -52,6 +54,8 @@ export interface ContainerGraphJson {
 }
 
 /**
+ * Options controlling what a dependency graph includes.
+ *
  * @since 0.3.16-canary.0
  */
 export interface GraphOptions {
@@ -255,6 +259,8 @@ function addRegistryBindings(
 }
 
 /**
+ * Builds the JSON dependency graph of a registry's bindings, optionally including the parent's.
+ *
  * @since 0.3.16-canary.0
  */
 export function buildDependencyGraph(

package/src/introspection/graph-adapters/cytoscape.ts

@@ -1,6 +1,8 @@
 import type { ContainerGraphJson, GraphNode } from "#/introspection/dependency-graph";
 
 /**
+ * A dependency-graph node in Cytoscape's element format.
+ *
  * @since 0.3.16-canary.0
  */
 export interface CytoscapeNode {
@@ -15,6 +17,8 @@ export interface CytoscapeNode {
 }
 
 /**
+ * A dependency-graph edge in Cytoscape's element format.
+ *
  * @since 0.3.16-canary.0
  */
 export interface CytoscapeEdge {
@@ -29,11 +33,15 @@ export interface CytoscapeEdge {
 }
 
 /**
+ * The flat node-and-edge list Cytoscape takes as its `elements` input.
+ *
  * @since 0.3.16-canary.0
  */
 export type CytoscapeElements = ReadonlyArray<CytoscapeNode | CytoscapeEdge>;
 
 /**
+ * Converts a container's dependency graph into Cytoscape's element list.
+ *
  * @since 0.3.16-canary.0
  */
 export function toCytoscapeGraph(graph: ContainerGraphJson): CytoscapeElements {

package/src/introspection/graph-adapters/dot.ts

@@ -7,6 +7,8 @@ function escapeDotString(value: string): string {
 }
 
 /**
+ * Renders a container's dependency graph as Graphviz DOT source.
+ *
  * @since 0.3.16-canary.0
  */
 export function toDotGraph(graph: ContainerGraphJson): string {

package/src/introspection/graph-adapters/reactflow.ts

@@ -1,6 +1,8 @@
 import type { ContainerGraphJson, GraphNode } from "#/introspection/dependency-graph";
 
 /**
+ * A dependency-graph node in React Flow's node format.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ReactFlowNode {
@@ -16,6 +18,8 @@ export interface ReactFlowNode {
 }
 
 /**
+ * A dependency-graph edge in React Flow's edge format.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ReactFlowEdge {
@@ -28,6 +32,8 @@ export interface ReactFlowEdge {
 }
 
 /**
+ * The nodes-and-edges pair a React Flow viewer renders.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ReactFlowGraph {
@@ -45,6 +51,8 @@ const GRID_CELL_WIDTH_PX = 200;
 const GRID_CELL_HEIGHT_PX = 100;
 
 /**
+ * Converts a container's dependency graph into React Flow nodes and edges on an initial grid.
+ *
  * @since 0.5.0-canary.7
  */
 export function toReactFlowGraph(graph: ContainerGraphJson): ReactFlowGraph {

package/src/introspection/inspector.ts

@@ -18,6 +18,8 @@ import { selectAllBindings } from "#/resolution/select/binding-select";
 // ── Public types ─────────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * A read-only view of one binding: token, kind, scope, slot, and id.
+ *
  * @since 0.3.16-canary.0
  */
 export interface BindingSnapshot {
@@ -32,6 +34,8 @@ export interface BindingSnapshot {
 }
 
 /**
+ * A read-only view of one container's own bindings and state.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ContainerSnapshot {
@@ -44,6 +48,8 @@ export interface ContainerSnapshot {
 // ── Inspector ────────────────────────────────────────────────────────────────────────────────────────────────────────
 
 /**
+ * The read-only introspection surface behind a container's `inspect()`.
+ *
  * @since 0.3.16-canary.0
  */
 export class Inspector {

package/src/lifecycle/lifecycle-manager.ts

@@ -1,4 +1,5 @@
 import type { Binding } from "#/core/binding";
+import { getOrInsert } from "#/core/map-upsert";
 import type { Token } from "#/core/token";
 import { tokenName } from "#/core/token";
 import type {
@@ -12,6 +13,8 @@ import { AsyncActivationError, AsyncDeactivationError, InvalidMetadataError } fr
 import type { MetadataReader } from "#/metadata/metadata-types";
 
 /**
+ * One container's registry of container-level activation and deactivation hooks, keyed by token.
+ *
  * @since 0.3.16-canary.0
  */
 export class LifecycleManager {
@@ -30,7 +33,8 @@ export class LifecycleManager {
     this.#activationVersion += 1;
     this.#cachedToken = undefined;
     this.#cachedHooks = undefined;
-    const list = (this.#activationHooks ??= new Map()).getOrInsert(token, []);
+    this.#activationHooks ??= new Map();
+    const list = getOrInsert(this.#activationHooks, token, []);
     list.push(handler as ActivationHandler<unknown>);
   }
 
@@ -62,7 +66,8 @@ export class LifecycleManager {
   }
 
   registerDeactivation<Value>(token: Token<Value> | Constructor<Value>, handler: DeactivationHandler<Value>): void {
-    const list = (this.#deactivationHooks ??= new Map()).getOrInsert(token, []);
+    this.#deactivationHooks ??= new Map();
+    const list = getOrInsert(this.#deactivationHooks, token, []);
     list.push(handler as DeactivationHandler<unknown>);
   }
 

package/src/lifecycle/scope-manager.ts

@@ -5,6 +5,8 @@ import type { BindingIdentifier } from "#/core/types";
 import { MissingScopeContextError } from "#/errors/errors";
 
 /**
+ * One container's instance caches — singletons, in-flight async creations, and the scoped cache.
+ *
  * @since 0.3.16-canary.0
  */
 export class ScopeManager {
@@ -84,7 +86,7 @@ export class ScopeManager {
   }
 
   setInflight(id: BindingIdentifier, promise: Promise<unknown>): void {
-    (this.#inflight ??= new Map()).set(id, promise);
+    (this.#inflight ??= new Map<BindingIdentifier, Promise<unknown>>()).set(id, promise);
   }
 
   clearInflight(id: BindingIdentifier): void {
@@ -114,7 +116,7 @@ export class ScopeManager {
     if (!this.isChild) {
       throw new MissingScopeContextError(tokenName(binding.token));
     }
-    (this.#scoped ??= new Map()).set(binding.id, instance);
+    (this.#scoped ??= new Map<BindingIdentifier, unknown>()).set(binding.id, instance);
   }
 
   /** Releases a removed binding's scoped instance. A scoped instance has no deactivation. */

package/src/metadata/metadata-keys.ts

@@ -1,12 +1,18 @@
 /**
+ * The metadata key `@injectable` writes a class's constructor dependencies under.
+ *
  * @since 0.3.16-canary.0
  */
 export const INJECTABLE_KEY: unique symbol = Symbol("di:injectable");
 /**
+ * The metadata key `@postConstruct` and `@preDestroy` record method names under.
+ *
  * @since 0.3.16-canary.0
  */
 export const LIFECYCLE_KEY: unique symbol = Symbol("di:lifecycle");
 /**
+ * The metadata key `@inject` accessors record their injection descriptors under.
+ *
  * @since 0.3.16-canary.0
  */
 export const INJECT_ACCESSOR_KEY: unique symbol = Symbol("di:inject-accessor");

package/src/metadata/metadata-reader-token.ts

@@ -3,6 +3,8 @@ import type { Token } from "#/core/token";
 import type { MetadataReader } from "#/metadata/metadata-types";
 
 /**
+ * The token a custom `MetadataReader` is bound to for a container to pick up.
+ *
  * @since 0.3.16-canary.0
  */
 export const MetadataReaderToken: Token<MetadataReader> = token<MetadataReader>("MetadataReader");

package/src/metadata/metadata-types.ts

@@ -15,6 +15,8 @@ export interface ParamMetadata extends DependencySlot {
 }
 
 /**
+ * A class's declared constructor dependencies, as a `MetadataReader` reports them.
+ *
  * @since 0.3.16-canary.0
  */
 export interface ConstructorMetadata {
@@ -22,6 +24,8 @@ export interface ConstructorMetadata {
 }
 
 /**
+ * The `postConstruct` and `preDestroy` method names a class declares.
+ *
  * @since 0.3.16-canary.0
  */
 export interface LifecycleMetadata {
@@ -40,6 +44,8 @@ export interface MutableLifecycleMetadata {
 }
 
 /**
+ * The port a container reads class metadata through — constructor deps, lifecycle, and accessors.
+ *
  * @since 0.3.16-canary.0
  */
 export interface MetadataReader {