Function stub

stub<Self, Prop>(self, property): Stub<Self, GetParametersFromProp<Self, Prop>, GetReturnFromProp<Self, Prop>>
Replaces an instance method with a Stub with empty implementation.
Type Parameters
- Self
  The self type of the instance to replace a method of.
- Prop extends string | number | symbol
  The property of the instance to replace.
Parameters
- self: Self
  The instance to replace a method of.
- property: Prop
  The property of the instance to replace.
Returns Stub<Self, GetParametersFromProp<Self, Prop>, GetReturnFromProp<Self, Prop>>
The stub function which replaced the original.
Example: Usage
```
import { stub, assertSpyCalls } from "@std/testing/mock";

const obj = {
  method() {
    // some inconventient feature for testing
  },
};

const methodStub = stub(obj, "method");

for (const _ of Array(5)) {
  obj.method();
}

assertSpyCalls(methodStub, 5);
```
- Defined in testing/mock.ts:1011
stub<Self, Prop>(self, property, func): Stub<Self, GetParametersFromProp<Self, Prop>, GetReturnFromProp<Self, Prop>>
Replaces an instance method with a Stub with the given implementation.
Type Parameters
- Self
  The self type of the instance to replace a method of.
- Prop extends string | number | symbol
  The property of the instance to replace.
Parameters
- self: Self
  The instance to replace a method of.
- property: Prop
  The property of the instance to replace.
- func: ((this: Self, ...args: GetParametersFromProp<Self, Prop>) => GetReturnFromProp<Self, Prop>)
  The fake implementation of the function.
  - - (this, ...args): GetReturnFromProp<Self, Prop>
    - Parameters
      this: Self
      Rest...args: GetParametersFromProp<Self, Prop>
      Returns GetReturnFromProp<Self, Prop>
Returns Stub<Self, GetParametersFromProp<Self, Prop>, GetReturnFromProp<Self, Prop>>
The stub function which replaced the original.
Example: Usage
```
import { stub } from "@std/testing/mock";
import { assertEquals } from "@std/assert";

const obj = {
  method(): number {
    return Math.random();
  },
};

const methodStub = stub(obj, "method", () => 0.5);

assertEquals(obj.method(), 0.5);
```
- Defined in testing/mock.ts:1044

Function stub

Type Parameters

Parameters

Returns Stub<Self, GetParametersFromProp<Self, Prop>, GetReturnFromProp<Self, Prop>>

Example: Usage

Type Parameters

Parameters

Parameters

Returns GetReturnFromProp<Self, Prop>

Returns Stub<Self, GetParametersFromProp<Self, Prop>, GetReturnFromProp<Self, Prop>>

Example: Usage

Settings