Interface NumberSchema<N, I>

Type Parameters

  • N extends number = number

  • I extends unknown = unknown

Hierarchy

Methods

and array brand default from greaterThan is lessThan nullable optional or read refine

Methods

and

  • Type Parameters

    • T

    Parameters

    Returns Schema<N & T, I>

array

  • Returns Schema<N[], I>

brand

  • Type Parameters

    • K extends string

    Parameters

    • Optional kind: K

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

default

from

  • Parameters

    • value: I

    Returns N

greaterThan

  • Parameters

    • n: number

    Returns NumberSchema<N, I>

is

  • Parameters

    • value: unknown

    Returns value is N

lessThan

  • Parameters

    • n: number

    Returns NumberSchema<N, I>

nullable

  • Returns Schema<null | N, I>

optional

  • Returns Schema<undefined | N, I>

or

  • Type Parameters

    • T

    Parameters

    Returns Schema<N | T, I>

read

  • Parameters

    • input: I

    Returns Result<N, Failure>

refine

  • Type Parameters

    • T extends number

    Parameters

    Returns NumberSchema<T & N, I>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc