Class DefaultEnvironmentLoader

Loads the environment properties from the provided asynchronous sources.

Hierarchy

DefaultEnvironmentLoader

Implements

EnvironmentLoader

Index

Constructors

constructor

Methods

completeAllSources completeSource getSourceById load onDestroy preAddProperties rejectLoad resolveLoad

Constructors

constructor

new DefaultEnvironmentLoader(service, sources?): DefaultEnvironmentLoader
Loads the environment properties from the provided asynchronous sources.

Throws
InvalidSourceError if an environmnet source is invalid.

Throws
DuplicatedSourcesError If there are sources with duplicated ids.
Parameters
- service: EnvironmentService
- Optional sources: null | ArrayOrSingle<EnvironmentSource>
Returns DefaultEnvironmentLoader
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:48

Methods

completeAllSources

completeAllSources(): void
Forces the load to resolve and stops all ongoing source loads.

Returns void
Implementation of EnvironmentLoader.completeAllSources
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:208

completeSource

completeSource(source): void
Completes a source load.
Parameters
- source: LoaderSource
  
  The source to complete.
Returns void
Implementation of EnvironmentLoader.completeSource
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:212

getSourceById

getSourceById(id): undefined | LoaderSource
Returns the loader source definition with the given id.

Returns
The loader source definition or undefined if the source doesn't exist.
Parameters
- id: string
  
  The id of the loader source to get.
Returns undefined | LoaderSource
Implementation of EnvironmentLoader.getSourceById
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:194

load

load(): Promise<void>
Loads the properties from the provided asynchronous sources.

Returns
A promise once the required sources are loaded.

Returns Promise<void>
Implementation of EnvironmentLoader.load
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:53

onDestroy

onDestroy(): void
Forces the load to resolve, stops all ongoing source loads and completes the subjects.

Returns void
Implementation of EnvironmentLoader.onDestroy
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:221

preAddProperties

preAddProperties(properties, source?): EnvironmentState
Middleware function that gives the possibility to modify the source properties before inserting it into the environment.

Returns
The modified source properties.
Parameters
- properties: EnvironmentState
  
  The source properties.
- Optional source: LoaderSource
  
  The environment properties source.
Returns EnvironmentState
Implementation of EnvironmentLoader.preAddProperties
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:152

rejectLoad

rejectLoad<E>(error): void
Forces the load to reject.
Type Parameters
- E
  
  The type of the error.
Parameters
- error: E
  
  The error to throw.
Returns void
Implementation of EnvironmentLoader.rejectLoad
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:202

resolveLoad

resolveLoad(): void
Forces the load to resolve.

Returns void
Implementation of EnvironmentLoader.resolveLoad
- Defined in packages/environment/src/lib/loader/environment-loader.application.ts:198

Class DefaultEnvironmentLoader

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Throws

Throws

Parameters

service: EnvironmentService

Optional sources: null | ArrayOrSingle<EnvironmentSource>

Returns DefaultEnvironmentLoader

Methods

completeAllSources

Returns void

completeSource

Parameters

source: LoaderSource

Returns void

getSourceById

Returns

Parameters

id: string

Returns undefined | LoaderSource

load

Returns

Returns Promise<void>

onDestroy

Returns void

preAddProperties

Returns

Parameters

properties: EnvironmentState

Optional source: LoaderSource

Returns EnvironmentState

rejectLoad

Type Parameters

E

Parameters

error: E

Returns void

resolveLoad

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` sources: null | ArrayOrSingle<EnvironmentSource>

`Optional` source: LoaderSource