SharedStringFactory Class
Packages > @fluidframework/sequence > SharedStringFactory
Signature:
export declare class SharedStringFactory implements IChannelFactory
Implements: IChannelFactory
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| attributes | IChannelAttributes | ||
| Attributes | static |
IChannelAttributes | |
| type | string | ||
| Type | static |
string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| create(document, id) | ||
| load(runtime, id, services, branchId, attributes) | ||
| segmentFromSpec(spec) | static |
Properties
attributes
Signature:
get attributes(): IChannelAttributes;
Attributes
Signature:
static readonly Attributes: IChannelAttributes;
type
Signature:
get type(): string;
Type
Signature:
static Type: string;
Methods
create
Signature:
create(document: IFluidDataStoreRuntime, id: string): SharedString;
Parameters
| Parameter | Type | Description |
|---|---|---|
| document | IFluidDataStoreRuntime | |
| id | string |
Returns:
load
Signature:
load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, branchId: string, attributes: IChannelAttributes): Promise<SharedString>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| runtime | IFluidDataStoreRuntime | |
| id | string | |
| services | IChannelServices | |
| branchId | string | |
| attributes | IChannelAttributes |
Returns:
Promise<SharedString>
segmentFromSpec
Signature:
static segmentFromSpec(spec: any): MergeTree.TextSegment | MergeTree.Marker;
Parameters
| Parameter | Type | Description |
|---|---|---|
| spec | any |
Returns:
MergeTree.TextSegment | MergeTree.Marker