assertcheck v0.6.0

---

assertcheck / ArrayChecker

Class: ArrayChecker<T>

Defined in: src/checker.ts:104

Chainable assertion wrapper for arrays. Returned by check when the value is an array.

Example

check(users)
  .len(5)
  .uniqueBy("id")
  .all(u => u.verified)
  .sortedBy("name")

Extends

• Checker<T[]>

Type Parameters

Type Parameter	Description
T	The element type of the wrapped array.

Constructors

Constructor

new ArrayChecker<T>(value): ArrayChecker<T>;

Defined in: src/checker.ts:52

Parameters

Parameter	Type
value	T[]

Returns

ArrayChecker<T>

Inherited from

Checker.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
value	readonly	T[]	Checker.value	src/checker.ts:52

Methods

all()

all(predicate, opts?): this;

Defined in: src/checker.ts:131

Parameters

Parameter	Type
predicate	(v) => boolean
opts?	Opts

Returns

this

See

assert.all

---

allInstanceOf()

allInstanceOf<U, TArgs>(ctor, opts?): ArrayChecker<U>;

Defined in: src/checker.ts:231

Type Parameters

Type Parameter
U
TArgs extends unknown[]

Parameters

Parameter	Type
ctor	(...args) => U
opts?	Opts

Returns

ArrayChecker<U>

See

assert.allInstanceOf

---

any()

any(predicate, opts?): this;

Defined in: src/checker.ts:136

Parameters

Parameter	Type
predicate	(v) => boolean
opts?	Opts

Returns

this

See

assert.any

---

containsAll()

containsAll(items, opts?): this;

Defined in: src/checker.ts:191

Parameters

Parameter	Type
items	T[]
opts?	Opts

Returns

this

See

assert.containsAll

---

containsNone()

containsNone(items, opts?): this;

Defined in: src/checker.ts:196

Parameters

Parameter	Type
items	T[]
opts?	Opts

Returns

this

See

assert.containsNone

---

count()

count(
   predicate, 
   n, 
   opts?): this;

Defined in: src/checker.ts:211

Parameters

Parameter	Type
predicate	(v) => boolean
n	number
opts?	Opts

Returns

this

See

assert.count

---

elementsMatch()

elementsMatch(expected, opts?): this;

Defined in: src/checker.ts:186

Parameters

Parameter	Type
expected	T[]
opts?	Opts

Returns

this

See

assert.elementsMatch

---

first()

first(expected, opts?): this;

Defined in: src/checker.ts:171

Parameters

Parameter	Type
expected	T
opts?	Opts

Returns

this

See

assert.first

---

flat()

flat(opts?): this;

Defined in: src/checker.ts:201

Parameters

Parameter	Type
opts?	Opts

Returns

this

See

assert.flat

---

groupedBy()

groupedBy(
   iteratee, 
   expectedGroups, 
   opts?): this;

Defined in: src/checker.ts:206

Parameters

Parameter	Type
iteratee	ValueIteratee<T>
expectedGroups	string[]
opts?	Opts

Returns

this

See

assert.groupedBy

---

includes()

includes(item, opts?): this;

Defined in: src/checker.ts:126

Parameters

Parameter	Type
item	T
opts?	Opts

Returns

this

See

assert.includes

---

increasing()

increasing(this, opts?): ArrayChecker<number>;

Defined in: src/checker.ts:216

Parameters

Parameter	Type
this	ArrayChecker<number>
opts?	Opts

Returns

ArrayChecker<number>

See

assert.increasing

---

last()

last(expected, opts?): this;

Defined in: src/checker.ts:176

Parameters

Parameter	Type
expected	T
opts?	Opts

Returns

this

See

assert.last

---

len()

len(n, opts?): this;

Defined in: src/checker.ts:111

Parameters

Parameter	Type
n	number
opts?	Opts

Returns

this

See

assert.len

---

longerThan()

longerThan(n, opts?): this;

Defined in: src/checker.ts:116

Parameters

Parameter	Type
n	number
opts?	Opts

Returns

this

See

assert.longerThan

---

narrow()

protected narrow<U, A>(fn, ...args): U;

Defined in: src/checker.ts:80

Same as run, but re-types the checker after a narrowing assertion.

Type Parameters

Type Parameter
U
A extends unknown[]

Parameters

Parameter	Type
fn	(v, ...args) => void
...args	A

Returns

U

Inherited from

Checker.narrow

---

nonDecreasing()

nonDecreasing(this, opts?): ArrayChecker<number>;

Defined in: src/checker.ts:221

Parameters

Parameter	Type
this	ArrayChecker<number>
opts?	Opts

Returns

ArrayChecker<number>

See

assert.nonDecreasing

---

none()

none(predicate, opts?): this;

Defined in: src/checker.ts:141

Parameters

Parameter	Type
predicate	(v) => boolean
opts?	Opts

Returns

this

See

assert.none

---

noNils()

noNils(opts?): ArrayChecker<NonNullable<T>>;

Defined in: src/checker.ts:161

Parameters

Parameter	Type
opts?	Opts

Returns

ArrayChecker<NonNullable<T>>

See

assert.noNils

---

notEmpty()

notEmpty(opts?): this;

Defined in: src/checker.ts:106

Parameters

Parameter	Type
opts?	Opts

Returns

this

See

assert.notEmpty

---

one()

one(predicate, opts?): this;

Defined in: src/checker.ts:146

Parameters

Parameter	Type
predicate	(v) => boolean
opts?	Opts

Returns

this

See

assert.one

---

partition()

partition(
   predicate, 
   expectedMatch, 
   expectedRest, 
   opts?): this;

Defined in: src/checker.ts:244

Parameters

Parameter	Type
predicate	(v) => boolean
expectedMatch	number
expectedRest	number
opts?	Opts

Returns

this

See

assert.partition

---

run()

protected run<A>(fn, ...args): this;

Defined in: src/checker.ts:74

Applies an assert.* function to the wrapped value, then returns this for chaining.

Type Parameters

Type Parameter
A extends unknown[]

Parameters

Parameter	Type
fn	(v, ...args) => void
...args	A

Returns

this

Inherited from

Checker.run

---

shorterThan()

shorterThan(n, opts?): this;

Defined in: src/checker.ts:121

Parameters

Parameter	Type
n	number
opts?	Opts

Returns

this

See

assert.shorterThan

---

sortedBy()

sortedBy(iteratee, opts?): this;

Defined in: src/checker.ts:166

Parameters

Parameter	Type
iteratee	ValueIteratee<T>
opts?	Opts

Returns

this

See

assert.sortedBy

---

subset()

subset(sub, opts?): this;

Defined in: src/checker.ts:181

Parameters

Parameter	Type
sub	T[]
opts?	Opts

Returns

this

See

assert.subset

---

sumBy()

sumBy(
   iteratee, 
   expected, 
   opts?): this;

Defined in: src/checker.ts:226

Parameters

Parameter	Type
iteratee	string | ((value) => number)
expected	number
opts?	Opts

Returns

this

See

assert.sumBy

---

tap()

tap(fn): this;

Defined in: src/checker.ts:68

Runs a side-effect function with the wrapped value and returns this to allow chaining. Useful for logging or debugging mid-chain.

Parameters

Parameter	Type	Description
fn	(v) => void	A function that receives the wrapped value.

Returns

this

The current checker instance for chaining.

Example

check(orders)
  .tap(v => console.log("orders:", v))
  .all(o => o.status === "paid")

Inherited from

Checker.tap

---

unique()

unique(opts?): this;

Defined in: src/checker.ts:151

Parameters

Parameter	Type
opts?	Opts

Returns

this

See

assert.unique

---

uniqueBy()

uniqueBy(iteratee, opts?): this;

Defined in: src/checker.ts:156

Parameters

Parameter	Type
iteratee	ValueIteratee<T>
opts?	Opts

Returns

this

See

assert.uniqueBy

---

zippedWith()

zippedWith<B>(
   other, 
   predicate, 
   opts?): this;

Defined in: src/checker.ts:239

Type Parameters

Type Parameter
B

Parameters

Parameter	Type
other	B[]
predicate	(a, b) => boolean
opts?	Opts

Returns

this

See

assert.zippedWith