commonCriteria

Index

Functions

• and
• custom
• deprecate
• never
• notNullable
• notUndefinable
• nullable
• only
• optional
• or
• required
• transform
• undefinable
• when
• xor

Functions

and

• and<T>(state: SchemaState<T>, keys: string[], options?: Options): Criteria<T>

• Map a list of field names that must be defined alongside this field when in a shape/object.

  ---

  Type parameters

  • T

custom

• custom<T>(state: SchemaState<T>, validator: CriteriaValidator<T>): Criteria<T>

• Set a callback to run custom validation logic.

  ---

  Type parameters

  • T

deprecate

• deprecate<T>(state: SchemaState<T>, message: string): void

• Set a message to log when this field is present.

  ---

  Type parameters

  • T

never

• never<T>(state: SchemaState<T>, options?: Options): void

• Mark that this field should never be used.

  ---

  Type parameters

  • T

notNullable

• notNullable<T>(state: SchemaState<T>, options?: Options): void

• Disallow null values.

  ---

  Type parameters

  • T

notUndefinable

• notUndefinable<T>(state: SchemaState<T>): void

• Disallow undefined values.

  ---

  Type parameters

  • T

nullable

• nullable<T>(state: SchemaState<T>): void

• Allow null values.

  ---

  Type parameters

  • T

only

• only<T>(state: SchemaState<T>, options?: Options): Criteria<T>

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

  ---

  Type parameters

  • T

optional

• optional<T>(state: SchemaState<T>): void

• Dont require this field to be explicitly defined when in a shape/object.

  ---

  Type parameters

  • T

or

• or<T>(state: SchemaState<T>, keys: string[], options?: Options): Criteria<T>

• Map a list of field names that must have at least 1 defined when in a shape/object.

  ---

  Type parameters

  • T

required

• required<T>(state: SchemaState<T>, options?: Options): void

• Require this field to be explicitly defined when in a shape/object.

  ---

  Type parameters

  • T

transform

• transform<T>(state: SchemaState<T>, transformer: Transformer<T>): Criteria<T>

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

  ---

  Type parameters

  • T

undefinable

• undefinable<T>(state: SchemaState<T>): void

• Allow undefined values.

  ---

  Type parameters

  • T

when

• when<T>(state: SchemaState<T>, condition: T | ValueComparator<T>, pass: Schema<T>, fail?: Schema<T>): Criteria<T>

• Validate with another schema when a condition is met.

  ---

  Type parameters

  • T

xor

• xor<T>(state: SchemaState<T>, keys: string[], options?: Options): Criteria<T>

• Map a list of field names that must not be defined alongside this field when in a shape/object.

  ---

  Type parameters

  • T