Skip to main content

TreeEncodingOptions Interface

Options for how to interpret or encode a tree when schema information is available.

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

To use, import via @fluidframework/tree/alpha.

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

Signature

export interface TreeEncodingOptions

Properties

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

Property Details

useStoredKeys

If true, use the stored keys of object nodes. If false, use the 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

Remarks

Has no effect on NodeKinds other than Object.