JSDoc: Class: Mock

Constructor

new Mock(nameopt)

Creates a new mocked function.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string	<optional>	<anonymous>	Name of the function.

Source:

Mock.js, line 23

Members

function

Source:

Mock.js, line 43

handler :function

The function that gets executed when the mocked function is called

Type:

function

Source:

Mock.js, line 112

ignoreOtherCalls

Gets state of global ignore other calls flag

Source:

Mock.js, line 80

ignoreOtherCalls

Sets state of the global ignore other calls flag

Source:

Mock.js, line 87

name :string

Name of the mocked function.

Type:

string

Source:

Mock.js, line 29

tree

Sets global tree pointer value

Source:

Mock.js, line 101

tree

Gets global tree pointer value.

Source:

Mock.js, line 94

Methods

mayBeCalled() → {Expectation}

Creats a new optional Expecatation from this mock.

Source:

Mock.js, line 167

Returns:

Expectation created from this mock.

Type: Expectation

mayBeCalledWith(arguments) → {Expectation}

Creats a new optional Expecatation from this mock that expects the specified arguments.

Parameters:

Name	Type	Description
`arguments`	Array.<object>	Expected arguments

Source:

Mock.js, line 176

Returns:

Expectation created from this mock.

Type: Expectation

mayBeCalledWithAnyArguments() → {Expectation}

Creats a new optional Expecatation from this mock that will accept any arguments.

Source:

Mock.js, line 185

Returns:

Expectation created from this mock.

Type: Expectation

shouldBeCalled() → {Expectation}

Creats a new required Expecatation from this mock.

Source:

Mock.js, line 140

Returns:

Expectation created from this mock.

Type: Expectation

shouldBeCalledWith(arguments) → {Expectation}

Creats a new required Expecatation from this mock that expects the specified arguments.

Parameters:

Name	Type	Description
`arguments`	Array.<object>	Expected arguments

Source:

Mock.js, line 149

Returns:

Expectation created from this mock.

Type: Expectation

shouldBeCalledWithAnyArguments() → {Expectation}

Creats a new required Expecatation from this mock that will accept any arguments.

Source:

Mock.js, line 158

Returns:

Expectation created from this mock.

Type: Expectation