Class EnvironmentLoader`Abstract`

Loads the environment properties from the provided asynchronous sources.

Hierarchy

EnvironmentLoader

Implemented by

DefaultEnvironmentLoader

Index

Constructors

constructor

Methods

completeAllSources completeSource getSourceById load onDestroy preAddProperties rejectLoad resolveLoad

Constructors

constructor

new EnvironmentLoader(): EnvironmentLoader
Returns EnvironmentLoader

Methods

`Abstract` completeAllSources

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

Returns void
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:44

`Abstract` completeSource

completeSource(source): void
Completes a source load.
Parameters
- source: LoaderSource
  
  The source to complete.
Returns void
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:50

`Abstract` 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
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:27

`Abstract` load

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

Returns
A promise once the required sources are loaded.

Returns Promise<void>
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:12

`Abstract` onDestroy

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

Returns void
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:55

`Abstract` 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
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:20

`Abstract` 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
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:39

`Abstract` resolveLoad

resolveLoad(): void
Forces the load to resolve.

Returns void
- Defined in packages/environment/src/lib/loader/environment-loader.interface.ts:32

Class EnvironmentLoaderAbstract

Hierarchy

Implemented by

Index

Constructors

Methods

Constructors

constructor

Returns EnvironmentLoader

Methods

Abstract completeAllSources

Returns void

Abstract completeSource

Parameters

source: LoaderSource

Returns void

Abstract getSourceById

Returns

Parameters

id: string

Returns undefined | LoaderSource

Abstract load

Returns

Returns Promise<void>

Abstract onDestroy

Returns void

Abstract preAddProperties

Returns

Parameters

properties: EnvironmentState

Optional source: LoaderSource

Returns EnvironmentState

Abstract rejectLoad

Type Parameters

E

Parameters

error: E

Returns void

Abstract resolveLoad

Returns void

Settings

Member Visibility

Theme

On This Page

Class EnvironmentLoader`Abstract`

`Abstract` completeAllSources

`Abstract` completeSource

`Abstract` getSourceById

`Abstract` load

`Abstract` onDestroy

`Abstract` preAddProperties

`Optional` source: LoaderSource

`Abstract` rejectLoad

`Abstract` resolveLoad