Skip to main content

KeyEncodingOptions Enum

Options for how to encode keys in a tree. \

This API is provided as an alpha preview and may change without notice.

To use, import via fluid-framework/alpha.

For more information about our API support guarantees, see here.

Input

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 Alpha Use stored keys, and include Unknown optional fields.
knownStoredKeys Alpha Use stored keys but do not include Unknown optional fields.
usePropertyKeys Alpha Use property keys.

allStoredKeys​

Use stored keys, and include Unknown optional fields.

This API is provided as an alpha preview and may change without notice.

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.

This API is provided as an alpha preview and may change without notice.

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.

This API is provided as an alpha preview and may change without notice.

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.