Abstract Class: AbstractStatefulFacade<SECTION, QUERY_BUILDER, MODEL>

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

Abstract class representing a facade for interacting with assets through the Flyze API. This class provides common methods for checking loading, creating, updating, and deleting states and errors.

Extends

• AbstractFacade<SECTION>

Extended by

• AspectTypeFacade
• AspectFacade
• AssetFacade
• AssetTypeFacade
• AspectDataFacade

Type Parameters

SECTION

SECTION extends StoreSections

QUERY_BUILDER

QUERY_BUILDER extends AbstractQueryBuilder<any, any>

MODEL

MODEL extends TAGGED_ENTITY = TAGGED_ENTITY

Constructors

Constructor

new AbstractStatefulFacade<SECTION, QUERY_BUILDER, MODEL>(facadeStore, …args): AbstractStatefulFacade<SECTION, QUERY_BUILDER, MODEL>

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

Parameters

facadeStore

FacadeStore

args

…[SECTION, ApiStoreInstance]

Returns

AbstractStatefulFacade<SECTION, QUERY_BUILDER, MODEL>

Overrides

AbstractFacade.constructor

Properties

_selectors

protected _selectors: object & object[SECTION]

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.

---

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

AbstractFacade.dispatch

---

facadeStore

protected facadeStore: FacadeStore

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

---

instance

protected instance: ApiStoreInstance

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

Inherited from

AbstractFacade.instance

---

section

protected section: SECTION

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

Inherited from

AbstractFacade.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.

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

AbstractFacade.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.

Returns a signal of the provided selector.

Type Parameters

K

K

Parameters

selector

MemoizedSelector<any, K>

Returns

Signal<K>

Inherited from

AbstractFacade.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

AbstractFacade.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

AbstractFacade.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]

Overrides

AbstractFacade.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

AbstractFacade._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

AbstractFacade._dispatchWithResult$

---

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

---

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

AbstractFacade.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

AbstractFacade.getNewId

---

getQueryBuilder()

abstract getQueryBuilder(…args): QUERY_BUILDER

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

Get a new instance of the QueryBuilder for this store section.

Parameters

args

…[AbstractQueryBuilderOptions<any, any>]

Returns

QUERY_BUILDER