@types/code

property column

column: string;

property filename

filename: string;

property line

line: string;

property not

not: AssertionChain<T>;

• Inverses the expected result of any assertion

property once

once: AssertionChain<T>;

• Requires that inclusion matches appear only once in the provided value. Used by include().

property only

only: AssertionChain<T>;

• Requires that only the provided elements appear in the provided value. Used by include().

property part

part: AssertionChain<T>;

• Allows a partial match when asserting inclusion Used by include(). Defaults to false.

property shallow

shallow: AssertionChain<T>;

• Performs a comparison using strict equality (===). Code defaults to deep comparison. Used by equal() and include().

property a

a: AssertionChain<T>;

• Connecting word.

property an

an: AssertionChain<T>;

• Connecting word.

property and

and: AssertionChain<T>;

• Connecting word.

property at

at: AssertionChain<T>;

• Connecting word.

property be

be: AssertionChain<T>;

• Connecting word.

property have

have: AssertionChain<T>;

• Connecting word.

property in

in: AssertionChain<T>;

• Connecting word.

property to

to: AssertionChain<T>;

• Connecting word.

property comparePrototypes

comparePrototypes?: boolean | undefined;

• Ignore object prototypes when doing a deep comparison? Defaults to false.

property truncateMessages

truncateMessages?: boolean | undefined;

• Truncate long assertion error messages for readability? Defaults to true.

method arguments

arguments: () => AssertionChain<T>;

• Asserts that the reference value is an arguments object.

method array

array: () => AssertionChain<T>;

• Asserts that the reference value is an Array.

method boolean

boolean: () => AssertionChain<T>;

• Asserts that the reference value is a boolean.

method buffer

buffer: () => AssertionChain<T>;

• Asserts that the reference value is a Buffer.

method date

date: () => AssertionChain<T>;

• Asserts that the reference value is a Date.

method error

error: (type?: any, message?: string | RegExp) => AssertionChain<T>;

• Asserts that the reference value is an error.

method function

function: () => AssertionChain<T>;

• Asserts that the reference value is a function.

method number

number: () => AssertionChain<T>;

• Asserts that the reference value is a number.

method object

object: () => AssertionChain<T>;

• Asserts that the reference value is an object (excluding array, buffer, or other native objects).

method regexp

regexp: () => AssertionChain<T>;

• Asserts that the reference value is a RegExp.

method string

string: () => AssertionChain<T>;

• Asserts that the reference value is a string.

method about

about: (value: number, delta: number) => AssertionChain<T>;

• Asserts that the reference value is about the provided value within a delta margin of difference.

method above

above: (value: T) => AssertionChain<T>;

• Asserts that the reference value is greater than (>) the provided value.

method below

below: (value: T) => AssertionChain<T>;

• Asserts that the reference value is less than (<) the provided value.

method between

between: (from: T, to: T) => AssertionChain<T>;

• Asserts that the reference value is between but not equal (from < value < to) the provided values.

method contain

contain: (values: string | string[] | T | T[]) => AssertionChain<T>;

• Asserts that the reference value (a string, array, or object) includes the provided values.

method contains

contains: (values: string | string[] | T | T[]) => AssertionChain<T>;

• Asserts that the reference value (a string, array, or object) includes the provided values.

method empty

empty: () => AssertionChain<T>;

• Asserts that the reference value has a length property equal to zero or an object with no keys.

method endsWith

endsWith: (value: string) => AssertionChain<T>;

• Asserts that the reference value (a string) ends with the provided value.

method endWith

endWith: (value: string) => AssertionChain<T>;

• Asserts that the reference value (a string) ends with the provided value.

method equal

equal: (value: T | T[], options?: any) => AssertionChain<T>;

• Asserts that the reference value equals the provided value.

method equals

equals: (value: T | T[], options?: any) => AssertionChain<T>;

• Asserts that the reference value equals the provided value.

method exist

exist: () => AssertionChain<T>;

• Asserts that the reference value exists (not null or undefined).

method exists

exists: () => AssertionChain<T>;

• Asserts that the reference value exists (not null or undefined).

method false

false: () => AssertionChain<T>;

• Asserts that the reference value is false.

method greaterThan

greaterThan: (value: T) => AssertionChain<T>;

• Asserts that the reference value is greater than (>) the provided value.

method include

include: (values: string | string[] | T | T[]) => AssertionChain<T>;

• Asserts that the reference value (a string, array, or object) includes the provided values.

method includes

includes: (values: string | string[] | T | T[]) => AssertionChain<T>;

• Asserts that the reference value (a string, array, or object) includes the provided values.

method instanceof

instanceof: (type: any) => AssertionChain<T>;

• Asserts that the reference value has the provided instanceof value.

method instanceOf

instanceOf: (type: any) => AssertionChain<T>;

• Asserts that the reference value has the provided instanceof value.

method least

least: (value: T) => AssertionChain<T>;

• Asserts that the reference value is at least (>=) the provided value.

method length

length: (size: number) => AssertionChain<T>;

• Asserts that the reference value has a length property matching the provided size or an object with the specified number of keys.

method lessThan

lessThan: (value: T) => AssertionChain<T>;

• Asserts that the reference value is less than (<) the provided value.

method match

match: (regex: RegExp) => AssertionChain<T>;

• Asserts that the reference value's toString() representation matches the provided regular expression.

method matches

matches: (regex: RegExp) => AssertionChain<T>;

• Asserts that the reference value's toString() representation matches the provided regular expression.

method max

max: (value: T) => AssertionChain<T>;

• Asserts that the reference value is at most (<=) the provided value.

method min

min: (value: T) => AssertionChain<T>;

• Asserts that the reference value is at least (>=) the provided value.

method most

most: (value: T) => AssertionChain<T>;

• Asserts that the reference value is at most (<=) the provided value.

method null

null: () => AssertionChain<T>;

• Asserts that the reference value is null.

method range

range: (from: T, to: T) => AssertionChain<T>;

• Asserts that the reference value is within (from <= value <= to) the provided values.

method reject

reject: (type?: any, message?: string | RegExp) => AssertionChain<T>;

• Asserts that the Promise reference value rejects with an exception when called

method rejects

rejects: (type?: any, message?: string | RegExp) => AssertionChain<T>;

• Asserts that the Promise reference value rejects with an exception when called

method satisfies

satisfies: (validator: (value: T) => boolean) => AssertionChain<T>;

• Asserts that the reference value satisfies the provided validator function.

method satisfy

satisfy: (validator: (value: T) => boolean) => AssertionChain<T>;

• Asserts that the reference value satisfies the provided validator function.

method startsWith

startsWith: (value: string) => AssertionChain<T>;

• Asserts that the reference value (a string) starts with the provided value.

method startWith

startWith: (value: string) => AssertionChain<T>;

• Asserts that the reference value (a string) starts with the provided value.

method throw

throw: (type?: any, message?: string | RegExp) => AssertionChain<T>;

• Asserts that the function reference value throws an exception when called.

method throws

throws: (type?: any, message?: string | RegExp) => AssertionChain<T>;

• Asserts that the function reference value throws an exception when called.

method true

true: () => AssertionChain<T>;

• Asserts that the reference value is true.

method undefined

undefined: () => AssertionChain<T>;

• Asserts that the reference value is undefined.

method within

within: (from: T, to: T) => AssertionChain<T>;

• Asserts that the reference value is within (from <= value <= to) the provided values.