Interface Schema<O, I>

Type Parameters

  • O extends unknown = unknown

  • I extends unknown = unknown

Hierarchy

Methods

and array brand default from is nullable optional or read refine

Methods

and

  • Type Parameters

    • T

    Parameters

    Returns Schema<O & T, I>

array

  • Returns Schema<O[], I>

brand

  • Type Parameters

    • K extends string

    Parameters

    • Optional kind: K

    Returns Schema<Branded<O, K>, I>

default

  • Parameters

    Returns DefaultSchema<Exclude<O, undefined>, I>

from

  • Parameters

    • value: I

    Returns O

is

  • Parameters

    • value: unknown

    Returns value is O

nullable

  • Returns Schema<null | O, I>

optional

  • Returns Schema<undefined | O, I>

or

  • Type Parameters

    • T

    Parameters

    Returns Schema<O | T, I>

read

  • Parameters

    • input: I

    Returns Result<O, Failure>

refine

  • Type Parameters

    • T extends unknown

    Parameters

    Returns Schema<T, I>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc