FieldSchemaUnsafe Interface

Unenforced version of FieldSchema.

This API is reserved for internal system use and should not be imported directly. It may change at any time 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

/** @sealed */
interface FieldSchemaUnsafe<out Kind extends FieldKind, out Types extends ImplicitAllowedTypesUnsafe, out TCustomMetadata = unknown> extends FieldSchema<Kind, any, TCustomMetadata>

Extends: FieldSchema<Kind, any, TCustomMetadata>

Type Parameters

Parameter	Constraint	Default	Description
Kind	FieldKind
Types	ImplicitAllowedTypesUnsafe
TCustomMetadata		unknown

Remarks

Do not use this type directly: it's only needed in the implementation of generic logic which define recursive schema, not when using recursive schema.

Properties

Property	Modifiers	Type	Description
allowedTypes	readonly	Types	What types of tree nodes are allowed in this field.
allowedTypeSet	readonly	ReadonlySet<TreeNodeSchema>	What types of tree nodes are allowed in this field.
kind	readonly	Kind	The kind of this field. Determines the multiplicity, viewing and editing APIs as well as the merge resolution policy.

Property Details

allowedTypes

What types of tree nodes are allowed in this field.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

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

Signature

readonly allowedTypes: Types;

Type: Types

allowedTypeSet

What types of tree nodes are allowed in this field.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

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

Signature

readonly allowedTypeSet: ReadonlySet<TreeNodeSchema>;

Type: ReadonlySet<TreeNodeSchema>

Remarks

Counterpart to allowedTypes, with any lazy definitions evaluated.

kind

The kind of this field. Determines the multiplicity, viewing and editing APIs as well as the merge resolution policy.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

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

Signature

readonly kind: Kind;

Type: Kind