Class Type<T>

constructor

• new Type<T = unknown>(name: string, options?: Partial<Type<T>>): Type<T>

  Type Parameters

  • T = unknown

  Parameters

  • name: string
  • options: Partial<Type<T>> = {}

  Returns Type<T>

Optional_args

Optional_check

Optional_default

Optional_enumValues

Optional_info

Optional_meta

Optional_object

Optional_optional

Optional_ret

Optional_type

Optional_union

Readonlytype

~standard

• get "~standard"(): any

  Standard Schema V1 compliance property Provides a standard interface for validation and type inference

  Returns any

default

• default(value: T | ((schema?: this) => T)): Type<T>

  Sets a default value for the type, which will be used if the value is not provided The default value can be a function that receives the schema as argument, or a static value.

  Parameters

  • value: T | ((schema?: this) => T)

  Returns Type<T>

describe

• describe(msg: string): Type<T>

  Sets the desc property for the type, which is a human-readable description

  Parameters

  • msg: string

  Returns Type<T>

extend

• extend<O>(
      obj: O,
  ): Type<
      T & Extract<
          {
              [K in string
              | number
              | symbol]: TypeObjectFixOptional<
                  { [K in string
                  | number
                  | symbol]: Infer<O[K]> },
              >[K]
          },
          unknown,
      >,
  >

  Extends the type with an object, merging the properties

  Type Parameters

  • O

  Parameters

  • obj: O

  Returns Type<
      T & Extract<
          {
              [K in string
              | number
              | symbol]: TypeObjectFixOptional<
                  { [K in string
                  | number
                  | symbol]: Infer<O[K]> },
              >[K]
          },
          unknown,
      >,
  >

meta

• meta(meta: TypeMeta): Type<T>

  Props / Metadata for the type, like description or other properties

  Parameters

  • meta: TypeMeta

  Returns Type<T>

omit

• omit<K extends string | number | symbol>(
      keys: Record<K, true>,
  ): Type<Omit<T, K>>

  Omits certain keys from an object schema

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • keys: Record<K, true>

  Returns Type<Omit<T, K>>

optional

• optional(): Type<T | undefined>

  Marks the type as optional, meaning it can be undefined This is useful for properties that are not required.

  Returns Type<T | undefined>

partial

• partial(): Type<Partial<T>>

  Makes some or all properties of an object schema optional

  Returns Type<Partial<T>>

• partial<K extends string | number | symbol>(
      keys: Record<K, true>,
  ): Type<Partial<Pick<T, K>> & Omit<T, K>>

  Makes some or all properties of an object schema optional

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • keys: Record<K, true>

  Returns Type<Partial<Pick<T, K>> & Omit<T, K>>

pick

• pick<K extends string | number | symbol>(
      keys: Record<K, true>,
  ): Type<Pick<T, K>>

  Picks certain keys from an object schema

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • keys: Record<K, true>

  Returns Type<Pick<T, K>>

required

• required(): Type<Required<T>>

  Makes some or all properties of an object schema required

  Returns Type<Required<T>>

• required<K extends string | number | symbol>(
      keys: Record<K, true>,
  ): Type<Required<Pick<T, K>> & Omit<T, K>>

  Makes some or all properties of an object schema required

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • keys: Record<K, true>

  Returns Type<Required<Pick<T, K>> & Omit<T, K>>

validate

• validate(value: any): any

  Validation method for standard-schema compliance

  Parameters

  • value: any

  Returns any