Skip to main content

FieldPropsAlpha Interface

FieldProps extended with additional alpha options.

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 FieldPropsAlpha<TCustomMetadata = unknown> extends FieldProps<TCustomMetadata>

Extends: FieldProps<TCustomMetadata>

Type Parameters

Parameter Default Description
TCustomMetadata unknown Custom metadata properties to associate with the field. See custom.

Properties

Property Alerts Modifiers Type Description
persistedMetadata Alpha optional, readonly JsonCompatibleReadOnlyObject | undefined The persisted metadata for this schema element.

Property Details

persistedMetadata

The persisted metadata for this schema element.

This API is provided as an alpha preview and may change without notice.

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
readonly persistedMetadata?: JsonCompatibleReadOnlyObject | undefined;

Type: JsonCompatibleReadOnlyObject | undefined