CodecWriteOptions Interface
Options relating to encoding of persisted data.
To use, import via fluid-framework/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 CodecWriteOptions extends ICodecOptions
Extends: ICodecOptions
Remarks
Extends ICodecOptions with options that are specific to encoding data.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| oldestCompatibleClient | Alpha |
readonly |
FluidClientVersion | The minimum version of the Fluid Framework client output must be encoded to be compatible with. |
Property Details
oldestCompatibleClient
The minimum version of the Fluid Framework client output must be encoded to be compatible with.
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
readonly oldestCompatibleClient: FluidClientVersion;
Type: FluidClientVersion
Remarks
This is used to ensure that the the output from this codec can be used with older versions of the Fluid Framework client. This includes both concurrent collaboration, and an older version opening the document later.
Note that versions older than this should not result in data corruption if they access the data: the data's format should be versioned and if they can't handle the format they should error.