Interface Spy<Self, Args, Return>

A function or instance method wrapper that records all calls made to it.

interface Spy<Self, Args, Return> {
    calls: SpyCall<Self, Args, Return>[];
    original: ((this: Self, ...args: Args) => Return);
    restored: boolean;
    restore(): void;
    (this: Self, ...args: Args): Return;
}

Type Parameters

Self = any
Args extends unknown[] = any[]
Return = any

Hierarchy

Spy (view full)
- MethodSpy

Spy(this, ...args): Return
Parameters
- this: Self
- Rest...args: Args
Returns Return
- Defined in testing/mock.ts:386

Index

Properties

calls original restored

Methods

Properties

calls

calls: SpyCall<Self, Args, Return>[]

Information about calls made to the function or instance method.

original

original: ((this: Self, ...args: Args) => Return)

The function that is being spied on.

restored

restored: boolean

Whether or not the original instance method has been restored.

Methods

restore

restore(): void
If spying on an instance method, this restores the original instance method.

Returns void
- Defined in testing/mock.ts:394