TreeSchemaEncodingOptions 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 TreeSchemaEncodingOptions extends TreeParsingOptions
Extends: TreeParsingOptions
Remarks
This currently extends TreeParsingOptions, removing the option to declare allStoredKeys since this option is currently not supported. \
Properties
| Property | Alerts | Modifiers | Default Value | Type | Description |
|---|---|---|---|---|---|
| requireFieldsWithDefaults | Alpha | optional, readonly | false. | boolean | If true, fields with default providers (like identifier) will be required. If false, they will be optional. |
Property Details
requireFieldsWithDefaults
If true, fields with default providers (like identifier) will be required. If false, they will be optional.
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 requireFieldsWithDefaults?: boolean;
Type: boolean