Skip to main content

FieldSchemaUnsafe Interface

Unenforced version of FieldSchema.

Signature​

export interface FieldSchemaUnsafe<out Kind extends FieldKind, out Types extends Unenforced<ImplicitAllowedTypes>> extends FieldSchema<Kind, any>

Extends: FieldSchema<Kind, any>

Type Parameters​

Parameter Constraint Description
Kind FieldKind
Types Unenforced<ImplicitAllowedTypes>

Remarks​

Do note use this type directly: its 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.

Signature​

readonly allowedTypes: Types;

Type: Types

allowedTypeSet​

What types of tree nodes are allowed in this field.

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.

Signature​

readonly kind: Kind;

Type: Kind