Class: AspectDataMigrationFacade
@flyze/lib-data-store 3.0.0-alpha.55· latestDefined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:20
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
Section titled “Extends”AbstractFacade<"aspectDataMigration">
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AspectDataMigrationFacade(
instance):AspectDataMigrationFacade
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:21
Parameters
Section titled “Parameters”instance
Section titled “instance”ApiStoreInstance
Returns
Section titled “Returns”AspectDataMigrationFacade
Overrides
Section titled “Overrides”Properties
Section titled “Properties”dispatch()
Section titled “dispatch()”
readonlydispatch: <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
Section titled “Type Parameters”V extends Action = Action
Parameters
Section titled “Parameters”action
Section titled “action”V & FunctionIsNotAllowed<V, "Functions are not allowed to be dispatched. Did you forget to call the action creator function?">
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”instance
Section titled “instance”
protectedinstance:ApiStoreInstance
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:21
Inherited from
Section titled “Inherited from”section
Section titled “section”
protectedsection:"aspectDataMigration"
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/_abstract/abstract.facade.ts:50
Inherited from
Section titled “Inherited from”select()
Section titled “select()”
readonlyselect: <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
Section titled “Type Parameters”T
K
Parameters
Section titled “Parameters”selector
Section titled “selector”MemoizedSelector<T, K>
Returns
Section titled “Returns”Observable<K>
Inherited from
Section titled “Inherited from”selectSignal()
Section titled “selectSignal()”
readonlyselectSignal: <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
Section titled “Type Parameters”K
Parameters
Section titled “Parameters”selector
Section titled “selector”MemoizedSelector<any, K>
Returns
Section titled “Returns”Signal<K>
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”actions
Section titled “actions”Get Signature
Section titled “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
Section titled “Returns”object & object[SECTION]
Inherited from
Section titled “Inherited from”instanceId
Section titled “instanceId”Get Signature
Section titled “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
Section titled “Returns”string
Inherited from
Section titled “Inherited from”selectors
Section titled “selectors”Get Signature
Section titled “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
Section titled “Returns”object & object[SECTION]
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”_dispatchWithId()
Section titled “_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
Section titled “Type Parameters”PROPS extends object & object
Parameters
Section titled “Parameters”action
Section titled “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.
Omit<PROPS, "actionId">
The properties to pass to the action creator, excluding the actionId.
Returns
Section titled “Returns”string
The generated actionId.
Inherited from
Section titled “Inherited from”AbstractFacade._dispatchWithId
_dispatchWithResult$()
Section titled “_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
Section titled “Type Parameters”PROPS extends object & object
TYPE
DATA
Parameters
Section titled “Parameters”action
Section titled “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.
Omit<PROPS, "actionId">
The properties to pass to the action creator, excluding the actionId.
finishSelector
Section titled “finishSelector”(actionId) => MemoizedSelector<any, FinishedSelectorResponse<DATA>>
A selector function that takes an actionId and returns a FinishSelector for the action.
Returns
Section titled “Returns”Observable<FacadeFinished<DATA>>
An observable that emits when the action is finished.
Inherited from
Section titled “Inherited from”AbstractFacade._dispatchWithResult$
apply()
Section titled “apply()”apply(
arg):Observable<FacadeFinished<AspectData<any> |undefined>>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:149
Applies a migration to the aspect type.
Parameters
Section titled “Parameters”AspectDataMigrationSpecificMigrationQuery
Returns
Section titled “Returns”Observable<FacadeFinished<AspectData<any> | undefined>>
applyAsync()
Section titled “applyAsync()”applyAsync(
arg):Promise<FacadeFinished<AspectData<any> |undefined>>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:162
A awaitable implementation of the
Parameters
Section titled “Parameters”AspectDataMigrationSpecificMigrationQuery
Returns
Section titled “Returns”Promise<FacadeFinished<AspectData<any> | undefined>>
apply method.
getFinishedObservable()
Section titled “getFinishedObservable()”
protectedgetFinishedObservable<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
Section titled “Type Parameters”T
D
Parameters
Section titled “Parameters”selector
Section titled “selector”MemoizedSelector<any, FinishedSelectorResponse<D>>
Returns
Section titled “Returns”Observable<FacadeFinished<D>>
Inherited from
Section titled “Inherited from”AbstractFacade.getFinishedObservable
getNewId()
Section titled “getNewId()”
protectedgetNewId():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
Section titled “Returns”string
A new GUID.
Inherited from
Section titled “Inherited from”getQueryBuilder()
Section titled “getQueryBuilder()”getQueryBuilder(…
args):AspectDataMigrationQueryBuilder
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:28
Get a new instance of the AspectDataMigrationQueryBuilder.
Parameters
Section titled “Parameters”…[AbstractQueryBuilderOptions<AspectDataMigrationQueryFilterKeys, AspectDataMigrationQuery>]
Returns
Section titled “Returns”AspectDataMigrationQueryBuilder
load()
Section titled “load()”load(
arg):Observable<FacadeFinished<AspectDataMigration_StoreEntry[]>>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:85
Loads all aspect data migrations based on the provided filter.
Parameters
Section titled “Parameters”FacadeAspectDataMigration_Load
Returns
Section titled “Returns”Observable<FacadeFinished<AspectDataMigration_StoreEntry[]>>
loadAll()
Section titled “loadAll()”loadAll(
query):Observable<FacadeFinished<AspectDataMigration_StoreEntry[]>>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:38
Load all AspectData based on the provided query - handles pagination internally and loads all.
Parameters
Section titled “Parameters”FacadeAspectDataMigration_filter
Returns
Section titled “Returns”Observable<FacadeFinished<AspectDataMigration_StoreEntry[]>>
loadAllAsync()
Section titled “loadAllAsync()”loadAllAsync(
query):Promise<FacadeFinished<AspectDataMigration_StoreEntry[]>>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:76
A awaitable impl. of the
Parameters
Section titled “Parameters”FacadeAspectDataMigration_filter
Returns
Section titled “Returns”Promise<FacadeFinished<AspectDataMigration_StoreEntry[]>>
loadAll method.
loadAsync()
Section titled “loadAsync()”loadAsync(
arg):Promise<FacadeFinished<AspectDataMigration_StoreEntry[]>>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:116
A awaitable implementation of the
Parameters
Section titled “Parameters”FacadeAspectDataMigration_Load
Returns
Section titled “Returns”Promise<FacadeFinished<AspectDataMigration_StoreEntry[]>>
load method.
view()
Section titled “view()”view(
arg):Observable<any>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:125
Load a aspect type on a specific migration version.
Parameters
Section titled “Parameters”AspectDataMigrationSpecificMigrationQuery
Returns
Section titled “Returns”Observable<any>
viewAsync()
Section titled “viewAsync()”viewAsync(
arg):Promise<any>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/facades/aspect-data-migration.facade.ts:140
A awaitable implementation of the
Parameters
Section titled “Parameters”AspectDataMigrationSpecificMigrationQuery
Returns
Section titled “Returns”Promise<any>
view method.