Class Container

Container class to manage the dependency injection container

Index

Methods

clearInstances dispose init reset getInstance

Methods

clearInstances

clearInstances(
    homeDirectory?: string,
    cacheDirectory?: string,
    logLevel?: string,
    developmentMode?: boolean,
    overrides?: InstanceOverrides,
): void
clears the container instances, useful for testing when you are using container.registerInstance()
Parameters
- OptionalhomeDirectory: string
  the home directory to use, defaults to constants.SOLO_HOME_DIR
- OptionalcacheDirectory: string
  the cache directory to use, defaults to constants.SOLO_CACHE_DIR
- OptionallogLevel: string
  the log level to use, defaults to 'debug'
- OptionaldevelopmentMode: boolean
  if true, show full stack traces in error messages
- Optionaloverrides: InstanceOverrides
  instances to use instead of the default implementations
Returns void
- Defined in src/core/dependency-injection/container-init.ts:337

dispose

dispose(): Promise<void>
only call dispose when you are about to system exit

Returns Promise<void>
- Defined in src/core/dependency-injection/container-init.ts:355

init

init(
    homeDirectory?: string,
    cacheDirectory?: string,
    logLevel?: string,
    developmentMode?: boolean,
    overrides?: InstanceOverrides,
): void
Initialize the container with the default dependencies
Parameters
- homeDirectory: string = constants.SOLO_HOME_DIR
  the home directory to use, defaults to constants.SOLO_HOME_DIR
- cacheDirectory: string = constants.SOLO_CACHE_DIR
  the cache directory to use, defaults to constants.SOLO_CACHE_DIR
- logLevel: string = 'debug'
  the log level to use, defaults to 'debug'
- developmentMode: boolean = false
  if true, show full stack traces in error messages
- overrides: InstanceOverrides = ...
  instances to use instead of the default implementations
Returns void
- Defined in src/core/dependency-injection/container-init.ts:257

reset

reset(
    homeDirectory?: string,
    cacheDirectory?: string,
    logLevel?: string,
    developmentMode?: boolean,
    overrides?: InstanceOverrides,
): void
clears the container registries and re-initializes the container
Parameters
- OptionalhomeDirectory: string
  the home directory to use, defaults to constants.SOLO_HOME_DIR
- OptionalcacheDirectory: string
  the cache directory to use, defaults to constants.SOLO_CACHE_DIR
- OptionallogLevel: string
  the log level to use, defaults to 'debug'
- OptionaldevelopmentMode: boolean
  if true, show full stack traces in error messages
- Optionaloverrides: InstanceOverrides
  instances to use instead of the default implementations
Returns void
- Defined in src/core/dependency-injection/container-init.ts:314

`Static`getInstance

getInstance(): Container
Get the singleton instance of the container

Returns Container
- Defined in src/core/dependency-injection/container-init.ts:105

Class Container

Index

Methods

Methods

clearInstances

Parameters

Returns void

dispose

Returns Promise<void>

init

Parameters

Returns void

reset

Parameters

Returns void

`Static`getInstance

Returns Container

Settings

On This Page

Class Container

Index

Methods

Methods

clearInstances

Parameters

Returns void

dispose

Returns Promise<void>

init

Parameters

Returns void

reset

Parameters

Returns void

StaticgetInstance

Returns Container

Settings

On This Page

`Static`getInstance