Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Matchers<T>

Type parameters

  • T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Matchers(env: Env, actual: T, spec: Env, isNot?: boolean): any

  • Parameters

    • env: Env
    • actual: T
    • spec: Env
    • Optional isNot: boolean

    Returns any

Properties

actual

actual: T

env

env: Env

Optional isNot

isNot: boolean

not

not: Matchers<T>

Invert the matcher following this expect.

spec

spec: Env

Methods

message

  • message(): any

  • Returns any

toBe

  • toBe(expected: Expected<T>, expectationFailOutput?: any): boolean

  • Expect the actual value to be === to the expected value.

    example

    expect(thing).toBe(realThing);

    Parameters

    • expected: Expected<T>

      The expected value to compare against.

    • Optional expectationFailOutput: any

    Returns boolean

toBeCloseTo

  • toBeCloseTo(expected: number, precision?: any, expectationFailOutput?: any): boolean

  • Parameters

    • expected: number
    • Optional precision: any
    • Optional expectationFailOutput: any

    Returns boolean

toBeDefined

  • toBeDefined(expectationFailOutput?: any): boolean

  • Parameters

    • Optional expectationFailOutput: any

    Returns boolean

toBeFalse

  • toBeFalse(): boolean

  • Returns boolean

toBeFalsy

  • toBeFalsy(expectationFailOutput?: any): boolean

  • Parameters

    • Optional expectationFailOutput: any

    Returns boolean

toBeGreaterThan

  • toBeGreaterThan(expected: number, expectationFailOutput?: any): boolean

  • Parameters

    • expected: number
    • Optional expectationFailOutput: any

    Returns boolean

toBeGreaterThanOrEqual

  • toBeGreaterThanOrEqual(expected: number, expectationFailOutput?: any): boolean

  • Parameters

    • expected: number
    • Optional expectationFailOutput: any

    Returns boolean

toBeInstanceOf

  • Parameters

    Returns boolean

toBeLessThan

  • toBeLessThan(expected: number, expectationFailOutput?: any): boolean

  • Parameters

    • expected: number
    • Optional expectationFailOutput: any

    Returns boolean

toBeLessThanOrEqual

  • toBeLessThanOrEqual(expected: number, expectationFailOutput?: any): boolean

  • Parameters

    • expected: number
    • Optional expectationFailOutput: any

    Returns boolean

toBeNaN

  • toBeNaN(): boolean

  • Returns boolean

toBeNegativeInfinity

  • toBeNegativeInfinity(expectationFailOutput?: any): boolean

  • Parameters

    • Optional expectationFailOutput: any

    Returns boolean

toBeNull

  • toBeNull(expectationFailOutput?: any): boolean

  • Parameters

    • Optional expectationFailOutput: any

    Returns boolean

toBePositiveInfinity

  • toBePositiveInfinity(expectationFailOutput?: any): boolean

  • Parameters

    • Optional expectationFailOutput: any

    Returns boolean

toBeTrue

  • toBeTrue(): boolean

  • Returns boolean

toBeTruthy

  • toBeTruthy(expectationFailOutput?: any): boolean

  • Parameters

    • Optional expectationFailOutput: any

    Returns boolean

toBeUndefined

  • toBeUndefined(expectationFailOutput?: any): boolean

  • Parameters

    • Optional expectationFailOutput: any

    Returns boolean

toContain

  • toContain(expected: any, expectationFailOutput?: any): boolean

  • Parameters

    • expected: any
    • Optional expectationFailOutput: any

    Returns boolean

toEqual

  • toEqual(expected: Expected<T>, expectationFailOutput?: any): boolean

  • Expect the actual value to be equal to the expected, using deep equality comparison.

    example

    expect(bigObject).toEqual({ "foo": ['bar', 'baz'] });

    Parameters

    • expected: Expected<T>

      Expected value.

    • Optional expectationFailOutput: any

    Returns boolean

toHaveBeenCalled

  • toHaveBeenCalled(): boolean

  • Returns boolean

toHaveBeenCalledBefore

  • toHaveBeenCalledBefore(expected: Func): boolean

  • Parameters

    Returns boolean

toHaveBeenCalledOnceWith

  • toHaveBeenCalledOnceWith(...params: any[]): boolean

  • Parameters

    • Rest ...params: any[]

    Returns boolean

toHaveBeenCalledTimes

  • toHaveBeenCalledTimes(expected: number): boolean

  • Parameters

    • expected: number

    Returns boolean

toHaveBeenCalledWith

  • toHaveBeenCalledWith(...params: any[]): boolean

  • Parameters

    • Rest ...params: any[]

    Returns boolean

toHaveClass

  • toHaveClass(expected: string, expectationFailOutput?: any): boolean

  • Expect the actual value to be a DOM element that has the expected class.

    since

    3.0.0

    example

    var el = document.createElement('div'); el.className = 'foo bar baz'; expect(el).toHaveClass('bar');

    Parameters

    • expected: string

      The class name to test for.

    • Optional expectationFailOutput: any

    Returns boolean

toHaveSize

  • toHaveSize(expected: number): boolean

  • Expect the actual size to be equal to the expected, using array-like length or object keys size.

    since

    3.6.0

    example

    array = [1,2]; expect(array).toHaveSize(2);

    Parameters

    • expected: number

      The expected size

    Returns boolean

toMatch

  • toMatch(expected: string | RegExp, expectationFailOutput?: any): boolean

  • Expect the actual value to match a regular expression.

    example

    expect("my string").toMatch(/string$/); expect("other string").toMatch("her");

    Parameters

    • expected: string | RegExp

      Value to look for in the string.

    • Optional expectationFailOutput: any

    Returns boolean

toThrow

  • toThrow(expected?: any): boolean

  • Parameters

    • Optional expected: any

    Returns boolean

toThrowError

  • toThrowError(message?: string | RegExp): boolean
  • toThrowError(expected?: object, message?: string | RegExp): boolean

  • Parameters

    • Optional message: string | RegExp

    Returns boolean

  • Parameters

    • Optional expected: object
    • Optional message: string | RegExp

    Returns boolean

toThrowMatching

  • toThrowMatching(predicate: function): boolean

  • Parameters

    • predicate: function
        • (thrown: any): boolean

        • Parameters

          • thrown: any

          Returns boolean

    Returns boolean

withContext

  • withContext(message: string): Matchers<T>

  • Add some context for an expect.

    Parameters

    • message: string

      Additional context to show when the matcher fails

    Returns Matchers<T>

Generated using TypeDoc