SharedTreeFactory Class
Factory for SharedTree. Includes history in the summary.
Signature
export declare class SharedTreeFactory implements IChannelFactory
Implements: IChannelFactory
Constructors
| Constructor | Description |
|---|---|
| (constructor)(args) | Get a factory for SharedTree to register with the data store. |
| (constructor)(args) | Constructs a new instance of the SharedTreeFactory class |
Static Properties
| Property | Type | Description |
|---|---|---|
| Attributes | IChannelAttributes | |
| Type | string |
Properties
| Property | Type | Description |
|---|---|---|
| attributes | IChannelAttributes | |
| type | string |
Methods
| Method | Return Type | Description |
|---|---|---|
| create(runtime, id) | SharedTree | Create a new SharedTree. |
| load(runtime, id, services, _channelAttributes) | Promise<IChannel> |
Constructor Details
(constructor)
Get a factory for SharedTree to register with the data store.
Signature
constructor(...args: SharedTreeArgs<WriteFormat.v0_0_2>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| args | SharedTreeArgs<WriteFormat.v0_0_2> |
Returns
A factory that creates SharedTrees and loads them from storage.
(constructor)
Constructs a new instance of the SharedTreeFactory class
Signature
constructor(...args: SharedTreeArgs<WriteFormat.v0_1_1>);
Parameters
| Parameter | Type | Description |
|---|---|---|
| args | SharedTreeArgs<WriteFormat.v0_1_1> |
Property Details
attributes
Signature
get attributes(): IChannelAttributes;
Type: IChannelAttributes
Attributes
Signature
static Attributes: IChannelAttributes;
Type: IChannelAttributes
type
Signature
get type(): string;
Type: string
Type
Signature
static Type: string;
Type: string
Method Details
create
Create a new SharedTree.
Signature
create(runtime: IFluidDataStoreRuntime, id: string): SharedTree;
Parameters
| Parameter | Type | Description |
|---|---|---|
| runtime | IFluidDataStoreRuntime | data store runtime that owns the new SharedTree |
| id | string | optional name for the SharedTree |
Returns
Return type: SharedTree
load
Signature
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, _channelAttributes: Readonly<IChannelAttributes>): Promise<IChannel>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| runtime | IFluidDataStoreRuntime | |
| id | string | |
| services | IChannelServices | |
| _channelAttributes | Readonly<IChannelAttributes> |
Returns
Return type: Promise<IChannel>