tyneq

---

tyneq / ArgumentUtility

Class: ArgumentUtility

Defined in: src/utility/ArgumentUtility.ts:30

Facade for all argument validation guards.

Every method accepts either a single-property object ({ count }) - where the property name becomes the error message's parameter name - or a raw value with an explicit paramName string. Prefer the object form; the name is inferred automatically via nameof.

Example

import { ArgumentUtility } from "tyneq/utility";

function take(count: number) {
    ArgumentUtility.checkNonNegative({ count });   // throws ArgumentOutOfRangeError if count < 0
    ArgumentUtility.checkInteger({ count });       // throws ArgumentError if count is not an integer
}

Methods

checkNotNull()

Call Signature

static checkNotNull<T>(param): asserts param is Record<string, T>

Defined in: src/utility/ArgumentUtility.ts:34

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Record<string, Nullable<T>>

Returns

asserts param is Record<string, T>

Call Signature

static checkNotNull<T>(param, paramName): asserts param is T

Defined in: src/utility/ArgumentUtility.ts:35

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Nullable<T>
paramName	string

Returns

asserts param is T

---

checkNotUndefined()

Call Signature

static checkNotUndefined<T>(param): asserts param is Record<string, T>

Defined in: src/utility/ArgumentUtility.ts:42

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Record<string, Maybe<T>>

Returns

asserts param is Record<string, T>

Call Signature

static checkNotUndefined<T>(param, paramName): asserts param is T

Defined in: src/utility/ArgumentUtility.ts:43

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Maybe<T>
paramName	string

Returns

asserts param is T

---

checkNotOptional()

Call Signature

static checkNotOptional<T>(param): asserts param is Record<string, T>

Defined in: src/utility/ArgumentUtility.ts:50

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Record<string, Optional<T>>

Returns

asserts param is Record<string, T>

Call Signature

static checkNotOptional<T>(param, paramName): asserts param is T

Defined in: src/utility/ArgumentUtility.ts:51

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Optional<T>
paramName	string

Returns

asserts param is T

---

checkNotNullOrEmpty()

Call Signature

static checkNotNullOrEmpty<T>(param): asserts param is Record<string, T>

Defined in: src/utility/ArgumentUtility.ts:58

Type Parameters

Type Parameter
T extends HasLength

Parameters

Parameter	Type
param	Record<string, Nullable<T>>

Returns

asserts param is Record<string, T>

Call Signature

static checkNotNullOrEmpty<T>(param, paramName): asserts param is T

Defined in: src/utility/ArgumentUtility.ts:59

Type Parameters

Type Parameter
T extends HasLength

Parameters

Parameter	Type
param	Nullable<T>
paramName	string

Returns

asserts param is T

---

checkNotOptionalOrEmpty()

Call Signature

static checkNotOptionalOrEmpty<T>(param): asserts param is Record<string, T>

Defined in: src/utility/ArgumentUtility.ts:66

Type Parameters

Type Parameter
T extends HasLength

Parameters

Parameter	Type
param	Record<string, Optional<T>>

Returns

asserts param is Record<string, T>

Call Signature

static checkNotOptionalOrEmpty<T>(param, paramName): asserts param is T

Defined in: src/utility/ArgumentUtility.ts:67

Type Parameters

Type Parameter
T extends HasLength

Parameters

Parameter	Type
param	Optional<T>
paramName	string

Returns

asserts param is T

---

checkNotNullOrWhiteSpace()

Call Signature

static checkNotNullOrWhiteSpace(param): asserts param is Record<string, string>

Defined in: src/utility/ArgumentUtility.ts:74

Parameters

Parameter	Type
param	Record<string, Optional<string>>

Returns

asserts param is Record<string, string>

Call Signature

static checkNotNullOrWhiteSpace(param, paramName): asserts param is string

Defined in: src/utility/ArgumentUtility.ts:75

Parameters

Parameter	Type
param	Optional<string>
paramName	string

Returns

asserts param is string

---

checkNonNegative()

Call Signature

static checkNonNegative(param): void

Defined in: src/utility/ArgumentUtility.ts:82

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkNonNegative(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:83

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkPositive()

Call Signature

static checkPositive(param): void

Defined in: src/utility/ArgumentUtility.ts:90

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkPositive(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:91

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkNegative()

Call Signature

static checkNegative(param): void

Defined in: src/utility/ArgumentUtility.ts:98

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkNegative(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:99

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkNonPositive()

Call Signature

static checkNonPositive(param): void

Defined in: src/utility/ArgumentUtility.ts:106

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkNonPositive(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:107

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkInRange()

Call Signature

static checkInRange(param, min, max): void

Defined in: src/utility/ArgumentUtility.ts:114

Parameters

Parameter	Type
param	Record<string, number>
min	number
max	number

Returns

void

Call Signature

static checkInRange(param, min, max, paramName): void

Defined in: src/utility/ArgumentUtility.ts:115

Parameters

Parameter	Type
param	number
min	number
max	number
paramName	string

Returns

void

---

checkInteger()

Call Signature

static checkInteger(param): void

Defined in: src/utility/ArgumentUtility.ts:122

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkInteger(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:123

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkFinite()

Call Signature

static checkFinite(param): void

Defined in: src/utility/ArgumentUtility.ts:130

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkFinite(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:131

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkNotNaN()

Call Signature

static checkNotNaN(param): void

Defined in: src/utility/ArgumentUtility.ts:138

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkNotNaN(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:139

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkSafeInteger()

Call Signature

static checkSafeInteger(param): void

Defined in: src/utility/ArgumentUtility.ts:146

Parameters

Parameter	Type
param	Record<string, number>

Returns

void

Call Signature

static checkSafeInteger(param, paramName): void

Defined in: src/utility/ArgumentUtility.ts:147

Parameters

Parameter	Type
param	number
paramName	string

Returns

void

---

checkArrayIndex()

Call Signature

static checkArrayIndex(param, arrayLength?): void

Defined in: src/utility/ArgumentUtility.ts:154

Parameters

Parameter	Type
param	Record<string, number>
arrayLength?	number

Returns

void

Call Signature

static checkArrayIndex(param, paramName, arrayLength?): void

Defined in: src/utility/ArgumentUtility.ts:155

Parameters

Parameter	Type
param	number
paramName	string
arrayLength?	number

Returns

void

---

checkFunction()

Call Signature

static checkFunction(param): asserts param is Record<string, Function>

Defined in: src/utility/ArgumentUtility.ts:171

Parameters

Parameter	Type
param	Record<string, unknown>

Returns

asserts param is Record<string, Function>

Call Signature

static checkFunction(param, paramName): asserts param is Function

Defined in: src/utility/ArgumentUtility.ts:173

Parameters

Parameter	Type
param	unknown
paramName	string

Returns

asserts param is Function

---

checkIterable()

Call Signature

static checkIterable<T>(param): asserts param is Record<string, Iterable<T, any, any>>

Defined in: src/utility/ArgumentUtility.ts:180

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	Record<string, unknown>

Returns

asserts param is Record<string, Iterable<T, any, any>>

Call Signature

static checkIterable<T>(param, paramName): asserts param is Iterable<T, any, any>

Defined in: src/utility/ArgumentUtility.ts:181

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	unknown
paramName	string

Returns

asserts param is Iterable<T, any, any>

---

checkIterator()

Call Signature

static checkIterator<T>(param): asserts param is Record<string, Iterator<T, any, any>>

Defined in: src/utility/ArgumentUtility.ts:188

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	Record<string, unknown>

Returns

asserts param is Record<string, Iterator<T, any, any>>

Call Signature

static checkIterator<T>(param, paramName): asserts param is Iterator<T, any, any>

Defined in: src/utility/ArgumentUtility.ts:189

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	unknown
paramName	string

Returns

asserts param is Iterator<T, any, any>

---

checkEnumerable()

Call Signature

static checkEnumerable<T>(param): asserts param is Record<string, Enumerable<T>>

Defined in: src/utility/ArgumentUtility.ts:196

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	Record<string, unknown>

Returns

asserts param is Record<string, Enumerable<T>>

Call Signature

static checkEnumerable<T>(param, paramName): asserts param is Enumerable<T>

Defined in: src/utility/ArgumentUtility.ts:197

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	unknown
paramName	string

Returns

asserts param is Enumerable<T>

---

checkEnumerator()

Call Signature

static checkEnumerator<T>(param): asserts param is Record<string, Enumerator<T>>

Defined in: src/utility/ArgumentUtility.ts:204

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	Record<string, unknown>

Returns

asserts param is Record<string, Enumerator<T>>

Call Signature

static checkEnumerator<T>(param, paramName): asserts param is Enumerator<T>

Defined in: src/utility/ArgumentUtility.ts:205

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
param	unknown
paramName	string

Returns

asserts param is Enumerator<T>

---

checkInstanceOf()

Call Signature

static checkInstanceOf<T>(param, constructor): asserts param is Record<string, T>

Defined in: src/utility/ArgumentUtility.ts:212

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Record<string, unknown>
constructor	(...args) => T

Returns

asserts param is Record<string, T>

Call Signature

static checkInstanceOf<T>(param, constructor, paramName): asserts param is T

Defined in: src/utility/ArgumentUtility.ts:216

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	unknown
constructor	(...args) => T
paramName	string

Returns

asserts param is T

---

checkHasLength()

Call Signature

static checkHasLength(param): asserts param is Record<string, HasLength>

Defined in: src/utility/ArgumentUtility.ts:231

Parameters

Parameter	Type
param	Record<string, unknown>

Returns

asserts param is Record<string, HasLength>

Call Signature

static checkHasLength(param, paramName): asserts param is HasLength

Defined in: src/utility/ArgumentUtility.ts:232

Parameters

Parameter	Type
param	unknown
paramName	string

Returns

asserts param is HasLength

---

check()

Call Signature

static check<T>(param, predicate, message): void

Defined in: src/utility/ArgumentUtility.ts:239

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	Record<string, T>
predicate	(v) => boolean
message	string

Returns

void

Call Signature

static check<T>(param, paramName, predicate, message): void

Defined in: src/utility/ArgumentUtility.ts:244

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
param	T
paramName	string
predicate	(v) => boolean
message	string

Returns

void