Class Type<TBase, TRequired>

constructor

• new Type<TBase, TRequired extends boolean = false>(
      options?: Record<string, unknown>,
  ): Type<TBase, TRequired>

  Type Parameters

  • TBase
  • TRequired extends boolean = false

  Parameters

  • options: Record<string, unknown> = {}

  Returns Type<TBase, TRequired>

OptionaldefaultValue

hasDefault

isSensitive

isVirtual

options

validators

default

• default(
      value: TypeOutput<TBase, TRequired> | () => TypeOutput<TBase, TRequired>,
  ): this

  Configure a default value (or factory) for the field.

  Parameters

  • value: TypeOutput<TBase, TRequired> | () => TypeOutput<TBase, TRequired>

  Returns this

getDefault

• getDefault(): TypeOutput<TBase, TRequired>

  Resolve a configured default for the field, if any.

  Returns TypeOutput<TBase, TRequired>

required

• required<T extends boolean = true>(isRequired?: T): Type<TBase, T>

  Mark the field as required or optional.

  Type Parameters

  • T extends boolean = true

  Parameters

  • isRequired: T = ...

  Returns Type<TBase, T>

sensitive

• sensitive(isSensitive?: boolean): this

  Flag the field as sensitive so joins/exposures can omit it by default.

  Parameters

  • isSensitive: boolean = true

  Returns this

validate

• validate(value: unknown, fieldName?: string): TypeOutput<TBase, TRequired>

  Validate the supplied value and return the normalized result.

  Parameters

  • value: unknown
  • fieldName: string = 'field'

  Returns TypeOutput<TBase, TRequired>

validator

• validator(validator: ValidatorFunction<TBase>): this

  Add a validator function that will receive the normalized value.

  Parameters

  • validator: ValidatorFunction<TBase>

  Returns this