ServiceOptions Interface
Options for configuring a ServiceClient.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.
Signature
export interface ServiceOptions
Remarks
These are the options which apply to all services.
Individual services will extend with additional options.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| oldestSupportedClient | Alpha | optional, readonly | OldestSupportedServiceClientVersion | Oldest Fluid Framework client version that must be able to open and process documents written by the service client. |
Property Details
oldestSupportedClient
Oldest Fluid Framework client version that must be able to open and process documents written by the service client.
For more information about our API support guarantees, see here.
Signature
readonly oldestSupportedClient?: OldestSupportedServiceClientVersion;
Type: OldestSupportedServiceClientVersion
Remarks
Choosing an older version may limit the features and write formats the application can use to those supported by that version.
A service may provide a default when this option is omitted.