Superstruct API Reference

Index

Classes

StructError

Interfaces

Type aliases

Variables

struct

Functions

Object literals

Types

Type aliases

Branch

Branch: Array<any>

Failure

Failure: object

Type declaration

[key: string]: any
branch: Branch
path: Path
type: string | undefined
value: any

Path

Path: Array<number | string>

Validator

Validator: function

Type declaration

- (value: any, branch: Branch, path: Path): Partial<Failure>[] | Partial<Failure> | boolean
- Parameters
  - value: any
  - branch: Branch
  - path: Path
  Returns Partial<Failure>[] | Partial<Failure> | boolean

Variables

Const struct

struct: Superstruct = superstruct()

Functions

Const isStruct

isStruct(value: any): boolean

- Defined in struct.ts:14
Parameters
- value: any
Returns boolean

Const superstruct

superstruct(settings?: Partial<SuperstructSettings>): Superstruct

- Defined in superstruct.ts:39
Parameters
- Default value settings: Partial<SuperstructSettings> = {}
Returns Superstruct

Object literals

Const Types

Types: object

any

any(value: any): boolean

- Defined in types.ts:19
Parameters
- value: any
Returns boolean

arguments

arguments(value: any): boolean

- Defined in types.ts:29
Parameters
- value: any
Returns boolean

array

array(value: any): boolean

- Defined in types.ts:39
Parameters
- value: any
Returns boolean

boolean

boolean(value: any): boolean

- Defined in types.ts:50
Parameters
- value: any
Returns boolean

buffer

buffer(value: any): boolean

- Defined in types.ts:60
Parameters
- value: any
Returns boolean

date

date(value: any): boolean

- Defined in types.ts:72
Parameters
- value: any
Returns boolean

error

error(value: any): boolean

- Defined in types.ts:82
Parameters
- value: any
Returns boolean

float32array

float32array(value: any): boolean

- Defined in types.ts:88
Parameters
- value: any
Returns boolean

float64array

float64array(value: any): boolean

- Defined in types.ts:94
Parameters
- value: any
Returns boolean

function

function(value: any): boolean

- Defined in types.ts:105
Parameters
- value: any
Returns boolean

generatorfunction

generatorfunction(value: any): boolean

- Defined in types.ts:115
Parameters
- value: any
Returns boolean

int16array

int16array(value: any): boolean

- Defined in types.ts:121
Parameters
- value: any
Returns boolean

int32array

int32array(value: any): boolean

- Defined in types.ts:127
Parameters
- value: any
Returns boolean

int8array

int8array(value: any): boolean

- Defined in types.ts:133
Parameters
- value: any
Returns boolean

map

map(value: any): boolean

- Defined in types.ts:143
Parameters
- value: any
Returns boolean

null

null(value: any): boolean

- Defined in types.ts:153
Parameters
- value: any
Returns boolean

number

number(value: any): boolean

- Defined in types.ts:163
Parameters
- value: any
Returns boolean

object

object(value: any): boolean

- Defined in types.ts:174
Parameters
- value: any
Returns boolean

promise

promise(value: any): boolean

- Defined in types.ts:184
Parameters
- value: any
Returns boolean

regexp

regexp(value: any): boolean

- Defined in types.ts:194
Parameters
- value: any
Returns boolean

set

set(value: any): boolean

- Defined in types.ts:204
Parameters
- value: any
Returns boolean

string

string(value: any): boolean

- Defined in types.ts:214
Parameters
- value: any
Returns boolean

symbol

symbol(value: any): boolean

- Defined in types.ts:224
Parameters
- value: any
Returns boolean

uint16array

uint16array(value: any): boolean

- Defined in types.ts:230
Parameters
- value: any
Returns boolean

uint32array

uint32array(value: any): boolean

- Defined in types.ts:236
Parameters
- value: any
Returns boolean

uint8array

uint8array(value: any): boolean

- Defined in types.ts:242
Parameters
- value: any
Returns boolean

uint8clampedarray

uint8clampedarray(value: any): boolean

- Defined in types.ts:248
Parameters
- value: any
Returns boolean

undefined

undefined(value: any): boolean

- Defined in types.ts:258
Parameters
- value: any
Returns boolean

weakmap

weakmap(value: any): boolean

- Defined in types.ts:268
Parameters
- value: any
Returns boolean

weakset

weakset(value: any): boolean

- Defined in types.ts:278
Parameters
- value: any
Returns boolean