Interface: ChaiExpect

Definido en: fp-api.d.ts:337

Fluent, chai-compatible assertion builder returned by fp.expect(value).

All terminal calls throw AssertionError on failure — typical usage is inside fp.test(name, () => { fp.expect(…).to.equal(…) }).

Propiedades

and

readonly and: ChaiExpect;

Definido en: fp-api.d.ts:352

Connective chain word.

---

at

readonly at: ChaiExpect;

Definido en: fp-api.d.ts:360

Connective chain word.

---

be

readonly be: ChaiExpect;

Definido en: fp-api.d.ts:342

Connective chain word.

---

been

readonly been: ChaiExpect;

Definido en: fp-api.d.ts:344

Connective chain word.

---

contain

contain: ChaiIncludeTerminal;

Definido en: fp-api.d.ts:427

Alias of ChaiExpect.include.

---

deep

readonly deep: ChaiExpect;

Definido en: fp-api.d.ts:367

Switch subsequent equal into deep-structural equality.

---

empty

readonly empty: void;

Definido en: fp-api.d.ts:389

Assert target is an empty string, array or object.

---

exist

readonly exist: void;

Definido en: fp-api.d.ts:377

Assert target is neither null nor undefined.

---

false

readonly false: void;

Definido en: fp-api.d.ts:383

Assert target is strictly false.

---

has

readonly has: ChaiExpect;

Definido en: fp-api.d.ts:354

Connective chain word.

---

have

readonly have: ChaiExpect;

Definido en: fp-api.d.ts:356

Connective chain word.

---

include

include: ChaiIncludeTerminal;

Definido en: fp-api.d.ts:425

Containment check (string substring, array member, or object subset).

---

is

readonly is: ChaiExpect;

Definido en: fp-api.d.ts:346

Connective chain word.

---

nested

readonly nested: ChaiExpect;

Definido en: fp-api.d.ts:370

Switch subsequent property() to dotted-path resolution.

---

not

readonly not: ChaiExpect;

Definido en: fp-api.d.ts:373

Negate the next assertion.

---

null

readonly null: void;

Definido en: fp-api.d.ts:385

Assert target is strictly null.

---

of

readonly of: ChaiExpect;

Definido en: fp-api.d.ts:362

Connective chain word.

---

ok

readonly ok: void;

Definido en: fp-api.d.ts:379

Assert target is truthy.

---

same

readonly same: ChaiExpect;

Definido en: fp-api.d.ts:364

Connective chain word.

---

that

readonly that: ChaiExpect;

Definido en: fp-api.d.ts:348

Connective chain word.

---

to

readonly to: ChaiExpect;

Definido en: fp-api.d.ts:340

Connective chain word.

---

true

readonly true: void;

Definido en: fp-api.d.ts:381

Assert target is strictly true.

---

undefined

readonly undefined: void;

Definido en: fp-api.d.ts:387

Assert target is strictly undefined.

---

which

readonly which: ChaiExpect;

Definido en: fp-api.d.ts:350

Connective chain word.

---

with

readonly with: ChaiExpect;

Definido en: fp-api.d.ts:358

Connective chain word.

Métodos

a()

a(type): void;

Definido en: fp-api.d.ts:408

Assert typeof target matches the given name ("string", "number", "object", "array", "null", …).

Parameters

Parameter	Tipo
type	string

Devuelve

void

---

above()

above(n): void;

Definido en: fp-api.d.ts:434

Assert target > n.

Parameters

Parameter	Tipo
n	number

Devuelve

void

---

an()

an(type): void;

Definido en: fp-api.d.ts:410

Alias of ChaiExpect.a.

Parameters

Parameter	Tipo
type	string

Devuelve

void

---

below()

below(n): void;

Definido en: fp-api.d.ts:438

Assert target < n.

Parameters

Parameter	Tipo
n	number

Devuelve

void

---

closeTo()

closeTo(expected, delta): void;

Definido en: fp-api.d.ts:457

Assert Math.abs(target - expected) <= delta.

Parameters

Parameter	Tipo
expected	number
delta	number

Devuelve

void

---

deepEqual()

deepEqual(expected): void;

Definido en: fp-api.d.ts:401

Deep structural equality.

Parameters

Parameter	Tipo
expected	unknown

Devuelve

void

---

endWith()

endWith(suffix): void;

Definido en: fp-api.d.ts:472

String-only: assert target.endsWith(suffix).

Parameters

Parameter	Tipo
suffix	string

Devuelve

void

---

eq()

eq(expected): void;

Definido en: fp-api.d.ts:397

Alias of ChaiExpect.equal.

Parameters

Parameter	Tipo
expected	unknown

Devuelve

void

---

eql()

eql(expected): void;

Definido en: fp-api.d.ts:399

Deep structural equality.

Parameters

Parameter	Tipo
expected	unknown

Devuelve

void

---

equal()

equal(expected): void;

Definido en: fp-api.d.ts:393

Strict equality (Object.is). Use .deep.equal(…) for deep comparisons.

Parameters

Parameter	Tipo
expected	unknown

Devuelve

void

---

equals()

equals(expected): void;

Definido en: fp-api.d.ts:395

Alias of ChaiExpect.equal.

Parameters

Parameter	Tipo
expected	unknown

Devuelve

void

---

greaterThan()

greaterThan(n): void;

Definido en: fp-api.d.ts:436

Alias of ChaiExpect.above.

Parameters

Parameter	Tipo
n	number

Devuelve

void

---

instanceOf()

instanceOf(ctor): void;

Definido en: fp-api.d.ts:413

Assert target instanceof ctor.

Parameters

Parameter	Tipo
ctor	Function

Devuelve

void

---

keys()

keys(...names): void;

Definido en: fp-api.d.ts:460

Assert target is an object whose keys exactly match the given set.

Parameters

Parameter	Tipo
…names	(string | string[])[]

Devuelve

void

---

least()

least(n): void;

Definido en: fp-api.d.ts:442

Assert target >= n.

Parameters

Parameter	Tipo
n	number

Devuelve

void

---

lengthOf()

lengthOf(n): void;

Definido en: fp-api.d.ts:447

Assert target.length === n.

Parameters

Parameter	Tipo
n	number

Devuelve

void

---

lessThan()

lessThan(n): void;

Definido en: fp-api.d.ts:440

Alias of ChaiExpect.below.

Parameters

Parameter	Tipo
n	number

Devuelve

void

---

match()

match(regex): void;

Definido en: fp-api.d.ts:430

Assert target matches the given regex.

Parameters

Parameter	Tipo
regex	RegExp

Devuelve

void

---

most()

most(n): void;

Definido en: fp-api.d.ts:444

Assert target <= n.

Parameters

Parameter	Tipo
n	number

Devuelve

void

---

oneOf()

oneOf(list): void;

Definido en: fp-api.d.ts:454

Assert target deep-equals one of the candidates.

Parameters

Parameter	Tipo
list	unknown[]

Devuelve

void

---

property()

property(name, value?): void;

Definido en: fp-api.d.ts:422

Assert target has own/inherited property name. If a second argument is given, also assert the property’s value equals it (deep equality).

Chain .nested first to resolve dotted paths (e.g. "a.b.0.c").

Parameters

Parameter	Tipo
name	string
value?	unknown

Devuelve

void

---

satisfy()

satisfy(predicate): void;

Definido en: fp-api.d.ts:451

Pass when predicate(target) returns truthy.

Parameters

Parameter	Tipo
predicate	(value) => boolean

Devuelve

void

---

startWith()

startWith(prefix): void;

Definido en: fp-api.d.ts:470

String-only: assert target.startsWith(prefix).

Parameters

Parameter	Tipo
prefix	string

Devuelve

void

---

throw()

throw(matcher?): void;

Definido en: fp-api.d.ts:467

Assert target is a function that throws. Optionally narrow to a message substring, RegExp match, or error class.

Parameters

Parameter	Tipo
matcher?	string | Function | RegExp

Devuelve

void