Interface Constraint<TOptions, TSchema>

Information about constraint applied to the schema.

Type Parameters

  • out TOptions

    Constraint options type.

  • out TSchema extends UcSchema = UcSchema

    Supported schema type.

Hierarchy

Properties

constraint: UcSchemaConstraint

The constraint to apply.

entry: undefined | string

Constrained schema entry. This may be e.g. a serializer or deserializer name.

undefined for nested schema. This happens e.g. when model processed explicitly rather automatically.

options: TOptions

Constraint options.

processor: UcProcessorName

Name of schema processor that applies the constraint.

schema: TSchema

Constrained schema.

within: undefined | keyof UcFormatPresentations<unknown, UcSchema<unknown>> | keyof UcInsetPresentations<unknown, UcSchema<unknown>>

Schema instance presentation the constraint to is applied within.

Generated using TypeDoc