@stompbox/tape-delay 1.0.9 → 1.0.11

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

@@ -20,23 +20,95 @@ export declare const Scope: {
     ConstantValue: <T>(value: T) => ConstantValueEntry<T>;
 };
 /**
- * Tape Delay container.
+ * Tape Delay container. Takes entries and optional environment detector in the constructor.
  *
  * @example
  * ```ts
- * import { TapeDelay, injectable } from '@stompbox/tape-delay'
+ * import { TapeDelay } from '@stompbox/tape-delay'
+ * import { UserService } from '@/services/user.service'
  *
- * @injectable()
- * class A {}
+ * export const container = new TapeDelay({ UserService })
  *
- * const container = new TapeDelay({ A })
+ * const userService = container.instance('UserService')
  * ```
  */
 export declare class TapeDelay<T extends Entries> {
+    /**
+     * Entries describing DI container.
+     *
+     * @example
+     * ```ts
+     * import { Singleton } from '@stompbox/tape-delay'
+     * import { UserService } from '@/services/user.service'
+     * import { UsersInMemory, UsersInPrisma } from '@/stores/user'
+     *
+     * const entries = {
+     *     // One implementation for all environments
+     *     UserService,
+     *     UserStore: [
+     *         // Implementation for test environment
+     *         Singleton(UsersInMemory),
+     *         // Implementation for development environment
+     *         UsersInPrisma,
+     *         // Implementation for production environment
+     *         UsersInPrisma
+     *     ]
+     * }
+     * ```
+     */
     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(entries: T, getEnvironment?: EnvironmentDetector | undefined);
+    constructor(
+    /**
+     * Entries describing DI container.
+     *
+     * @example
+     * ```ts
+     * import { Singleton } from '@stompbox/tape-delay'
+     * import { UserService } from '@/services/user.service'
+     * import { UsersInMemory, UsersInPrisma } from '@/stores/user'
+     *
+     * const entries = {
+     *     // One implementation for all environments
+     *     UserService,
+     *     UserStore: [
+     *         // Implementation for test environment
+     *         Singleton(UsersInMemory),
+     *         // Implementation for development environment
+     *         UsersInPrisma,
+     *         // Implementation for production environment
+     *         UsersInPrisma
+     *     ]
+     * }
+     * ```
+     */
+    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.9",
+  "version": "1.0.11",
   "license": "MIT",
   "description": "Plug-and-play DI based on Inversify",
   "repository": {