Class EnvironmentQuery`Abstract`

Gets the properties from the EnvironmentState.

Hierarchy

EnvironmentQuery

Implemented by

DefaultEnvironmentQuery

Index

Constructors

constructor

Methods

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

Constructors

constructor

new EnvironmentQuery(): EnvironmentQuery
Returns EnvironmentQuery

Methods

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

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

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

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

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

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

`Abstract` get

get<T, K>(path, options): 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.
- options: GetOptions<T, K> & {
  targetType: ((property?) => K);
  }
  
  The options to get a property.
Returns K
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:178
get<T, K>(path, options): T
Gets the EnvironmentState property value.

Returns
The 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.
- options: Object
  
  The options to get a property.
Returns T
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:191
get<T, K>(path, options?): undefined | T
Gets the EnvironmentState property value.

Returns
The EnvironmentState property at path or undefined.
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
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:204
get<T, K>(path, options?): undefined | T | K
Type Parameters
- T extends null | string | number | boolean | Property[] | {
  [x: string]: Property;
  }
- K = T
Parameters
- path: Path
- Optional options: GetOptions<T, K> & {
  required?: boolean;
  }
Returns undefined | T | K
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:206

`Abstract` get$

get$<T, K>(path, options): Observable<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.
- options: GetOptionsReactive<T, K> & {
  targetType: ((property?) => K);
  }
  
  The options to get a property.
Returns Observable<K>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:80
get$<T, K>(path, options): Observable<T>
Gets the EnvironmentState property value.

Returns
The 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.
- options: GetOptionsReactive<T, K> & {
  defaultValue: T;
  }
  
  The options to get a property.
Returns Observable<T>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:93
get$<T, K>(path, options?): Observable<undefined | T>
Gets the EnvironmentState property value.

Returns
The distinct EnvironmentState property at path or undefined 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>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:106
get$<T, K>(path, options?): Observable<undefined | T | K>
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>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:111

`Abstract` getAll

getAll(): EnvironmentState
Gets all the EnvironmentState properties.

Returns
All the EnvironmentState properties.

Returns EnvironmentState
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:28

`Abstract` getAll$

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

Returns
All the distinct EnvironmentState properties as Observable.

Returns Observable<EnvironmentState>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:16

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

`Abstract` getAsync

getAsync<T, K>(path, options): Promise<undefined | 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.
- options: GetOptionsAsync<T, K> & {
  targetType: ((property?) => K);
  } & {
  dueTime: number;
  }
  
  The options to get a property.
Returns Promise<undefined | K>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:124
getAsync<T, K>(path, options): Promise<K>
Gets the EnvironmentState property value.

Returns
The first converted non nil EnvironmentState property at path 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.
- options: GetOptionsAsync<T, K> & {
  targetType: ((property?) => K);
  }
  
  The options to get a property.
Returns Promise<K>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:137
getAsync<T, K>(path, options): Promise<undefined | T>
Gets the EnvironmentState property value.

Returns
The first 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.
- options: GetOptionsAsync<T, K> & {
  dueTime: number;
  }
  
  The options to get a property.
Returns Promise<undefined | T>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:150
getAsync<T, K>(path, options?): Promise<T>
Gets the EnvironmentState property value.

Returns
The first non nil EnvironmentState property at path 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>
  
  The options to get a property.
Returns Promise<T>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:163
getAsync<T, K>(path, options?): Promise<undefined | T | K>
Type Parameters
- T extends null | string | number | boolean | Property[] | {
  [x: string]: Property;
  }
- K = T
Parameters
- path: Path
- Optional options: GetOptionsAsync<T, K>
Returns Promise<undefined | T | K>
- Defined in packages/environment/src/lib/query/environment-query.interface.ts:165

Class EnvironmentQueryAbstract

Hierarchy

Implemented by

Index

Constructors

Methods

Constructors

constructor

Returns EnvironmentQuery

Methods

Abstract containsAll

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns boolean

Abstract containsAll$

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Observable<boolean>

Abstract containsAllAsync

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Promise<boolean>

Abstract containsSome

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns boolean

Abstract containsSome$

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Observable<boolean>

Abstract containsSomeAsync

Returns

Parameters

Rest ...paths: AtLeastOne<Path>

Returns Promise<boolean>

Abstract get

Returns

Type Parameters

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

K = T

Parameters

path: Path

options: GetOptions<T, K> & { targetType: ((property?) => K); }

Returns K

Returns

Type Parameters

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

K = T

Parameters

path: Path

options: Object

Returns T

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

Type Parameters

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

K = T

Parameters

path: Path

Optional options: GetOptions<T, K> & { required?: boolean; }

Returns undefined | T | K

Abstract get$

Returns

Type Parameters

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

K = T

Parameters

path: Path

options: GetOptionsReactive<T, K> & { targetType: ((property?) => K); }

Class EnvironmentQuery`Abstract`

`Abstract` containsAll

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

`Abstract` containsAll$

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

`Abstract` containsAllAsync

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

`Abstract` containsSome

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

`Abstract` containsSome$

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

`Abstract` containsSomeAsync

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

`Abstract` get

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

options: GetOptions<T, K> & {
targetType: ((property?) => K);
}

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

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: GetOptions<T, K> & {
required?: boolean;
}

`Abstract` get$

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

options: GetOptionsReactive<T, K> & {
targetType: ((property?) => K);
}

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

options: GetOptionsReactive<T, K> & {
defaultValue: T;
}

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: GetOptionsReactive<T, K>

`Abstract` getAll

`Abstract` getAll$

`Abstract` getAllAsync

`Abstract` getAsync

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

options: GetOptionsAsync<T, K> & {
targetType: ((property?) => K);
} & {
dueTime: number;
}

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

options: GetOptionsAsync<T, K> & {
targetType: ((property?) => K);
}

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

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

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

`Optional` options: GetOptionsAsync<T, K>

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