Class Struct<T, S>

constructor

• new Struct<T = unknown, S = unknown>(
      props: {
          coercer?: Coercer<unknown>;
          entries?: (
              value: unknown,
              context: Context,
          ) => Iterable<
              [
                  string
                  | number,
                  unknown,
                  Struct<any, unknown> | Struct<never, unknown>,
              ],
          >;
          refiner?: Refiner<T>;
          schema: S;
          type: string;
          validator?: Validator;
      },
  ): Struct<T, S>

  Type Parameters

  • T = unknown
  • S = unknown

  Parameters

  • props: {
        coercer?: Coercer<unknown>;
        entries?: (
            value: unknown,
            context: Context,
        ) => Iterable<
            [
                string
                | number,
                unknown,
                Struct<any, unknown> | Struct<never, unknown>,
            ],
        >;
        refiner?: Refiner<T>;
        schema: S;
        type: string;
        validator?: Validator;
    }

  Returns Struct<T, S>

coercer

entries

refiner

schema

type

ReadonlyTYPE

validator

assert

• assert(value: unknown, message?: string): asserts value is T

  Assert that a value passes the struct's validation, throwing if it doesn't.

  Parameters

  • value: unknown
  • Optionalmessage: string

  Returns asserts value is T

create

• create(value: unknown, message?: string): T

  Create a value with the struct's coercion logic, then validate it.

  Parameters

  • value: unknown
  • Optionalmessage: string

  Returns T

is

• is(value: unknown): value is T

  Check if a value passes the struct's validation.

  Parameters

  • value: unknown

  Returns value is T

mask

• mask(value: unknown, message?: string): T

  Mask a value, coercing and validating it, but returning only the subset of properties defined by the struct's schema. Masking applies recursively to props of object structs only.

  Parameters

  • value: unknown
  • Optionalmessage: string

  Returns T

validate

• validate(
      value: unknown,
      options?: { coerce?: boolean; mask?: boolean; message?: string },
  ): [StructError, undefined] | [undefined, T]

  Validate a value with the struct's validation logic, returning a tuple representing the result.

  You may optionally pass true for the coerce argument to coerce the value before attempting to validate it. If you do, the result will contain the coerced result when successful. Also, mask will turn on masking of the unknown object props recursively if passed.

  Parameters

  • value: unknown
  • Optionaloptions: { coerce?: boolean; mask?: boolean; message?: string }

  Returns [StructError, undefined] | [undefined, T]