Go to repository

Interface ObjectExpectation<T>

This interface represents an expectation that is performed over an object.

interface ObjectExpectation<T> {
    not: ObjectExpectation<T>;
    asArray<E>(): ArrayExpectation<E>;
    asNumber(): NumberExpectation;
    asObject<E>(): ObjectExpectation<E>;
    asString(): StringExpectation;
    toBe(value: T): ObjectExpectation<T> & FinishedExpectation;
    toBeDefined(): ObjectExpectation<T> & FinishedExpectation;
    toBeEmptyObject(): ObjectExpectation<T> & FinishedExpectation;
    toBeFalsy(): ObjectExpectation<T> & FinishedExpectation;
    toBeInstanceOf(classConstructor: ((...arguments_: readonly unknown[]) => unknown)): ObjectExpectation<T> & FinishedExpectation;
    toBeLike(value: T): ObjectExpectation<T> & FinishedExpectation;
    toBeNull(): ObjectExpectation<T> & FinishedExpectation;
    toBeTruthy(): ObjectExpectation<T> & FinishedExpectation;
    toBeUndefined(): ObjectExpectation<T> & FinishedExpectation;
    toHaveAtLeast(keys: string[]): ObjectExpectation<T> & FinishedExpectation;
    toHaveNoOtherThan(keys: string[]): ObjectExpectation<T> & FinishedExpectation;
    toHaveProperty(propertyName: string): ObjectExpectation<T> & FinishedExpectation;
    toHavePropertyCount(count: number): ObjectExpectation<T> & FinishedExpectation;
    toHaveShape(shape: Shape): ObjectExpectation<T> & FinishedExpectation;
    toHaveType(value: string): ObjectExpectation<T> & FinishedExpectation;
}

Type Parameters

  • T

Hierarchy (view full)

Properties

not

not: ObjectExpectation<T>

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): ObjectExpectation<T> & 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: T

Returns ObjectExpectation<T> & FinishedExpectation

toBeDefined

toBeDefined(): ObjectExpectation<T> & FinishedExpectation

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

Returns ObjectExpectation<T> & FinishedExpectation

toBeEmptyObject

toBeEmptyObject(): ObjectExpectation<T> & FinishedExpectation

Answer if the actual element is empty.

Returns ObjectExpectation<T> & FinishedExpectation

toBeFalsy

toBeFalsy(): ObjectExpectation<T> & FinishedExpectation

Answers if the actual value is a falsy value.

Returns ObjectExpectation<T> & FinishedExpectation

toBeInstanceOf

toBeInstanceOf(classConstructor): ObjectExpectation<T> & FinishedExpectation

Answer if the actual element is an instance of a given class (using instanceof).

Parameters

  • classConstructor: ((...arguments_: readonly unknown[]) => unknown)
      • (...arguments_): unknown

      • Parameters

        • Rest
          ...arguments_: readonly unknown[]

        Returns unknown

Returns ObjectExpectation<T> & FinishedExpectation

toBeLike

toBeLike(value): ObjectExpectation<T> & 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: T

Returns ObjectExpectation<T> & FinishedExpectation

toBeNull

toBeNull(): ObjectExpectation<T> & FinishedExpectation

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

Returns ObjectExpectation<T> & FinishedExpectation

toBeTruthy

toBeTruthy(): ObjectExpectation<T> & FinishedExpectation

Answers if the actual value is a truthy value.

Returns ObjectExpectation<T> & FinishedExpectation

toBeUndefined

toBeUndefined(): ObjectExpectation<T> & FinishedExpectation

Answers if the actual value is undefined.

Returns ObjectExpectation<T> & FinishedExpectation

toHaveAtLeast

toHaveAtLeast(keys): ObjectExpectation<T> & FinishedExpectation

Answer if an object has at least all keys in the least. Combine with toHaveNoOtherThan to ensure exact key existence

Parameters

  • keys: string[]

Returns ObjectExpectation<T> & FinishedExpectation

toHaveNoOtherThan

toHaveNoOtherThan(keys): ObjectExpectation<T> & FinishedExpectation

Answer if an object has no other than the given keys (although not all given need to be present). Combine with toHaveAtLeast to ensure exact key existence

Parameters

  • keys: string[]

Returns ObjectExpectation<T> & FinishedExpectation

toHaveProperty

toHaveProperty(propertyName): ObjectExpectation<T> & FinishedExpectation

Answer if the actual element has a property with the given name.

Parameters

  • propertyName: string

Returns ObjectExpectation<T> & FinishedExpectation

toHavePropertyCount

toHavePropertyCount(count): ObjectExpectation<T> & FinishedExpectation

Answer if the actual element has the given amount of properties.

Parameters

  • count: number

Returns ObjectExpectation<T> & FinishedExpectation

toHaveShape

toHaveShape(shape): ObjectExpectation<T> & FinishedExpectation

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

Parameters

  • shape: Shape

Returns ObjectExpectation<T> & FinishedExpectation

toHaveType

toHaveType(value): ObjectExpectation<T> & FinishedExpectation

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

Parameters

  • value: string

Returns ObjectExpectation<T> & FinishedExpectation

Example

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

Settings

Member Visibility

On This Page

Properties
Methods
""