assertcheck v0.5.15

---

assertcheck / check

Function: check()

Call Signature

function check<T>(value): ArrayChecker<T>;

Defined in: src/checker.ts:397

Creates a typed chainable checker for the given value.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
value	T[]	The value to wrap.

Returns

ArrayChecker<T>

A chainable checker instance.

Remarks

TypeScript overloads dispatch the correct checker:

• Arrays → ArrayChecker
• Plain objects → ObjectChecker
• Anything else → Checker

Example

import { check } from "assertcheck"

// Array
check(users)
  .noNils()
  .uniqueBy("id")
  .all(u => u.active)

// Object
check(config)
  .hasKeys(["host", "port"])
  .dig("database.pool.max", 10)

// Scalar
check(amountCents).tap(v => assert.integer(v))

Call Signature

function check<T>(value): ObjectChecker<T>;

Defined in: src/checker.ts:398

Creates a typed chainable checker for the given value.

Type Parameters

Type Parameter
T extends object

Parameters

Parameter	Type	Description
value	T	The value to wrap.

Returns

ObjectChecker<T>

A chainable checker instance.

Remarks

TypeScript overloads dispatch the correct checker:

• Arrays → ArrayChecker
• Plain objects → ObjectChecker
• Anything else → Checker

Example

import { check } from "assertcheck"

// Array
check(users)
  .noNils()
  .uniqueBy("id")
  .all(u => u.active)

// Object
check(config)
  .hasKeys(["host", "port"])
  .dig("database.pool.max", 10)

// Scalar
check(amountCents).tap(v => assert.integer(v))

Call Signature

function check<T>(value): Checker<T>;

Defined in: src/checker.ts:399

Creates a typed chainable checker for the given value.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
value	T	The value to wrap.

Returns

Checker<T>

A chainable checker instance.

Remarks

TypeScript overloads dispatch the correct checker:

• Arrays → ArrayChecker
• Plain objects → ObjectChecker
• Anything else → Checker

Example

import { check } from "assertcheck"

// Array
check(users)
  .noNils()
  .uniqueBy("id")
  .all(u => u.active)

// Object
check(config)
  .hasKeys(["host", "port"])
  .dig("database.pool.max", 10)

// Scalar
check(amountCents).tap(v => assert.integer(v))