@armscye/container 0.3.0 → 0.5.0

package/README.md

@@ -1,6 +1,6 @@
 # @armscye/container
 
-> A collection of shared standard TypeScript definitions.
+> A collection of shared standard TypeScript definitions (@container).
 
 ## Installation
 
@@ -15,3 +15,166 @@ or using yarn:
 ```sh
 yarn add @armscye/container --dev
 ```
+
+## Reference
+
+### ClassProvider `Interface`
+
+Configures the `Container` to return an instance of `useClass` for a token.
+
+```ts
+interface ClassProvider {
+  provide: ProviderToken;
+
+  useClass: NoArgument<any>;
+
+  shared?: boolean;
+}
+```
+
+**Properties**
+
+| Property                    | Description                                |
+| --------------------------- | ------------------------------------------ |
+| provide: `ProviderToken`    | A provider token.                          |
+| useClass: `NoArgument<any>` | A class to instantiate for the `token`.    |
+| shared?: boolean            | When true, the created instance is cached. |
+
+### Container `Interface`
+
+Describes the interface of a container that exposes methods to read its entries.
+
+```ts
+interface Container {
+  get<T>(token: ProviderToken): T;
+
+  has(token: ProviderToken): boolean;
+}
+```
+
+**Methods**
+
+#### `get<T>(token: ProviderToken): T`
+
+Retrieves an entry from the container based on its provider token.
+
+_Parameters_
+
+- `token`: The unique identifier of the entry to retrieve.
+
+_Returns_
+
+The entry associated with the provided token, if found.
+
+_Throws_
+
+`Error` if the entry doesn't exist or an error occurs during retrieval.
+
+#### `has(token: ProviderToken): boolean`
+
+Checks whether an entry for a specific provider token exists in the container.
+
+_Parameters_
+
+- `token`: The unique identifier of the entry to check for.
+
+_Returns_
+
+`true` if an entry for the provided token exists, `false` otherwise.
+
+### ExistingProvider `Interface`
+
+Configures the `Container` to return a value of another `useExisting` token.
+
+```ts
+interface ExistingProvider {
+  provide: ProviderToken;
+
+  useExisting: ProviderToken;
+
+  shared?: boolean;
+}
+```
+
+**Properties**
+
+| Property                     | Description                                |
+| ---------------------------- | ------------------------------------------ |
+| provide: `ProviderToken`     | A provider token.                          |
+| useExisting: `ProviderToken` | Existing `token` to return.                |
+| shared?: boolean             | When true, the created instance is cached. |
+
+### FactoryProvider `Interface`
+
+Configures the `Container` to return a value by invoking a `useFactory` function.
+
+```ts
+interface FactoryProvider {
+  provide: ProviderToken;
+
+  useFactory: Factory<any>;
+
+  shared?: boolean;
+}
+```
+
+**Properties**
+
+| Property                   | Description                                                       |
+| -------------------------- | ----------------------------------------------------------------- |
+| provide: `ProviderToken`   | A provider token.                                                 |
+| useFactory: `Factory<any>` | A factory function to invoke to create an object for the `token`. |
+| shared?: boolean           | When true, the created instance is cached.                        |
+
+### Factory `Type`
+
+A function to invoke to create an object. The function is invoked with an instance of the container in order to access required dependencies.
+
+```ts
+type Factory<T = any> = (container: Container) => T;
+```
+
+### ProviderToken `Type`
+
+Token that can be used to retrieve an instance from a container.
+
+```ts
+type ProviderToken = string | symbol;
+```
+
+### Provider `Type`
+
+Describes how the `Container` should be configured.
+
+```ts
+type Provider =
+  | ValueProvider
+  | ClassProvider
+  | FactoryProvider
+  | ExistingProvider;
+```
+
+### ValueProvider `Interface`
+
+Configures the `Container` to return a value for a token.
+
+```ts
+interface ValueProvider {
+  provide: ProviderToken;
+
+  useValue: any;
+}
+```
+
+**Properties**
+
+| Property                 | Description                                                 |
+| ------------------------ | ----------------------------------------------------------- |
+| provide: `ProviderToken` | A provider token.                                           |
+| useValue: any            | The actual value that will be provided for the given token. |
+
+## License
+
+This project is licensed under the **MIT license**.
+
+See [LICENSE](LICENSE) for more information.

package/dist/class-provider.d.ts

@@ -3,7 +3,7 @@ import { ProviderToken } from './provider-token';
 /**
  * Configures the `Container` to return a value by instantiating `useClass` class.
  */
-export interface ClassProvider<T = any> {
+export interface ClassProvider {
     /**
      * Provider token.
      */
@@ -11,7 +11,7 @@ export interface ClassProvider<T = any> {
     /**
      * Class to instantiate for the `token`.
      */
-    useClass: NoArgument<T>;
+    useClass: NoArgument<any>;
     /**
      * Whether the created instance should be cached.
      */

package/dist/existing-provider.d.ts

@@ -2,7 +2,7 @@ import { ProviderToken } from './provider-token';
 /**
  * Configures the `Container` to return a value of another `useExisting` token.
  */
-export interface ExistingProvider<T = any> {
+export interface ExistingProvider {
     /**
      * Provider token.
      */
@@ -10,7 +10,7 @@ export interface ExistingProvider<T = any> {
     /**
      * Existing `token` to return.
      */
-    useExisting: T;
+    useExisting: ProviderToken;
     /**
      * Whether the created instance should be cached.
      */

package/dist/factory-provider.d.ts

@@ -3,7 +3,7 @@ import { ProviderToken } from './provider-token';
 /**
  * Configures the `Container` to return a value by invoking a `useFactory` function.
  */
-export interface FactoryProvider<T = any> {
+export interface FactoryProvider {
     /**
      * Provider token.
      */
@@ -12,7 +12,7 @@ export interface FactoryProvider<T = any> {
      * A function to invoke to create an instance for this `token`. The function is
      * invoked with resolved values of token`s from an instance of the container.
      */
-    useFactory: Factory<T>;
+    useFactory: Factory<any>;
     /**
      * Whether the created instance should be cached.
      */

package/dist/provider.d.ts

@@ -2,4 +2,4 @@ import { ClassProvider } from './class-provider';
 import { ExistingProvider } from './existing-provider';
 import { FactoryProvider } from './factory-provider';
 import { ValueProvider } from './value-provider';
-export type Provider<T = any> = ValueProvider<T> | ClassProvider<T> | FactoryProvider<T> | ExistingProvider<T>;
+export type Provider = ValueProvider | ClassProvider | FactoryProvider | ExistingProvider;

package/dist/value-provider.d.ts

@@ -2,7 +2,7 @@ import { ProviderToken } from './provider-token';
 /**
  * Configures the `Container` to return a value for a token.
  */
-export interface ValueProvider<T = any> {
+export interface ValueProvider {
     /**
      * Provider token.
      */
@@ -10,5 +10,5 @@ export interface ValueProvider<T = any> {
     /**
      * The value to inject.
      */
-    useValue: T;
+    useValue: any;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@armscye/container",
-  "version": "0.3.0",
-  "description": "A collection of shared standard TypeScript definitions",
+  "version": "0.5.0",
+  "description": "A collection of shared standard TypeScript definitions (@container)",
   "author": "Augustus Kamau",
   "license": "MIT",
   "types": "./dist/index.d.ts",
@@ -11,10 +11,11 @@
   "keywords": [
     "armscye",
     "typescript",
-    "types"
+    "types",
+    "container"
   ],
   "dependencies": {
-    "@armscye/core": "^0.2.0"
+    "@armscye/core": "^0.4.0"
   },
   "homepage": "https://github.com/armscye/armscye#readme",
   "repository": {
@@ -27,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f2c94ab8ecb4161f6f8c82820a8bbad758d83209"
+  "gitHead": "0709eb7276b853296ef820d0e5bd8c170e6d2ee3"
 }