InstanceSchema <T>

Type parameters

• T

Hierarchy

• Schema<T>
• CommonCriterias<InstanceSchema<T>>
  • InstanceSchema

Index

Methods

• and
• custom
• deprecate
• never
• notNullable
• notUndefinable
• nullable
• of
• 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.

never

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

• Mark that this field should never be used.

notNullable

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

• Disallow null values.

notUndefinable

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

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

nullable

• nullable(): InstanceSchema<null | T>

• Allow and return null values.

of

• of<C>(ref: Constructor<C>, options?: InstanceOfOptions): InstanceSchema<InferNullable<T, C>>

• Require this field to be an instance of the defined class. When loose is true, will compare using the class name. This should only be used when dealing with realms and package hazards.

  ---

  Type parameters

  • C

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(): InstanceSchema<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.