import {Fixture} from 'fetch-mock-fixtures/src/Fixture.js'

public class | version 1.0.0 | since 2.0.0 | source

Fixture

Extends:

ResponseConfigurator → Fixture

A fixture contains all the needed informations to find out wich request can be matched and wich response must be sent back

Constructor Summary

Public Constructor
public	constructor(server: Server) Initialize the ResponseConfigurator helper	version 1.0.0 since 2.0.0

Member Summary

Public Members
public get	any: *
public	calls: Number Stores the number of responses generated by this fixture	since 2.0.0
public get	fallback: Fixture: * Alias for respond that always return the fallback fixture	version 1.0.0 since 2.0.0
public	globalCalls: Array Stores the response which are specific to global call count	since 2.0.0
public get	on: RequestMatcher: * Set the fixture in request matching mode.	version 1.0.0 since 2.0.0
public	ownCalls: Array Stores the response which are specific to own call count	since 2.0.0
public get	respond: Fixture: * Ask server to process the respond.	version 1.0.0 since 2.0.0
public get	to: Fixture: * Syntax sugar for human readability	version 1.0.0 since 1.0.0
public get	when: RequestMatcher: * Alias for `on`	version 1.0.0 since 2.0.0

Private Members
private	_any: *
private	_callnum: null \| Number Flag for response configuration	since 2.0.0
private	_matcher: null \| RequestMatcher Request matcher instance	since 2.0.0
private	_ownCall: Boolean Flag for call count configuration	since 2.0.0
private	_responseKeys: Array Allow response key for configuration	since 2.0.0

Method Summary

Public Methods
public	call(n: , own: ): *
public	extractParams(pathname: , pattern: ): *
public	firstCall(own: boolean): *
public	getPath(request: , response: ): *
public	getResponse(request: ):
public	async match(request: , server: ): *
public	preset(name: ):
public	secondCall(own: boolean): *
public	async sleep(delay: *)
public	thirdCall(own: boolean): *
public	throw(message: string)
public	wrap(body: , wrapper: ): *

Private Methods
private	async _buildResponse(request: , response: ): *
private	_exceptionManagement(err: , message: ): *
private	_getCurrentResponseSet(): Object Target the current response set based on call count configuration	version 1.0.0 since 2.0.0

Inherited Summary

From class ResponseConfigurator
public get	and: ResponseConfigurator: * Sugar for chaining	version 1.0.0 since 2.0.0
public get	with: ResponseConfigurator: * Sugar for chaining	version 1.0.0 since 2.0.0
public	server: Server \| null Stores the server instance	since 2.0.0
private	_any: Object Default response for fixture or preset.	since 2.0.0
private	_responseKeys: Array Allowed response keys	since 2.0.0
public	after(cb: Function): ResponseConfigurator Set the after callback	version 1.0.0 since 2.0.0
public	before(cb: Function): ResponseConfigurator Set the before callback	version 1.0.0 since 2.0.0
public	body(body: String \| Function): ResponseConfigurator Set the response body	version 1.0.0 since 2.0.0
public	delay(delay: Boolean \| Number): ResponseConfigurator Set the time the server will wait before sending back response	version 1.0.0 since 2.0.0
public	header(name: String, content: String, append: Boolean): ResponseConfigurator Set a specific header value	version 1.0.0 since 2.2.0
public	headers(headers: Object \| Headers \| Boolean): ResponseConfigurator One time setter for all headers	version 1.0.1 since 2.0.0
public	pattern(pattern: String): ResponseConfigurator Set the pattern that will be used to match the request	version 1.0.0 since 2.0.0
public	set(params: Object): * Set the response parameters based on the object provided	version 1.0.0 since 2.0.0
public	status(status: Number): ResponseConfigurator Set the response status	version 1.0.0 since 2.0.0
public	statusText(text: String): ResponseConfigurator Set the response status text	version 1.0.0 since 2.0.0
public	wrapper(wrapper: Function \| Boolean): ResponseConfigurator Set the response body wrapper	version 1.0.0 since 2.0.0
private abstract	_getCurrentResponseSet()

Public Constructors

public constructor(server: Server) version 1.0.0 since 2.0.0 source

Initialize the ResponseConfigurator helper

Override:

ResponseConfigurator#constructor

Params:

Name	Type	Attribute	Description
server	Server	optional	Server instance

Public Members

public get any: * source

public calls: Number since 2.0.0 source

Stores the number of responses generated by this fixture

public get fallback: Fixture: * version 1.0.0 since 2.0.0 source

Alias for respond that always return the fallback fixture

Return:

Fixture

Fallback fixture

public globalCalls: Array since 2.0.0 source

Stores the response which are specific to global call count

public get on: RequestMatcher: * version 1.0.0 since 2.0.0 source

Set the fixture in request matching mode. The matcher is behing a proxy to allow quick property mapping

Return:

RequestMatcher

Request matcher

public ownCalls: Array since 2.0.0 source

Stores the response which are specific to own call count

public get respond: Fixture: * version 1.0.0 since 2.0.0 source

Ask server to process the respond. If the fixture is already in response mode, a new fixture will be returned. Otherwise, it will be the same fixture

Return:

Fixture

public get to: Fixture: * version 1.0.0 since 1.0.0 source

Syntax sugar for human readability

Return:

Fixture

public get when: RequestMatcher: * version 1.0.0 since 2.0.0 source

Alias for on

Return:

RequestMatcher

Request matcher

Private Members

private _any: * source

Default response for fixture or preset. For fixture, it will be used when ordered responses are not matching defined call counts.

Override:

ResponseConfigurator#_any

private _callnum: null | Number since 2.0.0 source

Flag for response configuration

private _matcher: null | RequestMatcher since 2.0.0 source

Request matcher instance

private _ownCall: Boolean since 2.0.0 source

Flag for call count configuration

private _responseKeys: Array since 2.0.0 source

Allow response key for configuration

Override:

ResponseConfigurator#_responseKeys

Public Methods

public call(n: , own: ): * source

Params:

Name	Type	Attribute	Description
n	*
own	*

Return:

public extractParams(pathname: , pattern: ): * source

Params:

Name	Type	Attribute	Description
pathname	*
pattern	*

Return:

public firstCall(own: boolean): * source

Params:

Name	Type	Attribute	Description
own	boolean	optional default: false

Return:

public getPath(request: , response: ): * source

Params:

Name	Type	Attribute	Description
request	*
response	*

Return:

public getResponse(request: ): source

Params:

Name	Type	Attribute	Description
request	*

Return:

public async match(request: , server: ): * source

Params:

Name	Type	Attribute	Description
request	*
server	*

Return:

public preset(name: ): source

Params:

Name	Type	Attribute	Description
name	*

Return:

public secondCall(own: boolean): * source

Params:

Name	Type	Attribute	Description
own	boolean	optional default: false

Return:

public async sleep(delay: *) source

Params:

Name	Type	Attribute	Description
delay	*

public thirdCall(own: boolean): * source

Params:

Name	Type	Attribute	Description
own	boolean	optional default: false

Return:

public throw(message: string) source

Params:

Name	Type	Attribute	Description
message	string	optional default:

public wrap(body: , wrapper: ): * source

Params:

Name	Type	Attribute	Description
body	*
wrapper	*

Return:

Private Methods

private async _buildResponse(request: , response: ): * source

Params:

Name	Type	Attribute	Description
request	*
response	*

Return:

private _exceptionManagement(err: , message: ): * source

Params:

Name	Type	Attribute	Description
err	*
message	*

Return:

private _getCurrentResponseSet(): Object version 1.0.0 since 2.0.0 source

Target the current response set based on call count configuration

Override:

ResponseConfigurator#_getCurrentResponseSet

Return:

Object

Response configuration object

Fixture

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(server: Server) version 1.0.0 since 2.0.0 source

Override:

Params:

Public Members

public get any: * source

public calls: Number since 2.0.0 source

public get fallback: Fixture: * version 1.0.0 since 2.0.0 source

Return:

public globalCalls: Array since 2.0.0 source

public get on: RequestMatcher: * version 1.0.0 since 2.0.0 source

Return:

public ownCalls: Array since 2.0.0 source

public get respond: Fixture: * version 1.0.0 since 2.0.0 source

Return:

public get to: Fixture: * version 1.0.0 since 1.0.0 source

Return:

public get when: RequestMatcher: * version 1.0.0 since 2.0.0 source

Return:

Private Members

private _any: * source

Override:

private _callnum: null | Number since 2.0.0 source

private _matcher: null | RequestMatcher since 2.0.0 source

private _ownCall: Boolean since 2.0.0 source

private _responseKeys: Array since 2.0.0 source

Override:

Public Methods

public call(n: *, own: *): * source

Params:

Return:

public extractParams(pathname: *, pattern: *): * source

Params:

Return:

public firstCall(own: boolean): * source

Params:

Return:

public getPath(request: *, response: *): * source

Params:

Return:

public getResponse(request: *): * source

Params:

Return:

public async match(request: *, server: *): * source

Params:

Return:

public preset(name: *): * source

Params:

Return:

public secondCall(own: boolean): * source

Params:

Return:

public async sleep(delay: *) source

Params:

public thirdCall(own: boolean): * source

Params:

Return:

public throw(message: string) source

Params:

public wrap(body: *, wrapper: *): * source

Params:

Return:

Private Methods

private async _buildResponse(request: *, response: *): * source

Params:

Return:

private _exceptionManagement(err: *, message: *): * source

Params:

Return:

private _getCurrentResponseSet(): Object version 1.0.0 since 2.0.0 source

Override:

Return:

public call(n: , own: ): * source

public extractParams(pathname: , pattern: ): * source

public getPath(request: , response: ): * source

public getResponse(request: ): source

public async match(request: , server: ): * source

public preset(name: ): source

public wrap(body: , wrapper: ): * source

private async _buildResponse(request: , response: ): * source

private _exceptionManagement(err: , message: ): * source