Class: DataSourceFacade

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

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

Constructors

Constructor

new DataSourceFacade(instance): DataSourceFacade

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

Parameters

instance

ApiStoreInstance

Returns

DataSourceFacade

Overrides

AbstractFacade.constructor

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

Inherited from

AbstractFacade.dispatch

---

instance

protected instance: ApiStoreInstance

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

Inherited from

AbstractFacade.instance

---

section

protected section: "dataSource"

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.facade.ts:65

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

Returns

object & object[SECTION]

Inherited from

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$

---

create()

create(createBody): Observable<FacadeFinished<DataSource>>

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

Creates a new AssetType.

Parameters

createBody

DataSourceCreateBody

The body of the request to create a new AssetType.

Returns

Observable<FacadeFinished<DataSource>>

---

createAsync()

createAsync(createBody): Promise<FacadeFinished<DataSource>>

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

A awaitable impl. of the

Parameters

createBody

DataSourceCreateBody

Returns

Promise<FacadeFinished<DataSource>>

See

create method.

---

delete()

delete(deleteBody): Observable<FacadeFinished<DataSource>>

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

Deletes an existing AssetType.

Parameters

deleteBody

DataSourceDeleteBody

The body of the request to delete an AssetType.

Returns

Observable<FacadeFinished<DataSource>>

---

deleteAsync()

deleteAsync(deleteBody): Promise<FacadeFinished<DataSource>>

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

A awaitable impl. of the

Parameters

deleteBody

DataSourceDeleteBody

Returns

Promise<FacadeFinished<DataSource>>

See

delete method.

---

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

getQueryBuilder(…args): DataSourceQueryBuilder

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

Get a new instance of the DataSourceQueryBuilder.

Parameters

args

…[AbstractQueryBuilderOptions<DataSourceQueryFilterKeys, DataSourceQuery>]

Returns

DataSourceQueryBuilder

---

load()

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

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

Loads AssetTypes based on the provided filter.

Parameters

query?

FacadeDataSourceLoad

The query to filter AssetTypes.

Returns

Observable<FacadeFinished<DataSource[]>>

Examples

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

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

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

---

loadAll()

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

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

Loads all DataSources based on the provided query.

Parameters

query

FacadeDataSource_LoadAll

The query to filter DataSources.

Returns

Observable<FacadeFinished<DataSource[]>>

---

loadAllAsync()

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

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

A awaitable impl. of the

Parameters

query

FacadeDataSource_LoadAll

Returns

Promise<FacadeFinished<DataSource[]>>

See

loadAll method.

---

loadAsync()

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

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

A awaitable impl. of the

Parameters

query?

FacadeDataSourceLoad

Returns

Promise<FacadeFinished<DataSource[]>>

See

load method.

---

selectAll()

selectAll(): Observable<DataSource[]>

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

Returns

Observable<DataSource[]>

An Observable that resolves to all data sources.

Deprecated

use a selector directly from the store, e.g. facade.select(facade.selectors.selectAll()) Select all DataSources in the store.

---

update()

update(updateBody): Observable<FacadeFinished<DataSource>>

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

Updates an existing AssetType.

Parameters

updateBody

DataSourceUpdateBody

Returns

Observable<FacadeFinished<DataSource>>

---

updateAsync()

updateAsync(updateBody): Promise<FacadeFinished<DataSource>>

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

A awaitable impl. of the

Parameters

updateBody

DataSourceUpdateBody

Returns

Promise<FacadeFinished<DataSource>>

See

update method.