Class DefaultEnvironmentQuery

Gets the properties from the EnvironmentState.

Hierarchy

DefaultEnvironmentQuery
- DefaultEnvironmentQuery

Implements

EnvironmentQuery

Index

Constructors

constructor

Methods

containsAll containsAll$ containsAllAsync containsSome containsSome$ containsSomeAsync get get$ getAll getAll$ getAllAsync getAsync

Constructors

constructor

new DefaultEnvironmentQuery(store, queryConfig?): DefaultEnvironmentQuery
Gets the properties from the EnvironmentState.
Parameters
- store: EnvironmentStore
  
  The EnvironmentStore.
- Optional queryConfig: null | EnvironmentQueryConfig
  
  Configuration parameters for EnvironmentQuery.
Returns DefaultEnvironmentQuery
- Defined in packages/environment/src/lib/query/environment-query.application.ts:29

Methods

containsAll

containsAll(...paths): boolean
Checks if all the EnvironmentState property paths are available for resolution.

Returns
true if all the EnvironmentState property paths exists, otherwise false.
Parameters
- Rest ...paths: AtLeastOne<Path>
  
  The list of EnvironmentState property paths to resolve.
Returns boolean
Implementation of EnvironmentQuery.containsAll
- Defined in packages/environment/src/lib/query/environment-query.application.ts:66

containsAll$

containsAll$(...paths): Observable<boolean>
Checks if all the EnvironmentState property paths are available for resolution.

Returns
distinct true as Observable if all the EnvironmentState property paths exists, otherwise false.
Parameters
- Rest ...paths: AtLeastOne<Path>
  
  The list of EnvironmentState property paths to resolve.
Returns Observable<boolean>
Implementation of EnvironmentQuery.containsAll$
- Defined in packages/environment/src/lib/query/environment-query.application.ts:51

containsAllAsync

containsAllAsync(...paths): Promise<boolean>
Checks if all the EnvironmentState property paths are available for resolution.

Returns
The first true as Promise when all EnvironmentState property paths exists.
Parameters
- Rest ...paths: AtLeastOne<Path>
  
  The list of EnvironmentState property paths to resolve.
Returns Promise<boolean>
Implementation of EnvironmentQuery.containsAllAsync
- Defined in packages/environment/src/lib/query/environment-query.application.ts:60

containsSome

containsSome(...paths): boolean
Checks if some EnvironmentState property paths are available for resolution.

Returns
true if some EnvironmentState property paths exists, otherwise false.
Parameters
- Rest ...paths: AtLeastOne<Path>
  
  The list of EnvironmentState property paths to resolve.
Returns boolean
Implementation of EnvironmentQuery.containsSome
- Defined in packages/environment/src/lib/query/environment-query.application.ts:87

containsSome$

containsSome$(...paths): Observable<boolean>
Checks if some EnvironmentState property paths are available for resolution.

Returns
distinct true as Observable if some EnvironmentState property paths exists, otherwise false.
Parameters
- Rest ...paths: AtLeastOne<Path>
  
  The list of EnvironmentState property paths to resolve.
Returns Observable<boolean>
Implementation of EnvironmentQuery.containsSome$
- Defined in packages/environment/src/lib/query/environment-query.application.ts:72

containsSomeAsync

containsSomeAsync(...paths): Promise<boolean>
Checks if some EnvironmentState property paths are available for resolution.

Returns
The first true as Promise when some EnvironmentState property paths exists.
Parameters
- Rest ...paths: AtLeastOne<Path>
  
  The list of EnvironmentState property paths to resolve.
Returns Promise<boolean>
Implementation of EnvironmentQuery.containsSomeAsync
- Defined in packages/environment/src/lib/query/environment-query.application.ts:81

get

get<T, K>(path, options?): undefined | T | K
Gets the EnvironmentState property value.

Returns
The converted EnvironmentState property at path.
Type Parameters
- T extends null | string | number | boolean | Property[] | {
  [x: string]: Property;
  }
  
  The EnvironmentState property type.
- K = T
  
  The expected property target type.
Parameters
- path: Path
  
  The EnvironmentState path to resolve.
- Optional options: GetOptions<T, K>
  
  The options to get a property.
Returns undefined | T | K
Implementation of EnvironmentQuery.get
- Defined in packages/environment/src/lib/query/environment-query.application.ts:151

get$

get$<T, K>(path, options?): Observable<undefined | T | K>
Gets the EnvironmentState property value.

Returns
The converted distinct EnvironmentState property at path as Observable.
Type Parameters
- T extends null | string | number | boolean | Property[] | {
  [x: string]: Property;
  }
  
  The EnvironmentState property type.
- K = T
  
  The expected property target type.
Parameters
- path: Path
  
  The EnvironmentState path to resolve.
- Optional options: GetOptionsReactive<T, K>
  
  The options to get a property.
Returns Observable<undefined | T | K>
Implementation of EnvironmentQuery.get$
- Defined in packages/environment/src/lib/query/environment-query.application.ts:122

getAll

getAll(): EnvironmentState
Gets all the EnvironmentState properties.

Returns
All the EnvironmentState properties.

Returns EnvironmentState
Implementation of EnvironmentQuery.getAll
- Defined in packages/environment/src/lib/query/environment-query.application.ts:47

getAll$

getAll$(): Observable<EnvironmentState>
Gets all the EnvironmentState properties.

Returns
All the distinct EnvironmentState properties as Observable.

Returns Observable<EnvironmentState>
Implementation of EnvironmentQuery.getAll$
- Defined in packages/environment/src/lib/query/environment-query.application.ts:34

getAllAsync

getAllAsync(): Promise<EnvironmentState>
Gets all the EnvironmentState properties.

Returns
The first non nil or empty set of EnvironmentState properties as Promise.

Returns Promise<EnvironmentState>
Implementation of EnvironmentQuery.getAllAsync
- Defined in packages/environment/src/lib/query/environment-query.application.ts:38

getAsync

getAsync<T, K>(path, options?): Promise<undefined | T | K>
Gets the EnvironmentState property value.

Returns
The first converted non nil EnvironmentState property at path or undefined as Promise.
Type Parameters
- T extends null | string | number | boolean | Property[] | {
  [x: string]: Property;
  }
  
  The EnvironmentState property type.
- K = T
  
  The expected property target type.
Parameters
- path: Path
  
  The EnvironmentState path to resolve.
- Optional options: GetOptionsAsync<T, K> & {
  dueTime?: number;
  }
  
  The options to get a property.
Returns Promise<undefined | T | K>
Implementation of EnvironmentQuery.getAsync
- Defined in packages/environment/src/lib/query/environment-query.application.ts:135

Class DefaultEnvironmentQuery

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

store: EnvironmentStore

Optional queryConfig: null | EnvironmentQueryConfig

Returns DefaultEnvironmentQuery

Methods

containsAll

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns boolean

containsAll$

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Observable<boolean>

containsAllAsync

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Promise<boolean>

containsSome

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns boolean

containsSome$

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Observable<boolean>

containsSomeAsync

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Promise<boolean>

get

Returns

Type Parameters

T extends null | string | number | boolean | Property[] | { [x: string]: Property; }

K = T

Parameters

path: Path

Optional options: GetOptions<T, K>

Returns undefined | T | K

get$

Returns

Type Parameters

T extends null | string | number | boolean | Property[] | { [x: string]: Property; }

K = T

Parameters

path: Path

Optional options: GetOptionsReactive<T, K>

Returns Observable<undefined | T | K>

getAll

Returns

Returns EnvironmentState

getAll$

Returns

Returns Observable<EnvironmentState>

getAllAsync

Returns

Returns Promise<EnvironmentState>

getAsync

Returns

Type Parameters

T extends null | string | number | boolean | Property[] | { [x: string]: Property; }

K = T

Parameters

path: Path

Optional options: GetOptionsAsync<T, K> & { dueTime?: number; }

Returns Promise<undefined | T | K>

Settings

`Optional` queryConfig: null | EnvironmentQueryConfig

`Rest` ...paths: AtLeastOne<Path>

`Rest` ...paths: AtLeastOne<Path>

`Rest` ...paths: AtLeastOne<Path>

`Rest` ...paths: AtLeastOne<Path>

`Rest` ...paths: AtLeastOne<Path>

`Rest` ...paths: AtLeastOne<Path>

T extends null | string | number | boolean | Property[] | {
[x: string]: Property;
}

`Optional` options: GetOptions<T, K>

T extends null | string | number | boolean | Property[] | {
[x: string]: Property;
}

`Optional` options: GetOptionsReactive<T, K>

T extends null | string | number | boolean | Property[] | {
[x: string]: Property;
}

`Optional` options: GetOptionsAsync<T, K> & {
dueTime?: number;
}