ParseOptions Interface
Options for how to interpret a VerboseTree<TCustom> when schema information is available.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Signature
export interface ParseOptions<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 |
TreeLeafValue | VerboseTreeNode<TCustom> | Fixup custom input formats. |
Property Details
useStoredKeys
If true, interpret the input keys of object nodes as stored keys. If false, interpret them as property keys.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Signature
readonly useStoredKeys?: boolean;
Type: boolean
Method Details
valueConverter
Fixup custom input formats.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Signature
valueConverter(data: VerboseTree<TCustom>): TreeLeafValue | VerboseTreeNode<TCustom>;
Remarks
Main usage is to handle IFluidHandles. When targeting JSON compatibility, this may be by throwing an error or including a placeholder. Since IFluidHandles are special references to FLuid data which is garbage collected when not referenced by the container for long enough, any scheme for encoding handles for storage outside the container (or in formats the container does not understand) is unreliable.
Parameters
| Parameter | Type | Description |
|---|---|---|
| data | VerboseTree<TCustom> |
Returns
Return type: TreeLeafValue | VerboseTreeNode<TCustom>