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.
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 interface TreeEncodingOptions<TKeyOptions = KeyEncodingOptions>
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| TKeyOptions | KeyEncodingOptions |
Properties
| Property | Alerts | Modifiers | Default Value | Type | Description |
|---|---|---|---|---|---|
| keys | Alpha |
optional, readonly |
usePropertyKeys. | TKeyOptions | How to handle field keys. |
Property Details
keys
How to handle field 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 keys?: TKeyOptions;
Type: TKeyOptions
Remarks
Has no effect on NodeKinds other than Object.
Unknown optional field will be omitted when using property keys.