SimpleObjectFieldSchema Interface

A SimpleFieldSchema for an SimpleObjectNodeSchema field.

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

To use, import via fluid-framework/alpha.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface SimpleObjectFieldSchema extends SimpleFieldSchema

Extends: SimpleFieldSchema

Remarks

The only other case fields are uses in the root schema.

Properties

Property	Alerts	Modifiers	Type	Description
storedKey	Alpha	readonly	string	The stored key of the field.

Property Details

storedKey

The stored key of the field.

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

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly storedKey: string;

Type: string

Remarks

See key for more information.