Abstract Class: AbstractFacade<SECTION>

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

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.

Extended by

• AbstractStatefulFacade
• AspectTypeMigrationFacade
• AspectDataMigrationFacade
• AccessControlBindingFacade
• DataSourceFacade
• AppointmentRuleFacade
• FlyzeApiStoreFacadeInstance
• ResourceReferenceFacade
• TagFacade

Type Parameters

SECTION

SECTION extends keyof ApiStoreInstance["actions"]

Constructors

Constructor

new AbstractFacade<SECTION>(section, instance): AbstractFacade<SECTION>

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

Parameters

section

SECTION

instance

ApiStoreInstance

Returns

AbstractFacade<SECTION>

Properties

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

---

instance

protected instance: ApiStoreInstance

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

---

section

protected section: SECTION

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

---

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>

---

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>

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]

---

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

---

selectors

Get Signature

get selectors(): object & object[SECTION]

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

Gets the selectors for the specified section of the API store.

Returns

object & object[SECTION]

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.

---

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

---

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

---

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.