Skip to main content

EncodeOptions Interface

Options for how to encode 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.

Signature

export interface EncodeOptions

Properties

Property Alerts Modifiers Default Value Type Description
useStoredKeys Alpha optional, readonly false. boolean If true, interpret the input keys of object nodes as stored keys. If false, interpret them as property keys.

Property Details

useStoredKeys

If true, interpret the input keys of object nodes as stored keys. If false, interpret them as 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

readonly useStoredKeys?: boolean;

Type: boolean