Ow | ow

Hierarchy

Callable

__call<T>(value: T, predicate: BasePredicate<T>): void
__call<T>(value: T, label: string, predicate: BasePredicate<T>): void

- Defined in index.ts:20
Test if the value matches the predicate. Throws an ArgumentError if the test fails.

Type parameters
- T
Parameters
- value: T
  
  Value to test.
- predicate: BasePredicate<T>
  
  Predicate to test against.
Returns void
- Defined in index.ts:27
Test if value matches the provided predicate. Throws an ArgumentError with the specified label if the test fails.

Type parameters
- T
Parameters
- value: T
  
  Value to test.
- label: string
  
  Label which should be used in error messages.
- predicate: BasePredicate<T>
  
  Predicate to test against.
Returns void

Index

Properties

Methods

Properties

array

array: ArrayPredicate

Test the value to be an array.

arrayBuffer

arrayBuffer: Predicate<ArrayBuffer>

Test the value to be a ArrayBuffer.

boolean

boolean: BooleanPredicate

Test the value to be a boolean.

buffer

buffer: Predicate<Buffer>

Test the value to be a Buffer.

dataView

dataView: Predicate<DataView>

Test the value to be a DataView.

date

date: DatePredicate

Test the value to be a Date.

error

error: ErrorPredicate

Test the value to be an Error.

float32Array

float32Array: Predicate<Float32Array>

Test the value to be a Float32Array.

float64Array

float64Array: Predicate<Float64Array>

Test the value to be a Float64Array.

function

function: Predicate<Function>

Test the value to be a Function.

int16Array

int16Array: Predicate<Int16Array>

Test the value to be a Int16Array.

int32Array

int32Array: Predicate<Int32Array>

Test the value to be a Int32Array.

int8Array

int8Array: Predicate<Int8Array>

Test the value to be a Int8Array.

iterable

iterable: Predicate<Iterable<any>>

Test the value to be Iterable.

map

map: MapPredicate

Test the value to be a Map.

nan

nan: Predicate<number>

Test the value to be not a number.

null

null: Predicate<null>

Test the value to be null.

nullOrUndefined

nullOrUndefined: Predicate<null | undefined>

Test the value to be null or undefined.

number

number: NumberPredicate

Test the value to be a number.

object

object: ObjectPredicate

Test the value to be an object.

promise

promise: Predicate<Promise<any>>

Test the value to be a Promise.

regExp

regExp: Predicate<RegExp>

Test the value to be a RegExp.

set

set: SetPredicate

Test the value to be a Set.

string

string: StringPredicate

Test the value to be a string.

symbol

symbol: Predicate<Symbol>

Test the value to be a Symbol.

typedArray

typedArray: Predicate<TypedArray>

Test the value to be a typed array.

uint16Array

uint16Array: Predicate<Uint16Array>

Test the value to be a Uint16Array.

uint32Array

uint32Array: Predicate<Uint32Array>

Test the value to be a Uint32Array.

uint8Array

uint8Array: Predicate<Uint8Array>

Test the value to be a Uint8Array.

uint8ClampedArray

uint8ClampedArray: Predicate<Uint8ClampedArray>

Test the value to be a Uint8ClampedArray.

undefined

undefined: Predicate<undefined>

Test the value to be undefined.

weakMap

weakMap: WeakMapPredicate

Test the value to be a WeakMap.

weakSet

weakSet: WeakSetPredicate

Test the value to be a WeakSet.

Methods

any

any<T1>(p1: BasePredicate<T1>): AnyPredicate<T1>
any<T1, T2>(p1: BasePredicate<T1>, p2: BasePredicate<T2>): AnyPredicate<T1 | T2>
any<T1, T2, T3>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>): AnyPredicate<T1 | T2 | T3>
any<T1, T2, T3, T4>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>): AnyPredicate<T1 | T2 | T3 | T4>
any<T1, T2, T3, T4, T5>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>): AnyPredicate<T1 | T2 | T3 | T4 | T5>
any<T1, T2, T3, T4, T5, T6>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>): AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6>
any<T1, T2, T3, T4, T5, T6, T7>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>): AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7>
any<T1, T2, T3, T4, T5, T6, T7, T8>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>, p8: BasePredicate<T8>): AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8>
any<T1, T2, T3, T4, T5, T6, T7, T8, T9>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>, p8: BasePredicate<T8>, p9: BasePredicate<T9>): AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9>
any<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(p1: BasePredicate<T1>, p2: BasePredicate<T2>, p3: BasePredicate<T3>, p4: BasePredicate<T4>, p5: BasePredicate<T5>, p6: BasePredicate<T6>, p7: BasePredicate<T7>, p8: BasePredicate<T8>, p9: BasePredicate<T9>, p10: BasePredicate<T10>): AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10>
any(...predicate: BasePredicate[]): AnyPredicate

- Defined in index.ts:191
Test that the value matches at least one of the given predicates.

Type parameters
- T1
Parameters
- p1: BasePredicate<T1>
Returns AnyPredicate<T1>
- Defined in index.ts:192
Type parameters
- T1
- T2
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
Returns AnyPredicate<T1 | T2>
- Defined in index.ts:193
Type parameters
- T1
- T2
- T3
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
Returns AnyPredicate<T1 | T2 | T3>
- Defined in index.ts:194
Type parameters
- T1
- T2
- T3
- T4
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
- p4: BasePredicate<T4>
Returns AnyPredicate<T1 | T2 | T3 | T4>
- Defined in index.ts:195
Type parameters
- T1
- T2
- T3
- T4
- T5
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
- p4: BasePredicate<T4>
- p5: BasePredicate<T5>
Returns AnyPredicate<T1 | T2 | T3 | T4 | T5>
- Defined in index.ts:196
Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
- p4: BasePredicate<T4>
- p5: BasePredicate<T5>
- p6: BasePredicate<T6>
Returns AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6>
- Defined in index.ts:197
Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
- p4: BasePredicate<T4>
- p5: BasePredicate<T5>
- p6: BasePredicate<T6>
- p7: BasePredicate<T7>
Returns AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7>
- Defined in index.ts:198
Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
- p4: BasePredicate<T4>
- p5: BasePredicate<T5>
- p6: BasePredicate<T6>
- p7: BasePredicate<T7>
- p8: BasePredicate<T8>
Returns AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8>
- Defined in index.ts:199
Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
- T9
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
- p4: BasePredicate<T4>
- p5: BasePredicate<T5>
- p6: BasePredicate<T6>
- p7: BasePredicate<T7>
- p8: BasePredicate<T8>
- p9: BasePredicate<T9>
Returns AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9>
- Defined in index.ts:200
Type parameters
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
- T9
- T10
Parameters
- p1: BasePredicate<T1>
- p2: BasePredicate<T2>
- p3: BasePredicate<T3>
- p4: BasePredicate<T4>
- p5: BasePredicate<T5>
- p6: BasePredicate<T6>
- p7: BasePredicate<T7>
- p8: BasePredicate<T8>
- p9: BasePredicate<T9>
- p10: BasePredicate<T10>
Returns AnyPredicate<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10>
- Defined in index.ts:201
Parameters
- Rest ...predicate: BasePredicate[]
Returns AnyPredicate

create

create<T>(predicate: BasePredicate<T>): function
create<T>(label: string, predicate: BasePredicate<T>): function

- Defined in index.ts:180
Create a reusable validator.

Type parameters
- T
Parameters
- predicate: BasePredicate<T>
  
  Predicate used in the validator function.
Returns function
- - (value: T): void
  - Parameters
    - value: T
    Returns void
- Defined in index.ts:187
Create a reusable validator.

Type parameters
- T
Parameters
- label: string
  
  Label which should be used in error messages.
- predicate: BasePredicate<T>
  
  Predicate used in the validator function.
Returns function
- - (value: T): void
  - Parameters
    - value: T
    Returns void

isValid

isValid<T>(value: T, predicate: BasePredicate<T>): boolean

- Defined in index.ts:174
Returns true if the value matches the predicate, otherwise returns false.

Type parameters
- T
Parameters
- value: T
  
  Value to test.
- predicate: BasePredicate<T>
  
  Predicate to test against.
Returns boolean

Hierarchy

Callable

Type parameters

T

Parameters

value: T

predicate: BasePredicate<T>

Returns void

Type parameters

T

Parameters

value: T

label: string

predicate: BasePredicate<T>

Returns void

Index

Properties

Methods

Properties

array

arrayBuffer

boolean

buffer

dataView

date

error

float32Array

float64Array

function

int16Array

int32Array

int8Array

iterable

map

nan

null

nullOrUndefined

number

object

promise

regExp

set

string

symbol

typedArray

uint16Array

uint32Array

uint8Array

uint8ClampedArray

undefined

weakMap

weakSet

Methods

any

Type parameters

T1

Parameters

p1: BasePredicate<T1>

Returns AnyPredicate<T1>

Type parameters

T1

T2

Parameters

p1: BasePredicate<T1>

p2: BasePredicate<T2>

Returns AnyPredicate<T1 | T2>

Type parameters

T1

T2

T3

Parameters

p1: BasePredicate<T1>

p2: BasePredicate<T2>

p3: BasePredicate<T3>

Returns AnyPredicate<T1 | T2 | T3>

Type parameters

T1

T2

T3

T4