Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Mock<T, Y>

Type parameters

  • T

  • Y: Array<unknown>

Hierarchy

Callable

  • __call(...args: Y): T

  • Parameters

    • Rest ...args: Y

    Returns T

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Mock(...args: Y): T

  • Parameters

    • Rest ...args: Y

    Returns T

Properties

Function

Function: FunctionConstructor

_isMockFunction

_isMockFunction: true

_protoImpl

_protoImpl: Function

arguments

arguments: any

caller

caller: Function

length

length: number

mock

mock: MockFunctionState<T, Y>

name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

prototype

prototype: any

Methods

__@hasInstance

  • __@hasInstance(value: any): boolean

  • Determines whether the given value inherits from this function if this function was used as a constructor function.

    A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

    Parameters

    • value: any

    Returns boolean

apply

  • apply(this: Function, thisArg: any, argArray?: any): any

  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

bind

  • bind(this: Function, thisArg: any, ...argArray: any[]): any

  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • this: Function
    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

call

  • call(this: Function, thisArg: any, ...argArray: any[]): any

  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

getMockImplementation

  • getMockImplementation(): Function | undefined

getMockName

  • getMockName(): string

mockClear

  • mockClear(): this

  • Returns this

mockImplementation

  • mockImplementation(fn: function): this
  • mockImplementation(fn: function): this

  • Parameters

    • fn: function
        • (...args: Y): T

        • Parameters

          • Rest ...args: Y

          Returns T

    Returns this

  • Parameters

    • fn: function
        • (): Promise<T>

        • Returns Promise<T>

    Returns this

mockImplementationOnce

  • mockImplementationOnce(fn: function): this
  • mockImplementationOnce(fn: function): this

  • Parameters

    • fn: function
        • (...args: Y): T

        • Parameters

          • Rest ...args: Y

          Returns T

    Returns this

  • Parameters

    • fn: function
        • (): Promise<T>

        • Returns Promise<T>

    Returns this

mockName

  • mockName(name: string): this

  • Parameters

    • name: string

    Returns this

mockRejectedValue

  • mockRejectedValue(value: T): this

mockRejectedValueOnce

  • mockRejectedValueOnce(value: T): this

mockReset

  • mockReset(): this

  • Returns this

mockResolvedValue

  • mockResolvedValue(value: T): this

mockResolvedValueOnce

  • mockResolvedValueOnce(value: T): this

mockRestore

  • mockRestore(): void

mockReturnThis

  • mockReturnThis(): this

mockReturnValue

  • mockReturnValue(value: T): this

mockReturnValueOnce

  • mockReturnValueOnce(value: T): this

toString

  • toString(): string

  • Returns a string representation of a function.

    Returns string

Generated using TypeDoc