CodecWriteOptions Interface
Options relating to encoding of persisted data.
To use, import via @fluidframework/tree/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, CodecWriteOptionsBeta
Extends: ICodecOptions, CodecWriteOptionsBeta
Remarks
Extends ICodecOptions with options that are specific to encoding data.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| allowPossiblyIncompatibleWriteVersionOverrides | Alpha | optional, readonly | boolean | If true, suppress errors when writeVersionOverrides selects a version which may not be compatible with the minVersionForCollab. |
| writeVersionOverrides | Alpha | optional, readonly | ReadonlyMap<CodecName, FormatVersion> | Overrides the version of the codec to use for encoding. |
Property Details
allowPossiblyIncompatibleWriteVersionOverrides
If true, suppress errors when writeVersionOverrides selects a version which may not be compatible with the minVersionForCollab.
For more information about our API support guarantees, see here.
Signature
readonly allowPossiblyIncompatibleWriteVersionOverrides?: boolean;
Type: boolean
writeVersionOverrides
Overrides the version of the codec to use for encoding.
For more information about our API support guarantees, see here.
Signature
readonly writeVersionOverrides?: ReadonlyMap<CodecName, FormatVersion>;
Type: ReadonlyMap<CodecName, FormatVersion>
Remarks
Without an override, the selected version will be based on minVersionForCollab.