Class: AspectFacade

@flyze/lib-data-store 3.0.0-alpha.55· latest

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:27

Represents the AspectFacade service. Provides methods to interact with aspects through the Flyze API.

Extends

AbstractStatefulFacade<"aspect", AspectQueryBuilder, Aspect>

Constructors

Constructor

new AspectFacade(instance, facadeStore): AspectFacade

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:32

Parameters

instance

ApiStoreInstance

facadeStore

FacadeStore

Returns

AspectFacade

Overrides

AbstractStatefulFacade.constructor

Properties

_selectors

protected _selectors: object

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:77

Gets the base selectors from the superclass. No tag filtering is applied.

canExecuteQuery()

canExecuteQuery: (q) => CanExecuteResult<string, "aspectTypes" | "assets" | "assetTypes">

Parameters

q

ExecutableQuery

Returns

CanExecuteResult<string, "aspectTypes" | "assets" | "assetTypes">

select()

select: (q) => DistinctSelector<RootStore, [number | Aspect[], number | Aspect[], number | Aspect[], number | Aspect[], number | Aspect[], Aspect[]], Aspect[]>

Parameters

q

AspectSelectQuery

Returns

selectAll()

selectAll: () => MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]> | MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

Returns

MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]> | MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

selectByExecutableQuery()

selectByExecutableQuery: (q) => MemoizedSelector<RootStore, Aspect[], any>

Parameters

q

ExecutableQuery

Returns

MemoizedSelector<RootStore, Aspect[], any>

selectByFilter()

selectByFilter: (filterFn) => MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

Parameters

filterFn

(entity) => boolean

Returns

MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

selectById()

selectById: (id) => MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

Parameters

id

string

Returns

MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

selectByIds()

selectByIds: (ids) => MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

Parameters

ids

string[]

Returns

MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

selectByPath()

selectByPath: (path) => DistinctSelector<RootStore, [Aspect[]], Aspect[]>

Parameters

path

string | string[]

Returns

DistinctSelector<RootStore, [Aspect[]], Aspect[]>

selectByPathAndName()

selectByPathAndName: (path, name) => MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

Parameters

path

string | string[]

name

string | string[]

Returns

MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

selectByTypeId()

selectByTypeId: (typeId) => MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

Parameters

typeId

string | string[]

Returns

MemoizedSelector<RootStore, Aspect[], (s1) => Aspect[]>

selectCountByExecutableQuery()

selectCountByExecutableQuery: (q) => MemoizedSelector<RootStore, { items: Aspect[]; totalCount: number; }, any>

Parameters

q

ExecutableQuery

Returns

MemoizedSelector<RootStore, { items: Aspect[]; totalCount: number; }, any>

selectCreated()

selectCreated: (actionId?) => MemoizedSelector<RootStore, flowSuccess<Aspect> | null, (s1) => flowSuccess<Aspect> | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<Aspect> | null, (s1) => flowSuccess<Aspect> | null>

selectCreatedEntity()

selectCreatedEntity: () => MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

Returns

MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

selectCreateError()

selectCreateError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectCreateFinished()

selectCreateFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<Aspect>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<Aspect>, (s1, s2) => FinishedSelectorResponse>

selectCreating()

selectCreating: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

selectDeleted()

selectDeleted: (actionId?) => MemoizedSelector<RootStore, flowSuccess<Aspect> | null, (s1) => flowSuccess<Aspect> | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<Aspect> | null, (s1) => flowSuccess<Aspect> | null>

selectDeletedEntity()

selectDeletedEntity: () => MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

Returns

MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

selectDeleteError()

selectDeleteError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectDeleteFinished()

selectDeleteFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<Aspect>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<Aspect>, (s1, s2) => FinishedSelectorResponse>

selectDeleting()

selectDeleting: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

selectEntities()

selectEntities: () => MemoizedSelector<RootStore, Dictionary<Aspect>, (s1) => Dictionary> | MemoizedSelector<RootStore, Dictionary<Aspect>, (s1) => Dictionary>

Returns

MemoizedSelector<RootStore, Dictionary<Aspect>, (s1) => Dictionary> | MemoizedSelector<RootStore, Dictionary<Aspect>, (s1) => Dictionary>

selectEtag()

selectEtag: (ids) => MemoizedSelector<RootStore, IEtag[], (s1) => IEtag[]>

Parameters

ids

string[]

Returns

MemoizedSelector<RootStore, IEtag[], (s1) => IEtag[]>

selectEtags()

selectEtags: () => MemoizedSelector<RootStore, Record<string, IEtag>, (s1) => Result>

Returns

MemoizedSelector<RootStore, Record<string, IEtag>, (s1) => Result>

selectIds()

selectIds: () => MemoizedSelector<RootStore, string[] | number[], (s1) => string[] | number[]> | MemoizedSelector<RootStore, string[], (s1) => string[]>

Returns

MemoizedSelector<RootStore, string[] | number[], (s1) => string[] | number[]> | MemoizedSelector<RootStore, string[], (s1) => string[]>

selectLastLoadedData()

selectLastLoadedData: () => MemoizedSelector<RootStore, Aspect[] | null, (s1) => Aspect[] | null>

Returns

MemoizedSelector<RootStore, Aspect[] | null, (s1) => Aspect[] | null>

selectLoaded()

selectLoaded: (actionId?) => MemoizedSelector<RootStore, flowSuccess<Aspect[]> | null, (s1) => flowSuccess<Aspect[]> | null>

Get the loaded from the state. If a specific actionId is provided, only return the loaded prop if it matches the actionId.

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<Aspect[]> | null, (s1) => flowSuccess<Aspect[]> | null>

selectLoadError()

selectLoadError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Get the load error from the state. If a specific actionId is provided, only return the error if it matches the actionId.

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectLoadFinished()

selectLoadFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<Aspect[]>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<Aspect[]>, (s1, s2) => FinishedSelectorResponse>

selectLoading()

selectLoading: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

selectRequestCacheEntry()

selectRequestCacheEntry: (key) => MemoizedSelector<RootStore, RequestCacheEntry | undefined, (s1) => RequestCacheEntry | undefined>

Cached conditional-request entry for a request key, or undefined when not cached / when persistData is off (feature disabled — there would be no entities to rebuild a 304 result from).

Parameters

key

string

Returns

MemoizedSelector<RootStore, RequestCacheEntry | undefined, (s1) => RequestCacheEntry | undefined>

selectUpdated()

selectUpdated: (actionId?) => MemoizedSelector<RootStore, flowSuccess<Aspect> | null, (s1) => flowSuccess<Aspect> | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowSuccess<Aspect> | null, (s1) => flowSuccess<Aspect> | null>

selectUpdatedEntity()

selectUpdatedEntity: () => MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

Returns

MemoizedSelector<RootStore, Aspect | undefined, (s1) => Aspect | undefined>

selectUpdateError()

selectUpdateError: (actionId?) => MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

Parameters

actionId?

string

Returns

MemoizedSelector<RootStore, flowError | null, (s1) => flowError | null>

selectUpdateFinished()

selectUpdateFinished: (actionId) => MemoizedSelector<any, FinishedSelectorResponse<Aspect>, (s1, s2) => FinishedSelectorResponse>

Parameters

actionId

string

Returns

MemoizedSelector<any, FinishedSelectorResponse<Aspect>, (s1, s2) => FinishedSelectorResponse>

selectUpdating()

selectUpdating: () => MemoizedSelector<RootStore, boolean, (s1) => boolean>

Returns

MemoizedSelector<RootStore, boolean, (s1) => boolean>

Inherited from

AbstractStatefulFacade._selectors

dispatch()

readonly dispatch: <V>(action) => void

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:36

Dispatches an action to the store.

Type Parameters

V

V extends Action = Action

Parameters

action

V & FunctionIsNotAllowed<V, "Functions are not allowed to be dispatched. Did you forget to call the action creator function?">

Returns

void

Inherited from

AbstractStatefulFacade.dispatch

facadeStore

protected facadeStore: FacadeStore

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:80

Inherited from

AbstractStatefulFacade.facadeStore

instance

protected instance: ApiStoreInstance

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:33

Inherited from

AbstractStatefulFacade.instance

section

protected section: "aspect"

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:50

Inherited from

AbstractStatefulFacade.section

select()

readonly select: <T, K>(selector) => Observable<K>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:34

Selects a slice of state from the store using the provided selector.

Type Parameters

T

T

K

K

Parameters

selector

MemoizedSelector<T, K>

Returns

Observable<K>

Inherited from

AbstractStatefulFacade.select

selectSignal()

readonly selectSignal: <K>(selector) => Signal<K>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:38

Returns a signal of the provided selector.

Type Parameters

K

K

Parameters

selector

MemoizedSelector<any, K>

Returns

Signal<K>

Inherited from

AbstractStatefulFacade.selectSignal

Accessors

actions

Get Signature

get actions(): object & object[SECTION]

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:58

Returns

object & object[SECTION]

Inherited from

AbstractStatefulFacade.actions

instanceId

Get Signature

get instanceId(): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:44

Gets the instance ID of the underlying ApiStoreInstance.

Returns

string

Inherited from

AbstractStatefulFacade.instanceId

selectors

Get Signature

get selectors(): object & object[SECTION]

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:61

Gets the selectors for the specified section of the API store, extended with tag selection filters.

Returns

object & object[SECTION]

Inherited from

AbstractStatefulFacade.selectors

Methods

_dispatchWithId()

protected _dispatchWithId<PROPS>(action, props): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:92

Dispatches an action with a newly generated actionId.

Type Parameters

PROPS

PROPS extends object & object

Parameters

action

ActionCreator<string, (props) => TypedAction<string>>

The action creator to dispatch. It has to accept a props object that includes an actionId of type string.

props

Omit<PROPS, "actionId">

The properties to pass to the action creator, excluding the actionId.

Returns

string

The generated actionId.

Inherited from

AbstractStatefulFacade._dispatchWithId

_dispatchWithResult$()

protected _dispatchWithResult$<PROPS, TYPE, DATA>(action, props, finishSelector): Observable<FacadeFinished<DATA>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:108

Extends the _dispatchWithId method to return an observable that emits when the action is finished.

Type Parameters

PROPS

PROPS extends object & object

TYPE

TYPE

DATA

DATA

Parameters

action

ActionCreator<string, (props) => TypedAction<string>>

The action creator to dispatch. It has to accept a props object that includes an actionId of type string.

props

Omit<PROPS, "actionId">

The properties to pass to the action creator, excluding the actionId.

finishSelector

(actionId) => MemoizedSelector<any, FinishedSelectorResponse<DATA>>

A selector function that takes an actionId and returns a FinishSelector for the action.

Returns

Observable<FacadeFinished<DATA>>

An observable that emits when the action is finished.

Inherited from

AbstractStatefulFacade._dispatchWithResult$

create()

create(action): Observable<FacadeFinished<Aspect>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:249

Creates a new aspect.

Parameters

action

AspectCreateBody

Returns

Observable<FacadeFinished<Aspect>>

createAsync()

createAsync(action): Promise<FacadeFinished<Aspect>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:263

A awaitable implementation of the

Parameters

action

AspectCreateBody

Returns

Promise<FacadeFinished<Aspect>>

See

create method.

delete()

delete(action): Observable<FacadeFinished<Aspect>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:311

Deletes an existing aspect.

Parameters

action

AspectDeleteBody

Returns

Observable<FacadeFinished<Aspect>>

deleteAsync()

deleteAsync(action): Promise<FacadeFinished<Aspect>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:354

A awaitable implementation of the

Parameters

action

AspectDeleteBody

Returns

Promise<FacadeFinished<Aspect>>

See

delete method.

extendQueryWithSelectedTags()

protected extendQueryWithSelectedTags<QB>(queryBuilder): QB

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.stateful-facade.ts:91

given a query builder, extend it with filters for the currently selected tags in the facade store.

Type Parameters

QB

QB extends AbstractQueryBuilder<any, any>

Parameters

queryBuilder

QB

Returns

QB

the extended query builder

Inherited from

AbstractStatefulFacade.extendQueryWithSelectedTags

filterById()

filterById(id): Observable<Aspect | undefined>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:65

Parameters

id

string

Returns

Observable<Aspect | undefined>

Deprecated

use a selector directly from the store, e.g. facade.select(facade.selectors.selectById(id)) Filters aspects by specified ID.

getAll()

getAll(): Observable<Aspect[]>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:75

Returns

Observable<Aspect[]>

Deprecated

use selectAll()

See

selectAll()

getFinishedObservable()

protected getFinishedObservable<T, D>(selector): Observable<FacadeFinished<D>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:77

Type Parameters

T

T

D

D

Parameters

selector

MemoizedSelector<any, FinishedSelectorResponse<D>>

Returns

Observable<FacadeFinished<D>>

Inherited from

AbstractStatefulFacade.getFinishedObservable

getNewId()

protected getNewId(): string

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:73

utility method to generate a new GUID. This is used to track actions.

Returns

string

A new GUID.

Inherited from

AbstractStatefulFacade.getNewId

getQueryBuilder()

getQueryBuilder(…args): AspectQueryBuilder

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:42

Get a new instance of the AspectQueryBuilder.

Parameters

args

…[AbstractQueryBuilderOptions<AspectQueryFilterKeys, AspectQuery>]

Returns

AspectQueryBuilder

Overrides

AbstractStatefulFacade.getQueryBuilder

lastLoadedData()

lastLoadedData(): Observable<Aspect[] | null>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:54

Returns

Observable<Aspect[] | null>

Deprecated

Gets the last loaded data of aspects.

load()

load(query?): Observable<FacadeFinished<Aspect[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:178

Loads Aspects based on the provided filter.

Parameters

query?

FacadeAspectLoad

The query to filter Aspects.

Returns

Observable<FacadeFinished<Aspect[]>>

Examples

load({ fyzFacadeType: 'page', page: 1, pageSize: 10 });

load();
load({ fyzFacadeType: 'page' });

load({ fyzFacadeType: 'load', name:'Aspect1'});

loadAll()

Call Signature

loadAll(): Observable<FacadeFinished<Aspect[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:98

Returns

Observable<FacadeFinished<Aspect[]>>

Deprecated

use the load method instead. Loads all aspects based on the provided filter.

Call Signature

loadAll(query): Observable<FacadeFinished<Aspect[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:103

Load all Aspect based on the provided query - handles pagination internally and loads all.

Parameters

query

FacadeAspect_LoadAll

Returns

Observable<FacadeFinished<Aspect[]>>

loadAllAsync()

loadAllAsync(query): Promise<FacadeFinished<Aspect[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:157

A awaitable impl. of the

Parameters

query

FacadeAspect_LoadAll

Returns

Promise<FacadeFinished<Aspect[]>>

See

loadAll method.

loadAsync()

loadAsync(query?): Promise<FacadeFinished<Aspect[]>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:240

A awaitable implementation of the

Parameters

query?

FacadeAspectLoad

Returns

Promise<FacadeFinished<Aspect[]>>

See

load method.

selectAll()

selectAll(): Observable<Aspect[]>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:83

Returns

Observable<Aspect[]>

Deprecated

use selectAll() select all aspects in the store.

update()

update(action): Observable<FacadeFinished<Aspect>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:272

Updates an existing aspect.

Parameters

action

AspectUpdateBody

Returns

Observable<FacadeFinished<Aspect>>

updateAsync()

updateAsync(action): Promise<FacadeFinished<Aspect>>

Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect.facade.ts:302

A awaitable implementation of the

Parameters

action

AspectUpdateBody

Returns

Promise<FacadeFinished<Aspect>>

See

update method.