ShapeSchema <T>

Type parameters

• T

Hierarchy

• Schema<Required<T>>
• ShapeCriterias<ShapeSchema<T>>
• CommonCriterias<ShapeSchema<T>>
  • ShapeSchema

Index

Methods

• and
• custom
• deprecate
• exact
• never
• notNullable
• notUndefinable
• nullable
• only
• optional
• or
• required
• schema
• state
• transform
• type
• undefinable
• validate
• when
• xor

Methods

and

• and(keys: string[], options?: Options): S

• Inherited from CommonCriterias.and

  Map a list of field names that must be defined alongside this field.

custom

• custom(callback: CriteriaValidator<InferSchemaType<S>>): S

• Inherited from CommonCriterias.custom

  Set a callback to run custom validation logic.

deprecate

• deprecate(message: string): S

• Inherited from CommonCriterias.deprecate

  Set a message to log when this field is present.

exact

• exact(state?: boolean): S

• Inherited from ShapeCriterias.exact

  Require a shape to be an exact. No more and no less of the same properties.

never

• never(options?: Options): ShapeSchema<never>

• Mark that this field should never be used.

notNullable

• notNullable(options?: Options): ShapeSchema<NotNull<T>>

• Disallow null values.

notUndefinable

• notUndefinable(): ShapeSchema<NotUndefined<T>>

• Disallow undefined values. Will fallback to the default value.

nullable

• nullable(): ShapeSchema<null | T>

• Allow and return null values.

only

• only(options?: Options): S

• Inherited from CommonCriterias.only

  Mark that this field can ONLY use a value that matches the default value.

optional

• optional(options?: Options): S

• Inherited from CommonCriterias.optional

  Require this field to NOT be explicitly defined.

or

• or(keys: string[], options?: Options): S

• Inherited from CommonCriterias.or

  Map a list of field names that must have at least 1 defined.

required

• required(options?: Options): S

• Inherited from CommonCriterias.required

  Require this field to be explicitly defined.

schema

• schema(): string

• Inherited from Schema.schema

  The type of schema.

state

• state(): SchemaState<Output>

• Inherited from Schema.state

  The internal state object. Contains useful metadata.

transform

• transform(transformer: Transformer<InferSchemaType<S>>): S

• Inherited from CommonCriterias.transform

  Transform a value before it’s passed to the next criteria.

type

• type(): string

• Inherited from Schema.type

  The type of schema and it’s children (when applicable).

undefinable

• undefinable(): ShapeSchema<undefined | T>

• Allow and return undefined values. Will NOT fallback to the default value.

validate

• validate(value: unknown, path?: string, options?: SchemaValidateOptions<UnknownObject, UnknownObject>): Output

• Inherited from Schema.validate

  Run all validation checks that have been enqueued and return a type casted value. If a value is undefined, inherit the default value, otherwise throw if required. If nullable and the value is null, return early.

when

• when(condition: WhenCondition<InferSchemaType<S>>, pass: AnySchema, fail?: AnySchema): S

• Inherited from CommonCriterias.when

  Validate with another schema when a condition is met.

xor

• xor(keys: string[], options?: Options): S

• Inherited from CommonCriterias.xor

  Map a list of field names that must not be defined alongside this field.