LocalDocumentServiceFactory Class
Implementation of document service factory for local use. \
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/local-driver/legacy.
For more information about our API support guarantees, see here.
Signature
export declare class LocalDocumentServiceFactory implements IDocumentServiceFactory
Implements: IDocumentServiceFactory
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(localDeltaConnectionServer, policies, innerDocumentService) | Alpha |
Constructs a new instance of the LocalDocumentServiceFactory class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| ILayerCompatDetails | Alpha |
optional, readonly |
unknown | The compatibility details of the Local Driver layer that is exposed to the Loader layer for validating Loader-Driver compatibility. |
Constructor Details
(constructor)
Constructs a new instance of the LocalDocumentServiceFactory class
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
constructor(localDeltaConnectionServer: ILocalDeltaConnectionServer, policies?: IDocumentServicePolicies | undefined, innerDocumentService?: IDocumentService | undefined);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| localDeltaConnectionServer | ILocalDeltaConnectionServer | delta connection server for ops | |
| policies | optional | IDocumentServicePolicies | undefined | |
| innerDocumentService | optional | IDocumentService | undefined |
Property Details
ILayerCompatDetails
The compatibility details of the Local Driver layer that is exposed to the Loader layer for validating Loader-Driver compatibility.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
readonly ILayerCompatDetails?: unknown;
Type: unknown
Remarks
This is for internal use only. The type of this should be ILayerCompatDetails. However, ILayerCompatDetails is internal and this class is currently marked as legacy alpha. So, using unknown here.