@stompbox/tape-delay 1.0.10 → 1.0.12

package/dist/index.cjs

@@ -52,9 +52,9 @@ const Scope = {
     ConstantValue
 };
 class TapeDelay {
-    constructor(entries, getEnvironment){
+    constructor(entries, environmentDetector){
         this.entries = entries;
-        this.getEnvironment = getEnvironment;
+        this.environmentDetector = environmentDetector;
         this.key = Math.random().toString();
         this.container = (environment)=>{
             const globalContainer = globalThis;
@@ -96,7 +96,7 @@ class TapeDelay {
             return container;
         };
         this.instance = (entryName)=>{
-            const environment = this.getEnvironment ? this.getEnvironment() : process.env.NODE_ENV;
+            const environment = this.environmentDetector ? this.environmentDetector() : process.env.NODE_ENV;
             const container = this.container(environment);
             return container.get(entryName.toString());
         };

package/dist/index.d.ts

@@ -13,10 +13,55 @@ type Entry<T> = [EntryDescription<T>, EntryDescription<T>, EntryDescription<T>]
 export type Entries = Record<string, Entry<unknown>>;
 export type EnvironmentDetector = () => Environment;
 type EntryType<T> = T extends Entry<infer G> ? PublicFields<G> : never;
+/**
+ * Lifetime scopes.
+ */
 export declare const Scope: {
+    /**
+     * Singleton scope.
+     *
+     * @example
+     * ```ts
+     * import { Scope } from '@stompbox/tape-delay'
+     *
+     * const entries = { A: Scope.Singleton(A) }
+     * ```
+     */
     Singleton: <T>(EntryClass: ClassEntry<T>) => EntryDescription<T>;
+    /**
+     * Transient scope (used by default).
+     *
+     * @example
+     * ```ts
+     * import { Scope } from '@stompbox/tape-delay'
+     *
+     * const entries = { A: Scope.Transient(A) }
+     * ```
+     */
     Transient: <T>(EntryClass: ClassEntry<T>) => EntryDescription<T>;
+    /**
+     * Request scope.
+     *
+     * @example
+     * ```ts
+     * import { Scope } from '@stompbox/tape-delay'
+     *
+     * const entries = { A: Scope.Request(A) }
+     * ```
+     */
     Request: <T>(EntryClass: ClassEntry<T>) => EntryDescription<T>;
+    /**
+     * Constant value scope.
+     *
+     * @example
+     * ```ts
+     * import { Scope } from '@stompbox/tape-delay'
+     *
+     * const instance = new A()
+     *
+     * const entries = { A: Scope.ConstantValue(instance) }
+     * ```
+     */
     ConstantValue: <T>(value: T) => ConstantValueEntry<T>;
 };
 /**
@@ -57,7 +102,19 @@ export declare class TapeDelay<T extends Entries> {
      * ```
      */
     private readonly entries;
-    private readonly getEnvironment?;
+    /**
+     * Optional environment detector. `process.env.NODE_ENV` is used by default.
+     *
+     * @example
+     * ```ts
+     * const randomEnvDetector: EnvironmentDetector = () => {
+     *     if (Math.random() > 0.5) { return 'test' }
+     *     if (Math.random() > 0.5) { return 'development' }
+     *     return 'production'
+     * }
+     * ```
+     */
+    private readonly environmentDetector?;
     private readonly key;
     constructor(
     /**
@@ -83,7 +140,20 @@ export declare class TapeDelay<T extends Entries> {
      * }
      * ```
      */
-    entries: T, getEnvironment?: EnvironmentDetector | undefined);
+    entries: T, 
+    /**
+     * Optional environment detector. `process.env.NODE_ENV` is used by default.
+     *
+     * @example
+     * ```ts
+     * const randomEnvDetector: EnvironmentDetector = () => {
+     *     if (Math.random() > 0.5) { return 'test' }
+     *     if (Math.random() > 0.5) { return 'development' }
+     *     return 'production'
+     * }
+     * ```
+     */
+    environmentDetector?: EnvironmentDetector | undefined);
     private container;
     instance: <E extends keyof T>(entryName: E) => EntryType<T[E]>;
 }

package/dist/index.js

@@ -21,9 +21,9 @@ const Scope = {
     ConstantValue: ConstantValue
 };
 class TapeDelay {
-    constructor(entries, getEnvironment){
+    constructor(entries, environmentDetector){
         this.entries = entries;
-        this.getEnvironment = getEnvironment;
+        this.environmentDetector = environmentDetector;
         this.key = Math.random().toString();
         this.container = (environment)=>{
             const globalContainer = globalThis;
@@ -65,7 +65,7 @@ class TapeDelay {
             return container;
         };
         this.instance = (entryName)=>{
-            const environment = this.getEnvironment ? this.getEnvironment() : process.env.NODE_ENV;
+            const environment = this.environmentDetector ? this.environmentDetector() : process.env.NODE_ENV;
             const container = this.container(environment);
             return container.get(entryName.toString());
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stompbox/tape-delay",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "license": "MIT",
   "description": "Plug-and-play DI based on Inversify",
   "repository": {