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.
Signature
export interface TreeSchemaEncodingOptions extends TreeEncodingOptions
Extends: TreeEncodingOptions
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