CommonCriterias <S>

Type parameters

• S

Hierarchy

• CommonCriterias
  • ArraySchema
  • BooleanSchema
  • CustomSchema
  • DateSchema
  • FunctionSchema
  • InstanceSchema
  • NumberSchema
  • ObjectSchema
  • ShapeSchema
  • StringSchema
  • TupleSchema
  • UnionSchema

Index

Methods

• and
• custom
• deprecate
• only
• optional
• or
• required
• transform
• when
• xor

Methods

and

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

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

custom

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

• Set a callback to run custom validation logic.

deprecate

• deprecate(message: string): S

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

only

• only(options?: Options): S

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

optional

• optional(options?: Options): S

• Require this field to NOT be explicitly defined.

or

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

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

required

• required(options?: Options): S

• Require this field to be explicitly defined.

transform

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

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

when

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

• Validate with another schema when a condition is met.

xor

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

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