Go to repository

Interface NumberExpectation

This interface represents an expectation that is performed over a number.

interface NumberExpectation {
    not: NumberExpectation;
    asArray<E>(): ArrayExpectation<E>;
    asNumber(): NumberExpectation;
    asObject<E>(): ObjectExpectation<E>;
    asString(): StringExpectation;
    toBe(value: number): NumberExpectation & FinishedExpectation;
    toBeBetween(from: number, to: number): NumberExpectation & FinishedExpectation;
    toBeCloseTo(value: number, precision?: number): NumberExpectation & FinishedExpectation;
    toBeDefined(): NumberExpectation & FinishedExpectation;
    toBeFalsy(): NumberExpectation & FinishedExpectation;
    toBeGreaterThan(value: number): NumberExpectation & FinishedExpectation;
    toBeGreaterThanOrEqual(value: number): NumberExpectation & FinishedExpectation;
    toBeInfinity(): NumberExpectation & FinishedExpectation;
    toBeLike(value: number): NumberExpectation & FinishedExpectation;
    toBeLowerThan(value: number): NumberExpectation & FinishedExpectation;
    toBeLowerThanOrEqual(value: number): NumberExpectation & FinishedExpectation;
    toBeNaN(): NumberExpectation & FinishedExpectation;
    toBeNull(): NumberExpectation & FinishedExpectation;
    toBeTruthy(): NumberExpectation & FinishedExpectation;
    toBeUndefined(): NumberExpectation & FinishedExpectation;
    toHaveShape(shape: Shape): NumberExpectation & FinishedExpectation;
    toHaveType(value: string): NumberExpectation & FinishedExpectation;
}

Hierarchy (view full)

Properties

not

Methods

asArray asNumber asObject asString toBe toBeBetween toBeCloseTo toBeDefined toBeFalsy toBeGreaterThan toBeGreaterThanOrEqual toBeInfinity toBeLike toBeLowerThan toBeLowerThanOrEqual toBeNaN toBeNull toBeTruthy toBeUndefined toHaveShape toHaveType

Properties

not

not: NumberExpectation

This attribute retrieves an expectancy whose result value is false in case the matcher fulfills, and true otherwise.

Methods

asArray

asArray<E>(): ArrayExpectation<E>

Answer the given expectation as an instance of IArrayExpectation. No check is performed on the input to see if it can actually be casted.

Type Parameters

  • E

Returns ArrayExpectation<E>

asNumber

asNumber(): NumberExpectation

Answer the given expectation as an instance of INumberExpectation. No check is performed on the input to see if it can actually be casted.

Returns NumberExpectation

asObject

asObject<E>(): ObjectExpectation<E>

Answer the given expectation as an instance of IObjectExpectation. No check is performed on the input to see if it can actually be casted.

Type Parameters

  • E

Returns ObjectExpectation<E>

asString

asString(): StringExpectation

Answer the given expectation as an instance of IStringExpectation. No check is performed on the input to see if it can actually be casted.

Returns StringExpectation

toBe

toBe(value): NumberExpectation & FinishedExpectation

Answers if the actual value is the same as expected, using strict compare. Do not use toBe with floating point numbers, use Expectations/Matchers.toBeCloseTo instead.

Parameters

  • value: number

Returns NumberExpectation & FinishedExpectation

toBeBetween

toBeBetween(from, to): NumberExpectation & FinishedExpectation

Answer if the actual value is between the from and to values (inclusive).

Parameters

  • from: number
  • to: number

Returns NumberExpectation & FinishedExpectation

toBeCloseTo

toBeCloseTo(value, precision?): NumberExpectation & FinishedExpectation

Answer if the actual value is close to the expected value, by at least the number of digits given.

Parameters

  • value: number
  • Optional
    precision: number

Returns NumberExpectation & FinishedExpectation

Example

`toBeCloseTo(4.0005, 4.0009, 3)` returns `true`, as there are 3
     digits that are equal between actual and expected.
If no amount of digits is given, 5 is taken by default.

toBeDefined

toBeDefined(): NumberExpectation & FinishedExpectation

Answers if the actual value is defined (as in not equal to undefined)

Returns NumberExpectation & FinishedExpectation

toBeFalsy

toBeFalsy(): NumberExpectation & FinishedExpectation

Answers if the actual value is a falsy value.

Returns NumberExpectation & FinishedExpectation

toBeGreaterThan

toBeGreaterThan(value): NumberExpectation & FinishedExpectation

Answer if the actual value is greater than the expected value.

Parameters

  • value: number

Returns NumberExpectation & FinishedExpectation

toBeGreaterThanOrEqual

toBeGreaterThanOrEqual(value): NumberExpectation & FinishedExpectation

Answer if the actual value is greater than or equal than the expected value.

Parameters

  • value: number

Returns NumberExpectation & FinishedExpectation

toBeInfinity

toBeInfinity(): NumberExpectation & FinishedExpectation

Answer if the actual value is infinity (positive or negative).

Returns NumberExpectation & FinishedExpectation

toBeLike

toBeLike(value): NumberExpectation & FinishedExpectation

Answers if the actual value is the same as expected, using a deep compare mechanism. Do not use toBeLike with floating point numbers, use Expectations/Matchers.toBeCloseTo instead.

Parameters

  • value: number

Returns NumberExpectation & FinishedExpectation

toBeLowerThan

toBeLowerThan(value): NumberExpectation & FinishedExpectation

Answer if the actual value is lower than the expected value.

Parameters

  • value: number

Returns NumberExpectation & FinishedExpectation

toBeLowerThanOrEqual

toBeLowerThanOrEqual(value): NumberExpectation & FinishedExpectation

Answer if the actual value is lower than or equal than the expected value.

Parameters

  • value: number

Returns NumberExpectation & FinishedExpectation

toBeNaN

toBeNaN(): NumberExpectation & FinishedExpectation

Answer if the actual value is not a number.

Returns NumberExpectation & FinishedExpectation

toBeNull

toBeNull(): NumberExpectation & FinishedExpectation

Answers if the actual value is null (strict null, not undefined).

Returns NumberExpectation & FinishedExpectation

toBeTruthy

toBeTruthy(): NumberExpectation & FinishedExpectation

Answers if the actual value is a truthy value.

Returns NumberExpectation & FinishedExpectation

toBeUndefined

toBeUndefined(): NumberExpectation & FinishedExpectation

Answers if the actual value is undefined.

Returns NumberExpectation & FinishedExpectation

toHaveShape

toHaveShape(shape): NumberExpectation & FinishedExpectation

Answer if the actual element has the given shape, as defined by the shapeOf submodule.

Parameters

  • shape: Shape

Returns NumberExpectation & FinishedExpectation

toHaveType

toHaveType(value): NumberExpectation & FinishedExpectation

Answers if the actual value has a type matching the expected type, checked by using the typeof operator.

Parameters

  • value: string

Returns NumberExpectation & FinishedExpectation

Example

`toHaveType('hello', 'string')` returns `true`.

Settings

Member Visibility

On This Page

Properties
Methods