KeyEncodingOptions Enum
Options for how to encode keys in a tree.
To use, import via @fluidframework/tree/beta.
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 declare enum KeyEncodingOptions
Flags
| Flag | Alerts | Description |
|---|---|---|
| allStoredKeys | Beta | Use stored keys, and include Unknown optional fields. |
| knownStoredKeys | Beta | Use stored keys but do not include unknown optional fields. |
| usePropertyKeys | Beta | Use property keys. |
allStoredKeys
Use stored keys, and include Unknown optional fields.
For more information about our API support guarantees, see here.
Signature
allStoredKeys = "allStoredKeys"
Remarks
Currently only supported for export.
knownStoredKeys
Use stored keys but do not include unknown optional fields.
For more information about our API support guarantees, see here.
Signature
knownStoredKeys = "knownStoredKeys"
Remarks
Supported for import and export. For export, this omits unknown optional fields. For import, any unexpected fields are errors, regardless of allowUnknownOptionalFields.
usePropertyKeys
Use property keys.
For more information about our API support guarantees, see here.
Signature
usePropertyKeys = "usePropertyKeys"
Remarks
Supported for import and export. Unknown optional fields will be omitted when using property keys.