IDataStore Interface
A fluid router with the capability of being assigned an alias
Signature
export interface IDataStore extends IFluidRouter
Extends: IFluidRouter
Methods
| Method | Return Type | Description |
|---|---|---|
| trySetAlias(alias) | Promise<AliasResult> | Attempt to assign an alias to the datastore. If the operation succeeds, the datastore can be referenced by the supplied alias and will not be garbage collected. |
Method Details
trySetAlias
Attempt to assign an alias to the datastore. If the operation succeeds, the datastore can be referenced by the supplied alias and will not be garbage collected.
Signature
trySetAlias(alias: string): Promise<AliasResult>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| alias | string | Given alias for this datastore. |
Returns
Return type: Promise<AliasResult>