Class: FlyzeApiStoreBaseFacade
@flyze/lib-data-store 3.0.0-alpha.55· latestDefined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:26
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FlyzeApiStoreBaseFacade(
storeManager):FlyzeApiStoreBaseFacade
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:29
Parameters
Section titled “Parameters”storeManager
Section titled “storeManager”Returns
Section titled “Returns”FlyzeApiStoreBaseFacade
Properties
Section titled “Properties”storeManager
Section titled “storeManager”
protectedreadonlystoreManager:FlyzeApiStoreManager
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:27
Methods
Section titled “Methods”addInstance()
Section titled “addInstance()”addInstance(
config):Promise<FlyzeApiStoreFacadeInstance|undefined>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:164
Adds a new API store instance and returns its facade instance.
Parameters
Section titled “Parameters”config
Section titled “config”The configuration for the new instance
Returns
Section titled “Returns”Promise<FlyzeApiStoreFacadeInstance | undefined>
A promise that resolves to the facade instance of the newly added instance
createInstanceFacade()
Section titled “createInstanceFacade()”createInstanceFacade(
instanceId,params):FlyzeApiStoreFacadeInstance
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:53
Gets the facade instance by its name/id. If tagIds are provided, a new facade instance is created with the given tag filters.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
The name/id of the instance
params
Section titled “params”object & object = {}
Returns
Section titled “Returns”The facade instance.
createInstanceFacadeAsync()
Section titled “createInstanceFacadeAsync()”createInstanceFacadeAsync(
instanceId,params):Promise<FlyzeApiStoreFacadeInstance>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:99
Gets a facade instance asynchronously, optionally filtered by tag IDs or tag descriptions. As tag descriptions require a lookup, this method is asynchronous.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
params
Section titled “params”{ tagId?: string | string[]; } | { tagCustomId?: string | string[]; } & object = {}
Returns
Section titled “Returns”Promise<FlyzeApiStoreFacadeInstance>
A promise that resolves to the facade instance
getInstance()
Section titled “getInstance()”getInstance(…
args):FlyzeApiStoreFacadeInstance
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:36
Parameters
Section titled “Parameters”…[string, object & object]
Returns
Section titled “Returns”Deprecated
Section titled “Deprecated”Use createInstanceFacade instead
getInstanceAsync()
Section titled “getInstanceAsync()”getInstanceAsync(…
args):Promise<FlyzeApiStoreFacadeInstance>
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:78
Parameters
Section titled “Parameters”…[string, ({ tagId?: string | string[] | undefined; } | { tagCustomId?: string | string[] | undefined; }) & { selectedTagExclusive?: boolean | undefined; }]
Returns
Section titled “Returns”Promise<FlyzeApiStoreFacadeInstance>
Deprecated
Section titled “Deprecated”Use getAvailableInstances instead
removeInstance()
Section titled “removeInstance()”removeInstance(
instanceId):void
Defined in: projects/lib-data-store/src/lib/flyze-api-store-facade/flyze-api-store-base.facade.ts:194
Removes an existing API store instance by its name/id.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
The id of the instance to remove
Returns
Section titled “Returns”void