Skip to content

Latest commit

 

History

History
260 lines (157 loc) · 4 KB

structural.md

File metadata and controls

260 lines (157 loc) · 4 KB

@sniptt/guards / structural

Namespace: structural

Table of contents

Functions

Functions

isArray

Const isArray<T, U>(term): term is T[]

Type parameters

Name
T
U

Parameters

Name Type
term U | T[]

Returns

term is T[]

Defined in

guards/structural.ts:17


isDate

Const isDate<U>(term): term is Date

Type parameters

Name
U

Parameters

Name Type
term U | Date

Returns

term is Date

Defined in

guards/structural.ts:41


isFunction

Const isFunction<T, U>(term): term is T

Type parameters

Name Type
T extends Function
U U

Parameters

Name Type
term T | U

Returns

term is T

Defined in

guards/structural.ts:7


isMap

Const isMap<K, V, U>(term): term is Map<K, V>

Type parameters

Name
K
V
U

Parameters

Name Type
term U | Map<K, V>

Returns

term is Map<K, V>

Defined in

guards/structural.ts:21


isNull

Const isNull<T>(term): term is null

Type parameters

Name
T

Parameters

Name Type
term null | T

Returns

term is null

Defined in

guards/structural.ts:3


isObject

Const isObject<T, U>(term): term is NonNullable<T>

Type parameters

Name Type
T extends object
U U

Parameters

Name Type
term T | U

Returns

term is NonNullable<T>

Defined in

guards/structural.ts:11


isSet

Const isSet<T, U>(term): term is Set<T>

Type parameters

Name
T
U

Parameters

Name Type
term U | Set<T>

Returns

term is Set<T>

Defined in

guards/structural.ts:25


isWeakMap

Const isWeakMap<K, V, U>(term): term is WeakMap<K, V>

Type parameters

Name Type
K extends object
V V
U U

Parameters

Name Type
term U | WeakMap<K, V>

Returns

term is WeakMap<K, V>

Defined in

guards/structural.ts:29


isWeakSet

Const isWeakSet<T, U>(term): term is WeakSet<T>

Type parameters

Name Type
T extends object
U U

Parameters

Name Type
term U | WeakSet<T>

Returns

term is WeakSet<T>

Defined in

guards/structural.ts:35