Class ManagerFactory

Factory for creating manager instances from registered classes

Example

const factory = new ManagerFactory();
factory.setManagerType(MongoManager);
const manager = factory.getManager({ type: 'MongoManager', config: {...} });

Index

Constructors

constructor

Methods

getManager removeManagerType setManagerType

Constructors

constructor

new ManagerFactory(): ManagerFactory
Returns ManagerFactory
- Defined in src/manager-factory.ts:32

Methods

getManager

getManager<TConfig = unknown>(arg: ManagerFactoryArg<TConfig>): IManager
Create a manager instance from factory settings
Type Parameters
- TConfig = unknown
  Type of the configuration object
Parameters
- arg: ManagerFactoryArg<TConfig>
  Settings including type and config
Returns IManager
A new manager instance

Throws
If arguments are invalid

Throws
If manager type is not registered
- Defined in src/manager-factory.ts:44

removeManagerType

removeManagerType<TConfig = unknown>(
managerClass: string | ManagerConstructor<TConfig>,
): boolean
Remove a registered manager type from the factory
Type Parameters
- TConfig = unknown
  Type of the configuration object
Parameters
- managerClass: string | ManagerConstructor<TConfig>
  The manager class or type string to remove
Returns boolean
true if the type was removed, false if it wasn't registered
- Defined in src/manager-factory.ts:96

setManagerType

setManagerType<TConfig = unknown>(
managerClass: ManagerConstructor<TConfig>,
): this
Register a manager class with the factory
Type Parameters
- TConfig = unknown
  Type of the configuration object
Parameters
- managerClass: ManagerConstructor<TConfig>
  The manager class to register
Returns this
This factory instance for chaining
Example
```
factory.setManagerType(MongoManager).setManagerType(PGManager);
```
- Defined in src/manager-factory.ts:85

Class ManagerFactory

Example

Index

Constructors

Methods

Constructors

constructor

Returns ManagerFactory

Methods

getManager

Type Parameters

Parameters

Returns IManager

Throws

Throws

removeManagerType

Type Parameters

Parameters

Returns boolean

setManagerType

Type Parameters

Parameters

Returns this

Example

Settings

On This Page