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 @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
export interface EncodeOptions<TCustom>
Type Parameters
| Parameter | Description |
|---|---|
| TCustom |
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. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| valueConverter(data) | Alpha |
TCustom | How to encode any IFluidHandles in the tree. |
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.
To use, import via @fluidframework/tree/alpha.
For more information about our API support guarantees, see here.
Signature
readonly useStoredKeys?: boolean;
Type: boolean
Method Details
valueConverter
How to encode any IFluidHandles in the tree.
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
valueConverter(data: IFluidHandle): TCustom;
Remarks
See note on valueConverter(data).
Parameters
| Parameter | Type | Description |
|---|---|---|
| data | IFluidHandle |
Returns
Return type: TCustom