API.md

typed-assert

typed-assert

Table of contents

Type aliases

• Assert
• Check
• SubType
• WeakAssert

Functions

• assert
• check
• defaultAssert
• isArray
• isArrayOfType
• isBoolean
• isDate
• isExactly
• isInstanceOf
• isNever
• isNotNull
• isNotUndefined
• isNotVoid
• isNumber
• isOneOf
• isOneOfType
• isOptionOfType
• isPromise
• isRecord
• isRecordOfType
• isRecordWithKeys
• isString
• isUnknown
• safeJsonParse
• setBaseAssert

Type aliases

Assert

Ƭ Assert<Input, Output>: (input: Input, message?: string) => asserts input is SubType<Input, Output>

Type parameters

Name	Type
Input	unknown
Output	Input

Type declaration

▸ (input, message?): asserts input is SubType<Input, Output>

Parameters

Name	Type
input	Input
message?	string

Returns

asserts input is SubType<Input, Output>

Defined in

index.ts:7

---

Check

Ƭ Check<Input, Output>: (input: Input) => input is SubType<Input, Output>

Type parameters

Name	Type
Input	unknown
Output	Input

Type declaration

▸ (input): input is SubType<Input, Output>

Parameters

Name	Type
input	Input

Returns

input is SubType<Input, Output>

Defined in

index.ts:12

---

SubType

Ƭ SubType<Input, Output>: Output extends Input ? Output : never

Type parameters

Name
Input
Output

Defined in

index.ts:5

---

WeakAssert

Ƭ WeakAssert: (input: unknown, message?: string) => void

Type declaration

▸ (input, message?): void

Parameters

Name	Type
input	unknown
message?	string

Returns

void

Defined in

index.ts:3

Functions

assert

▸ Const assert(input, message?): asserts input is true

Parameters

Name	Type
input	boolean
message?	string

Returns

asserts input is true

Defined in

index.ts:24

---

check

▸ check<Input, Output>(assertT): Check<Input, Output>

Type parameters

Name
Input
Output

Parameters

Name	Type
assertT	Assert<Input, Output>

Returns

Check<Input, Output>

Defined in

index.ts:209

---

defaultAssert

▸ Const defaultAssert(input, message?): void

Parameters

Name	Type
input	unknown
message?	string

Returns

void

Defined in

index.ts:16

---

isArray

▸ isArray(input, message?): asserts input is unknown[]

Parameters

Name	Type
input	unknown
message	string

Returns

asserts input is unknown[]

Defined in

index.ts:128

---

isArrayOfType

▸ isArrayOfType<T>(input, assertT, message?, itemMessage?): asserts input is T[]

Type parameters

Name
T

Parameters

Name	Type
input	unknown
assertT	Assert<unknown, T>
message	string
itemMessage	string

Returns

asserts input is T[]

Defined in

index.ts:147

---

isBoolean

▸ isBoolean(input, message?): asserts input is boolean

Parameters

Name	Type
input	unknown
message	string

Returns

asserts input is boolean

Defined in

index.ts:76

---

isDate

▸ isDate(input, message?): asserts input is Date

Parameters

Name	Type
input	unknown
message	string

Returns

asserts input is Date

Defined in

index.ts:97

---

isExactly

▸ isExactly<Input, Output>(input, value, message?): asserts input is SubType<Input, Output>

Type parameters

Name
Input
Output

Parameters

Name	Type
input	Input
value	Output
message	string

Returns

asserts input is SubType<Input, Output>

Defined in

index.ts:68

---

isInstanceOf

▸ isInstanceOf<T>(input, constructor, message?): asserts input is T

Type parameters

Name
T

Parameters

Name	Type
input	unknown
constructor	(...args: any[]) => T
message	string

Returns

asserts input is T

Defined in

index.ts:193

---

isNever

▸ isNever(_input, message?): never

Parameters

Name	Type
_input	never
message	string

Returns

never

Defined in

index.ts:40

---

isNotNull

▸ isNotNull<T>(input, message?): asserts input is T

Type parameters

Name
T

Parameters

Name	Type
input	null | T
message	string

Returns

asserts input is T

Defined in

index.ts:47

---

isNotUndefined

▸ isNotUndefined<T>(input, message?): asserts input is T

Type parameters

Name
T

Parameters

Name	Type
input	undefined | T
message	string

Returns

asserts input is T

Defined in

index.ts:54

---

isNotVoid

▸ isNotVoid<T>(input, message?): asserts input is Exclude<T, undefined | null | void>

Type parameters

Name
T

Parameters

Name	Type
input	T
message	string

Returns

asserts input is Exclude<T, undefined | null | void>

Defined in

index.ts:61

---

isNumber

▸ isNumber(input, message?): asserts input is number

Parameters

Name	Type
input	unknown
message	string

Returns

asserts input is number

Defined in

index.ts:83

---

isOneOf

▸ isOneOf<Input, Output>(input, values, message?): asserts input is SubType<Input, Output>

Type parameters

Name
Input
Output

Parameters

Name	Type
input	Input
values	readonly Output[]
message	string

Returns

asserts input is SubType<Input, Output>

Defined in

index.ts:170

---

isOneOfType

▸ isOneOfType<T>(input, assertT, message?, itemMessage?): asserts input is T

Type parameters

Name
T

Parameters

Name	Type
input	unknown
assertT	Assert<unknown, T>[]
message	string
itemMessage?	string

Returns

asserts input is T

Defined in

index.ts:178

---

isOptionOfType

▸ isOptionOfType<Input, Output>(input, assertT, message?): asserts input is SubType<Input, undefined> | SubType<Input, Output>

Type parameters

Name
Input
Output

Parameters

Name	Type
input	undefined | Input
assertT	Assert<Input, Output>
message	string

Returns

asserts input is SubType<Input, undefined> | SubType<Input, Output>

Defined in

index.ts:159

---

isPromise

▸ isPromise(input, message?): asserts input is Promise<unknown>

Parameters

Name	Type
input	unknown
message	string

Returns

asserts input is Promise<unknown>

Defined in

index.ts:202

---

isRecord

▸ isRecord(input, message?): asserts input is Record<string, unknown>

Parameters

Name	Type
input	unknown
message	string

Returns

asserts input is Record<string, unknown>

Defined in

index.ts:104

---

isRecordOfType

▸ isRecordOfType<T>(input, assertT, message?, itemMessage?): asserts input is Record<string, T>

Type parameters

Name
T

Parameters

Name	Type
input	unknown
assertT	Assert<unknown, T>
message	string
itemMessage	string

Returns

asserts input is Record<string, T>

Defined in

index.ts:135

---

isRecordWithKeys

▸ isRecordWithKeys<K>(input, keys, message?): asserts input is { readonly [Key in string]: unknown }

Type parameters

Name	Type
K	extends string

Parameters

Name	Type
input	unknown
keys	K[]
message	string

Returns

asserts input is { readonly [Key in string]: unknown }

Defined in

index.ts:115

---

isString

▸ isString(input, message?): asserts input is string

Parameters

Name	Type
input	unknown
message	string

Returns

asserts input is string

Defined in

index.ts:90

---

isUnknown

▸ isUnknown(_input): _input is unknown

Parameters

Name	Type
_input	unknown

Returns

_input is unknown

Defined in

index.ts:36

---

safeJsonParse

▸ Const safeJsonParse(json): unknown

Parameters

Name	Type
json	string

Returns

unknown

Defined in

index.ts:33

---

setBaseAssert

▸ setBaseAssert(assert?): void

Parameters

Name	Type
assert?	WeakAssert

Returns

void

Defined in

index.ts:27