"index" | @codefeathers/runtype

Index

Interfaces

literal

Type aliases

NativeTypes

Functions

Object literals

Type aliases

NativeTypes

NativeTypes: { bigint: bigint; boolean: boolean; function: Function; null: null; number: number; object: object; string: string; symbol: symbol; undefined: undefined }

Type declaration

bigint: bigint
boolean: boolean
function: Function
null: null
number: number
object: object
string: string
symbol: symbol
undefined: undefined

Functions

Const F

F(): boolean

- Defined in index.ts:15
Returns boolean

Const T

T(): boolean

- Defined in index.ts:14
Returns boolean

Const literal

literal<T>(y: T): (Anonymous function)

- Defined in index.ts:80
Type parameters
- T: string | number | boolean | object
Parameters
- y: T
Returns (Anonymous function)

Object literals

Const aliases

aliases: object

optional

optional: (Anonymous function) = combiners.maybe

Check whether x satisfies predicate, or is nil

sum

sum: (Anonymous function) = combiners.or

Check whether x satisfies at least one of the predicates

tuple

tuple: (Anonymous function) = combiners.product

Check whether x is a tuple of type defined by fs

union

union: (Anonymous function) = combiners.or

Check whether x satisfies at least one of the predicates

Const always

always: object

F

F: F

Always fail

T

T: T

Always pass

any

any: T = T

Always pass

ignore

ignore: T = T

Always pass

Const combiners

combiners: object

Array

Array<T>(f: T): (Anonymous function)

- Defined in index.ts:199
Check whether all elements of x satisfy predicate

Type parameters
- T: Predicate
Parameters
- f: T
Returns (Anonymous function)

Struct

Struct<Struct>(struct: Struct): (Anonymous function)

- Defined in index.ts:212
Check the structure of an object to match a given predicate

Type parameters
- Struct: AnyStruct
Parameters
- struct: Struct
Returns (Anonymous function)

and

and<Predicates, GuardUnion>(fs: Predicates): (Anonymous function)

- Defined in index.ts:141
Check whether x satisfies all predicates

Type parameters
- Predicates: Predicate[]
- GuardUnion: PredicatesToGuards<Predicates>[number]
Parameters
- fs: Predicates
Returns (Anonymous function)

either

either<T, U>(f: T, g: U): (Anonymous function)

- Defined in index.ts:183
Check whether x satisfies either of two types

Type parameters
- T: Predicate
- U: Predicate
Parameters
- f: T
- g: U
Returns (Anonymous function)

exclude

exclude<T, U>(f: T, g: U): (Anonymous function)

- Defined in index.ts:125
Exclude type represented by g from type represented by f

Type parameters
- T: Predicate
- U: Predicate
Parameters
- f: T
- g: U
Returns (Anonymous function)

maybe

maybe<T>(f: T): (Anonymous function)

- Defined in index.ts:188
Check whether x satisfies predicate, or is nil

Type parameters
- T: Predicate
Parameters
- f: T
Returns (Anonymous function)

not

not<T>(f: T): (Anonymous function)

- Defined in index.ts:121
Checks whether x does not satisfy the predicate WARNING: Type guards will fail with not. Negated types are not supported in TS! See: Negated types https://github.com/Microsoft/TypeScript/pull/29317

Type parameters
- T: Predicate
Parameters
- f: T
Returns (Anonymous function)

or

or<Predicates, GuardUnion>(fs: Predicates): (Anonymous function)

- Defined in index.ts:130
Check whether x satisfies at least one of the predicates

Type parameters
- Predicates: Predicate[]
- GuardUnion: PredicatesToGuards<Predicates>[number]
Parameters
- fs: Predicates
Returns (Anonymous function)

product

product<Predicates, GuardTuple>(fs: Predicates): (Anonymous function)

- Defined in index.ts:152
Check whether x is a product type defined by fs

Type parameters
- Predicates: Tuple<Predicate, 1> | Tuple<Predicate, 2> | Tuple<Predicate, 3> | Tuple<Predicate, 4> | Tuple<Predicate, 5> | Tuple<Predicate, 6> | Tuple<Predicate, 7> | Tuple<Predicate, 8> | Tuple<Predicate, 9> | Tuple<Predicate, 10> | Tuple<Predicate, 11> | Tuple<Predicate, 12> | Tuple<Predicate, 13> | Tuple<Predicate, 14> | Tuple<Predicate, 15>
- GuardTuple: PredicatesToGuards<Predicates>
Parameters
- fs: Predicates
Returns (Anonymous function)

refinement

refinement<T, U>(f: T, g: U): (Anonymous function)

- Defined in index.ts:192
Check whether x satisfies a base type and a refinement

Type parameters
- T: Predicate
- U: Predicate
Parameters
- f: T
- g: U
Returns (Anonymous function)

Const primitives

primitives: object

bool

bool(x: any): x is boolean

- Defined in index.ts:52
Check whether x is a boolean

Parameters
- x: any
Returns x is boolean

nil

nil(x: any): x is Nil

- Defined in index.ts:37
Check whether x is null or undefined

Parameters
- x: any
Returns x is Nil

null

null(x: any): x is null

- Defined in index.ts:40
Check whether x is null

Parameters
- x: any
Returns x is null

number

number(x: any): x is number

- Defined in index.ts:49
Check whether x is a number

Parameters
- x: any
Returns x is number

object

object(x: any): x is object

- Defined in index.ts:58
Check whether x is an object

Parameters
- x: any
Returns x is object

string

string(x: any): x is string

- Defined in index.ts:46
Check whether x is a string

Parameters
- x: any
Returns x is string

symbol

symbol(x: any): x is symbol

- Defined in index.ts:55
Check whether x is a symbol

Parameters
- x: any
Returns x is symbol

undefined

undefined(x: any): x is undefined

- Defined in index.ts:43
Check whether x is undefined

Parameters
- x: any
Returns x is undefined

Const runtime

runtime: object

equals

equals: literal = literal

Literal equality of string, number, boolean, or object

literal

literal: literal

Literal equality of string, number, boolean, or object

is

is<T>(X: T): (Anonymous function)

- Defined in index.ts:93
Check whether x is an instanceof X

Type parameters
- T: AnyConstructor
Parameters
- X: T
Returns (Anonymous function)

stringTag

stringTag<T>(type: T): (Anonymous function)

- Defined in index.ts:106
Check whether x has a [Symbol.toStringTag] value equal to type

Type parameters
- T: string
Parameters
- type: T
Returns (Anonymous function)

type

type<T>(name: T): (Anonymous function)

- Defined in index.ts:102
Check whether x is of type name, which is a possible typeof string, or "null"

Type parameters
- T: keyof NativeTypes
Parameters
- name: T
Returns (Anonymous function)

Index

Interfaces

Type aliases

Functions

Object literals

Type aliases

NativeTypes

Type declaration

bigint: bigint

boolean: boolean

function: Function

null: null

number: number

object: object

string: string

symbol: symbol

undefined: undefined

Functions

Const F

Returns boolean

Const T

Returns boolean

Const literal

Type parameters

T: string | number | boolean | object

Parameters

y: T

Returns (Anonymous function)

Object literals

Const aliases

optional

sum

tuple

union

Const always

F

T

any

ignore

Const combiners

Array

Type parameters

T: Predicate

Parameters

f: T

Returns (Anonymous function)

Struct

Type parameters

Struct: AnyStruct

Parameters

struct: Struct

Returns (Anonymous function)

and

Type parameters

Predicates: Predicate[]

GuardUnion: PredicatesToGuards<Predicates>[number]

Parameters

fs: Predicates

Returns (Anonymous function)

either

Type parameters

T: Predicate

U: Predicate

Parameters

f: T

g: U

Returns (Anonymous function)

exclude

Type parameters

T: Predicate

U: Predicate

Parameters

f: T

g: U

Returns (Anonymous function)

maybe

Type parameters

T: Predicate

Parameters

f: T