@decaf-ts/injectable-decorators 1.6.1 → 1.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +21 -157
- package/README.md +272 -5
- package/dist/injectable-decorators.cjs +291 -136
- package/dist/injectable-decorators.esm.cjs +291 -136
- package/lib/Injectables.cjs +76 -18
- package/lib/Injectables.d.ts +75 -17
- package/lib/constants.cjs +8 -7
- package/lib/constants.d.ts +7 -6
- package/lib/decorators.cjs +158 -98
- package/lib/decorators.d.ts +80 -19
- package/lib/esm/Injectables.d.ts +75 -17
- package/lib/esm/Injectables.js +77 -19
- package/lib/esm/constants.d.ts +7 -6
- package/lib/esm/constants.js +8 -7
- package/lib/esm/decorators.d.ts +80 -19
- package/lib/esm/decorators.js +159 -98
- package/lib/esm/index.d.ts +6 -8
- package/lib/esm/index.js +12 -14
- package/lib/esm/registry.d.ts +68 -21
- package/lib/esm/registry.js +39 -2
- package/lib/esm/utils.d.ts +9 -9
- package/lib/esm/utils.js +10 -10
- package/lib/index.cjs +7 -9
- package/lib/index.d.ts +6 -8
- package/lib/registry.cjs +39 -2
- package/lib/registry.d.ts +68 -21
- package/lib/utils.cjs +10 -10
- package/lib/utils.d.ts +9 -9
- package/package.json +3 -3
package/lib/Injectables.cjs
CHANGED
|
@@ -3,59 +3,117 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.Injectables = void 0;
|
|
4
4
|
const registry_1 = require("./registry.cjs");
|
|
5
5
|
/**
|
|
6
|
-
* @
|
|
6
|
+
* @description Central registry for managing injectable dependencies.
|
|
7
|
+
* @summary Static class holding the access to the injectables functions. Provides methods for registering,
|
|
8
|
+
* retrieving, and building injectable objects.
|
|
9
|
+
* @template T Type of the injectable object
|
|
7
10
|
*
|
|
8
11
|
* @class Injectables
|
|
9
|
-
*
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* // Define an injectable class
|
|
15
|
+
* @injectable()
|
|
16
|
+
* class MyService {
|
|
17
|
+
* doSomething() {
|
|
18
|
+
* return 'Hello World';
|
|
19
|
+
* }
|
|
20
|
+
* }
|
|
21
|
+
*
|
|
22
|
+
* // Inject the service into another class
|
|
23
|
+
* class MyComponent {
|
|
24
|
+
* @inject()
|
|
25
|
+
* private service!: MyService;
|
|
26
|
+
*
|
|
27
|
+
* useService() {
|
|
28
|
+
* return this.service.doSomething();
|
|
29
|
+
* }
|
|
30
|
+
* }
|
|
31
|
+
*
|
|
32
|
+
* @mermaid
|
|
33
|
+
* sequenceDiagram
|
|
34
|
+
* participant Client
|
|
35
|
+
* participant Injectables
|
|
36
|
+
* participant Registry
|
|
37
|
+
*
|
|
38
|
+
* Client->>Injectables: register(MyService)
|
|
39
|
+
* Injectables->>Registry: register(MyService)
|
|
40
|
+
* Registry-->>Injectables: void
|
|
41
|
+
*
|
|
42
|
+
* Client->>Injectables: get("MyService")
|
|
43
|
+
* Injectables->>Registry: get("MyService")
|
|
44
|
+
* Registry-->>Injectables: MyService instance
|
|
45
|
+
* Injectables-->>Client: MyService instance
|
|
10
46
|
*/
|
|
11
47
|
class Injectables {
|
|
12
48
|
static { this.actingInjectablesRegistry = undefined; }
|
|
13
49
|
constructor() { }
|
|
14
50
|
/**
|
|
15
|
-
* @
|
|
16
|
-
* @
|
|
17
|
-
*
|
|
51
|
+
* @description Fetches an injectable instance by its registered name.
|
|
52
|
+
* @summary Retrieves the named {@link Injectable} from the registry. If the injectable is a singleton,
|
|
53
|
+
* returns the existing instance. Otherwise, creates a new instance.
|
|
54
|
+
* @template T Type of the injectable object to retrieve
|
|
55
|
+
* @param {string} name The registered name of the injectable to retrieve
|
|
56
|
+
* @param {any[]} args Constructor arguments to pass when instantiating the injectable
|
|
57
|
+
* @return {Injectable<T> | undefined} The injectable instance or undefined if not found
|
|
18
58
|
*/
|
|
19
59
|
static get(name, ...args) {
|
|
20
60
|
return Injectables.getRegistry().get(name, ...args);
|
|
21
61
|
}
|
|
22
62
|
/**
|
|
23
|
-
* @
|
|
24
|
-
* @
|
|
25
|
-
* @
|
|
26
|
-
*
|
|
63
|
+
* @description Adds a class or object to the injectable registry.
|
|
64
|
+
* @summary Registers an injectable constructor or instance with the registry, making it available for injection.
|
|
65
|
+
* @template T Type of the injectable object to register
|
|
66
|
+
* @param {Injectable<T>} constructor The class constructor or object instance to register
|
|
67
|
+
* @param {any[]} args Additional arguments for registration (category, singleton flag, etc.)
|
|
68
|
+
* @return {void}
|
|
27
69
|
*/
|
|
28
70
|
static register(constructor, ...args) {
|
|
29
71
|
return Injectables.getRegistry().register(constructor, ...args);
|
|
30
72
|
}
|
|
31
73
|
/**
|
|
32
|
-
* @
|
|
33
|
-
* @
|
|
34
|
-
* @
|
|
35
|
-
* @
|
|
36
|
-
*
|
|
74
|
+
* @description Creates a new instance of an injectable class.
|
|
75
|
+
* @summary Instantiates an injectable class using its constructor and the provided arguments.
|
|
76
|
+
* @template T Type of the object to build
|
|
77
|
+
* @param {Record<string, any>} obj Object containing the name of the injectable to build
|
|
78
|
+
* @param {any[]} args Constructor arguments to pass when instantiating the injectable
|
|
79
|
+
* @return {T} The newly created instance
|
|
37
80
|
*/
|
|
38
81
|
static build(obj, ...args) {
|
|
39
82
|
return Injectables.getRegistry().build(obj, ...args);
|
|
40
83
|
}
|
|
41
84
|
/**
|
|
42
|
-
* @
|
|
43
|
-
* @
|
|
85
|
+
* @description Replaces the current registry implementation.
|
|
86
|
+
* @summary Sets a new {@link InjectablesRegistry} implementation, allowing for custom registry behavior.
|
|
87
|
+
* @param {InjectablesRegistry} operationsRegistry The new implementation of Registry to use
|
|
88
|
+
* @return {void}
|
|
44
89
|
*/
|
|
45
90
|
static setRegistry(operationsRegistry) {
|
|
46
91
|
Injectables.actingInjectablesRegistry = operationsRegistry;
|
|
47
92
|
}
|
|
48
93
|
/**
|
|
49
|
-
* @
|
|
94
|
+
* @description Provides access to the current registry instance.
|
|
95
|
+
* @summary Returns the current {@link InjectablesRegistry} or creates a default one if none exists.
|
|
96
|
+
* @return {InjectablesRegistry} The current registry instance
|
|
50
97
|
*/
|
|
51
98
|
static getRegistry() {
|
|
52
99
|
if (!Injectables.actingInjectablesRegistry)
|
|
53
100
|
Injectables.actingInjectablesRegistry = new registry_1.InjectableRegistryImp();
|
|
54
101
|
return Injectables.actingInjectablesRegistry;
|
|
55
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* @description Clears all registered injectables.
|
|
105
|
+
* @summary Resets the registry to a clean state by creating a new empty registry instance.
|
|
106
|
+
* @return {void}
|
|
107
|
+
*/
|
|
56
108
|
static reset() {
|
|
57
109
|
Injectables.setRegistry(new registry_1.InjectableRegistryImp());
|
|
58
110
|
}
|
|
111
|
+
/**
|
|
112
|
+
* @description Removes specific injectables from the registry based on a pattern.
|
|
113
|
+
* @summary Selectively resets the registry by removing only the injectables whose names match the provided pattern.
|
|
114
|
+
* @param {string | RegExp} match A string or regular expression pattern to match against injectable names
|
|
115
|
+
* @return {void}
|
|
116
|
+
*/
|
|
59
117
|
static selectiveReset(match) {
|
|
60
118
|
const regexp = typeof match === "string" ? new RegExp(match) : match;
|
|
61
119
|
Injectables.actingInjectablesRegistry["cache"] = Object.entries(Injectables.actingInjectablesRegistry["cache"]).reduce((accum, [key, val]) => {
|
|
@@ -66,4 +124,4 @@ class Injectables {
|
|
|
66
124
|
}
|
|
67
125
|
}
|
|
68
126
|
exports.Injectables = Injectables;
|
|
69
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
127
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"Injectables.js","sourceRoot":"","sources":["../src/Injectables.ts"],"names":[],"mappings":";;;AAAA,6CAIoB;AAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,WAAW;aACP,8BAAyB,GAAyB,SAAS,CAAC;IAE3E,gBAAuB,CAAC;IAExB;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAI,IAAY,EAAE,GAAG,IAAW;QACxC,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAI,WAA0B,EAAE,GAAG,IAAW;QAC3D,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAI,GAAwB,EAAE,GAAG,IAAW;QACtD,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,kBAAuC;QACxD,WAAW,CAAC,yBAAyB,GAAG,kBAAkB,CAAC;IAC7D,CAAC;IACD;;;;OAIG;IACK,MAAM,CAAC,WAAW;QACxB,IAAI,CAAC,WAAW,CAAC,yBAAyB;YACxC,WAAW,CAAC,yBAAyB,GAAG,IAAI,gCAAqB,EAAE,CAAC;QACtE,OAAO,WAAW,CAAC,yBAAyB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK;QACV,WAAW,CAAC,WAAW,CAAC,IAAI,gCAAqB,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,KAAsB;QAC1C,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACpE,WAAW,CAAC,yBAAiC,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,CACrE,WAAW,CAAC,yBAAiC,CAAC,OAAO,CAAC,CACxD,CAAC,MAAM,CAAC,CAAC,KAA0B,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE;YAClD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YACzC,OAAO,KAAK,CAAC;QACf,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;;AArFH,kCAsFC","sourcesContent":["import {\n  Injectable,\n  InjectableRegistryImp,\n  InjectablesRegistry,\n} from \"./registry\";\n\n/**\n * @description Central registry for managing injectable dependencies.\n * @summary Static class holding the access to the injectables functions. Provides methods for registering,\n * retrieving, and building injectable objects.\n * @template T Type of the injectable object\n * \n * @class Injectables\n * \n * @example\n * // Define an injectable class\n * @injectable()\n * class MyService {\n *   doSomething() {\n *     return 'Hello World';\n *   }\n * }\n * \n * // Inject the service into another class\n * class MyComponent {\n *   @inject()\n *   private service!: MyService;\n *   \n *   useService() {\n *     return this.service.doSomething();\n *   }\n * }\n * \n * @mermaid\n * sequenceDiagram\n *   participant Client\n *   participant Injectables\n *   participant Registry\n *   \n *   Client->>Injectables: register(MyService)\n *   Injectables->>Registry: register(MyService)\n *   Registry-->>Injectables: void\n *   \n *   Client->>Injectables: get(\"MyService\")\n *   Injectables->>Registry: get(\"MyService\")\n *   Registry-->>Injectables: MyService instance\n *   Injectables-->>Client: MyService instance\n */\nexport class Injectables {\n  private static actingInjectablesRegistry?: InjectablesRegistry = undefined;\n\n  private constructor() {}\n\n  /**\n   * @description Fetches an injectable instance by its registered name.\n   * @summary Retrieves the named {@link Injectable} from the registry. If the injectable is a singleton,\n   * returns the existing instance. Otherwise, creates a new instance.\n   * @template T Type of the injectable object to retrieve\n   * @param {string} name The registered name of the injectable to retrieve\n   * @param {any[]} args Constructor arguments to pass when instantiating the injectable\n   * @return {Injectable<T> | undefined} The injectable instance or undefined if not found\n   */\n  static get<T>(name: string, ...args: any[]): Injectable<T> | undefined {\n    return Injectables.getRegistry().get(name, ...args);\n  }\n\n  /**\n   * @description Adds a class or object to the injectable registry.\n   * @summary Registers an injectable constructor or instance with the registry, making it available for injection.\n   * @template T Type of the injectable object to register\n   * @param {Injectable<T>} constructor The class constructor or object instance to register\n   * @param {any[]} args Additional arguments for registration (category, singleton flag, etc.)\n   * @return {void}\n   */\n  static register<T>(constructor: Injectable<T>, ...args: any[]): void {\n    return Injectables.getRegistry().register(constructor, ...args);\n  }\n\n  /**\n   * @description Creates a new instance of an injectable class.\n   * @summary Instantiates an injectable class using its constructor and the provided arguments.\n   * @template T Type of the object to build\n   * @param {Record<string, any>} obj Object containing the name of the injectable to build\n   * @param {any[]} args Constructor arguments to pass when instantiating the injectable\n   * @return {T} The newly created instance\n   */\n  static build<T>(obj: Record<string, any>, ...args: any[]): T {\n    return Injectables.getRegistry().build(obj, ...args);\n  }\n\n  /**\n   * @description Replaces the current registry implementation.\n   * @summary Sets a new {@link InjectablesRegistry} implementation, allowing for custom registry behavior.\n   * @param {InjectablesRegistry} operationsRegistry The new implementation of Registry to use\n   * @return {void}\n   */\n  static setRegistry(operationsRegistry: InjectablesRegistry) {\n    Injectables.actingInjectablesRegistry = operationsRegistry;\n  }\n  /**\n   * @description Provides access to the current registry instance.\n   * @summary Returns the current {@link InjectablesRegistry} or creates a default one if none exists.\n   * @return {InjectablesRegistry} The current registry instance\n   */\n  private static getRegistry() {\n    if (!Injectables.actingInjectablesRegistry)\n      Injectables.actingInjectablesRegistry = new InjectableRegistryImp();\n    return Injectables.actingInjectablesRegistry;\n  }\n\n  /**\n   * @description Clears all registered injectables.\n   * @summary Resets the registry to a clean state by creating a new empty registry instance.\n   * @return {void}\n   */\n  static reset() {\n    Injectables.setRegistry(new InjectableRegistryImp());\n  }\n\n  /**\n   * @description Removes specific injectables from the registry based on a pattern.\n   * @summary Selectively resets the registry by removing only the injectables whose names match the provided pattern.\n   * @param {string | RegExp} match A string or regular expression pattern to match against injectable names\n   * @return {void}\n   */\n  static selectiveReset(match: string | RegExp) {\n    const regexp = typeof match === \"string\" ? new RegExp(match) : match;\n    (Injectables.actingInjectablesRegistry as any)[\"cache\"] = Object.entries(\n      (Injectables.actingInjectablesRegistry as any)[\"cache\"]\n    ).reduce((accum: Record<string, any>, [key, val]) => {\n      if (!key.match(regexp)) accum[key] = val;\n      return accum;\n    }, {});\n  }\n}\n"]}
|
package/lib/Injectables.d.ts
CHANGED
|
@@ -1,43 +1,101 @@
|
|
|
1
1
|
import { Injectable, InjectablesRegistry } from "./registry";
|
|
2
2
|
/**
|
|
3
|
-
* @
|
|
3
|
+
* @description Central registry for managing injectable dependencies.
|
|
4
|
+
* @summary Static class holding the access to the injectables functions. Provides methods for registering,
|
|
5
|
+
* retrieving, and building injectable objects.
|
|
6
|
+
* @template T Type of the injectable object
|
|
4
7
|
*
|
|
5
8
|
* @class Injectables
|
|
6
|
-
*
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* // Define an injectable class
|
|
12
|
+
* @injectable()
|
|
13
|
+
* class MyService {
|
|
14
|
+
* doSomething() {
|
|
15
|
+
* return 'Hello World';
|
|
16
|
+
* }
|
|
17
|
+
* }
|
|
18
|
+
*
|
|
19
|
+
* // Inject the service into another class
|
|
20
|
+
* class MyComponent {
|
|
21
|
+
* @inject()
|
|
22
|
+
* private service!: MyService;
|
|
23
|
+
*
|
|
24
|
+
* useService() {
|
|
25
|
+
* return this.service.doSomething();
|
|
26
|
+
* }
|
|
27
|
+
* }
|
|
28
|
+
*
|
|
29
|
+
* @mermaid
|
|
30
|
+
* sequenceDiagram
|
|
31
|
+
* participant Client
|
|
32
|
+
* participant Injectables
|
|
33
|
+
* participant Registry
|
|
34
|
+
*
|
|
35
|
+
* Client->>Injectables: register(MyService)
|
|
36
|
+
* Injectables->>Registry: register(MyService)
|
|
37
|
+
* Registry-->>Injectables: void
|
|
38
|
+
*
|
|
39
|
+
* Client->>Injectables: get("MyService")
|
|
40
|
+
* Injectables->>Registry: get("MyService")
|
|
41
|
+
* Registry-->>Injectables: MyService instance
|
|
42
|
+
* Injectables-->>Client: MyService instance
|
|
7
43
|
*/
|
|
8
44
|
export declare class Injectables {
|
|
9
45
|
private static actingInjectablesRegistry?;
|
|
10
46
|
private constructor();
|
|
11
47
|
/**
|
|
12
|
-
* @
|
|
13
|
-
* @
|
|
14
|
-
*
|
|
48
|
+
* @description Fetches an injectable instance by its registered name.
|
|
49
|
+
* @summary Retrieves the named {@link Injectable} from the registry. If the injectable is a singleton,
|
|
50
|
+
* returns the existing instance. Otherwise, creates a new instance.
|
|
51
|
+
* @template T Type of the injectable object to retrieve
|
|
52
|
+
* @param {string} name The registered name of the injectable to retrieve
|
|
53
|
+
* @param {any[]} args Constructor arguments to pass when instantiating the injectable
|
|
54
|
+
* @return {Injectable<T> | undefined} The injectable instance or undefined if not found
|
|
15
55
|
*/
|
|
16
56
|
static get<T>(name: string, ...args: any[]): Injectable<T> | undefined;
|
|
17
57
|
/**
|
|
18
|
-
* @
|
|
19
|
-
* @
|
|
20
|
-
* @
|
|
21
|
-
*
|
|
58
|
+
* @description Adds a class or object to the injectable registry.
|
|
59
|
+
* @summary Registers an injectable constructor or instance with the registry, making it available for injection.
|
|
60
|
+
* @template T Type of the injectable object to register
|
|
61
|
+
* @param {Injectable<T>} constructor The class constructor or object instance to register
|
|
62
|
+
* @param {any[]} args Additional arguments for registration (category, singleton flag, etc.)
|
|
63
|
+
* @return {void}
|
|
22
64
|
*/
|
|
23
65
|
static register<T>(constructor: Injectable<T>, ...args: any[]): void;
|
|
24
66
|
/**
|
|
25
|
-
* @
|
|
26
|
-
* @
|
|
27
|
-
* @
|
|
28
|
-
* @
|
|
29
|
-
*
|
|
67
|
+
* @description Creates a new instance of an injectable class.
|
|
68
|
+
* @summary Instantiates an injectable class using its constructor and the provided arguments.
|
|
69
|
+
* @template T Type of the object to build
|
|
70
|
+
* @param {Record<string, any>} obj Object containing the name of the injectable to build
|
|
71
|
+
* @param {any[]} args Constructor arguments to pass when instantiating the injectable
|
|
72
|
+
* @return {T} The newly created instance
|
|
30
73
|
*/
|
|
31
74
|
static build<T>(obj: Record<string, any>, ...args: any[]): T;
|
|
32
75
|
/**
|
|
33
|
-
* @
|
|
34
|
-
* @
|
|
76
|
+
* @description Replaces the current registry implementation.
|
|
77
|
+
* @summary Sets a new {@link InjectablesRegistry} implementation, allowing for custom registry behavior.
|
|
78
|
+
* @param {InjectablesRegistry} operationsRegistry The new implementation of Registry to use
|
|
79
|
+
* @return {void}
|
|
35
80
|
*/
|
|
36
81
|
static setRegistry(operationsRegistry: InjectablesRegistry): void;
|
|
37
82
|
/**
|
|
38
|
-
* @
|
|
83
|
+
* @description Provides access to the current registry instance.
|
|
84
|
+
* @summary Returns the current {@link InjectablesRegistry} or creates a default one if none exists.
|
|
85
|
+
* @return {InjectablesRegistry} The current registry instance
|
|
39
86
|
*/
|
|
40
87
|
private static getRegistry;
|
|
88
|
+
/**
|
|
89
|
+
* @description Clears all registered injectables.
|
|
90
|
+
* @summary Resets the registry to a clean state by creating a new empty registry instance.
|
|
91
|
+
* @return {void}
|
|
92
|
+
*/
|
|
41
93
|
static reset(): void;
|
|
94
|
+
/**
|
|
95
|
+
* @description Removes specific injectables from the registry based on a pattern.
|
|
96
|
+
* @summary Selectively resets the registry by removing only the injectables whose names match the provided pattern.
|
|
97
|
+
* @param {string | RegExp} match A string or regular expression pattern to match against injectable names
|
|
98
|
+
* @return {void}
|
|
99
|
+
*/
|
|
42
100
|
static selectiveReset(match: string | RegExp): void;
|
|
43
101
|
}
|
package/lib/constants.cjs
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.InjectablesKeys = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* @
|
|
6
|
-
* @
|
|
5
|
+
* @description Constants used for reflection metadata keys in the dependency injection system.
|
|
6
|
+
* @summary Injectables Reflection keys used to store and retrieve metadata about injectable classes and properties.
|
|
7
7
|
*
|
|
8
|
-
* @property {string} REFLECT Reflection injectables base key
|
|
9
|
-
* @property {string} INJECTABLE Reflection injectable
|
|
10
|
-
* @property {string} INJECT Reflection
|
|
8
|
+
* @property {string} REFLECT Reflection injectables base key prefix for all metadata keys
|
|
9
|
+
* @property {string} INJECTABLE Reflection key suffix for marking a class as injectable
|
|
10
|
+
* @property {string} INJECT Reflection key suffix for marking a property for injection
|
|
11
11
|
*
|
|
12
|
-
* @
|
|
12
|
+
* @const InjectablesKeys
|
|
13
|
+
* @memberOf module:injectable-decorators
|
|
13
14
|
*/
|
|
14
15
|
exports.InjectablesKeys = {
|
|
15
16
|
REFLECT: "inject.db.",
|
|
16
17
|
INJECTABLE: "injectable",
|
|
17
18
|
INJECT: "inject",
|
|
18
19
|
};
|
|
19
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
20
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7Ozs7OztHQVVHO0FBQ1UsUUFBQSxlQUFlLEdBQUc7SUFDN0IsT0FBTyxFQUFFLFlBQVk7SUFDckIsVUFBVSxFQUFFLFlBQVk7SUFDeEIsTUFBTSxFQUFFLFFBQVE7Q0FDakIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGRlc2NyaXB0aW9uIENvbnN0YW50cyB1c2VkIGZvciByZWZsZWN0aW9uIG1ldGFkYXRhIGtleXMgaW4gdGhlIGRlcGVuZGVuY3kgaW5qZWN0aW9uIHN5c3RlbS5cbiAqIEBzdW1tYXJ5IEluamVjdGFibGVzIFJlZmxlY3Rpb24ga2V5cyB1c2VkIHRvIHN0b3JlIGFuZCByZXRyaWV2ZSBtZXRhZGF0YSBhYm91dCBpbmplY3RhYmxlIGNsYXNzZXMgYW5kIHByb3BlcnRpZXMuXG4gKiBcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBSRUZMRUNUIFJlZmxlY3Rpb24gaW5qZWN0YWJsZXMgYmFzZSBrZXkgcHJlZml4IGZvciBhbGwgbWV0YWRhdGEga2V5c1xuICogQHByb3BlcnR5IHtzdHJpbmd9IElOSkVDVEFCTEUgUmVmbGVjdGlvbiBrZXkgc3VmZml4IGZvciBtYXJraW5nIGEgY2xhc3MgYXMgaW5qZWN0YWJsZVxuICogQHByb3BlcnR5IHtzdHJpbmd9IElOSkVDVCBSZWZsZWN0aW9uIGtleSBzdWZmaXggZm9yIG1hcmtpbmcgYSBwcm9wZXJ0eSBmb3IgaW5qZWN0aW9uXG4gKiBcbiAqIEBjb25zdCBJbmplY3RhYmxlc0tleXNcbiAqIEBtZW1iZXJPZiBtb2R1bGU6aW5qZWN0YWJsZS1kZWNvcmF0b3JzXG4gKi9cbmV4cG9ydCBjb25zdCBJbmplY3RhYmxlc0tleXMgPSB7XG4gIFJFRkxFQ1Q6IFwiaW5qZWN0LmRiLlwiLFxuICBJTkpFQ1RBQkxFOiBcImluamVjdGFibGVcIixcbiAgSU5KRUNUOiBcImluamVjdFwiLFxufTtcbiJdfQ==
|
package/lib/constants.d.ts
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @
|
|
3
|
-
* @
|
|
2
|
+
* @description Constants used for reflection metadata keys in the dependency injection system.
|
|
3
|
+
* @summary Injectables Reflection keys used to store and retrieve metadata about injectable classes and properties.
|
|
4
4
|
*
|
|
5
|
-
* @property {string} REFLECT Reflection injectables base key
|
|
6
|
-
* @property {string} INJECTABLE Reflection injectable
|
|
7
|
-
* @property {string} INJECT Reflection
|
|
5
|
+
* @property {string} REFLECT Reflection injectables base key prefix for all metadata keys
|
|
6
|
+
* @property {string} INJECTABLE Reflection key suffix for marking a class as injectable
|
|
7
|
+
* @property {string} INJECT Reflection key suffix for marking a property for injection
|
|
8
8
|
*
|
|
9
|
-
* @
|
|
9
|
+
* @const InjectablesKeys
|
|
10
|
+
* @memberOf module:injectable-decorators
|
|
10
11
|
*/
|
|
11
12
|
export declare const InjectablesKeys: {
|
|
12
13
|
REFLECT: string;
|