File Explorer

1# Class: MockCallHistory2 3Access to an instance with :4 5```js6const mockAgent = new MockAgent({ enableCallHistory: true })7mockAgent.getCallHistory()8 9// or10const mockAgent = new MockAgent()11mockAgent.enableMockHistory()12mockAgent.getCallHistory()13 14```15 16a MockCallHistory instance implements a **Symbol.iterator** letting you iterate on registered logs :17 18```ts19for (const log of mockAgent.getCallHistory()) {20  //...21}22 23const array: Array<MockCallHistoryLog> = [...mockAgent.getCallHistory()]24const set: Set<MockCallHistoryLog> = new Set(mockAgent.getCallHistory())25```26 27## class methods28 29### clear30 31Clear all MockCallHistoryLog registered. This is automatically done when calling `mockAgent.close()`32 33```js34mockAgent.clearCallHistory()35// same as36mockAgent.getCallHistory()?.clear()37```38 39### calls40 41Get all MockCallHistoryLog registered as an array42 43```js44mockAgent.getCallHistory()?.calls()45```46 47### firstCall48 49Get the first MockCallHistoryLog registered or undefined50 51```js52mockAgent.getCallHistory()?.firstCall()53```54 55### lastCall56 57Get the last MockCallHistoryLog registered or undefined58 59```js60mockAgent.getCallHistory()?.lastCall()61```62 63### nthCall64 65Get the nth MockCallHistoryLog registered or undefined66 67```js68mockAgent.getCallHistory()?.nthCall(3) // the third MockCallHistoryLog registered69```70 71### filterCallsByProtocol72 73Filter MockCallHistoryLog by protocol.74 75> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)76 77```js78mockAgent.getCallHistory()?.filterCallsByProtocol(/https/)79mockAgent.getCallHistory()?.filterCallsByProtocol('https:')80```81 82### filterCallsByHost83 84Filter MockCallHistoryLog by host.85 86> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)87 88```js89mockAgent.getCallHistory()?.filterCallsByHost(/localhost/)90mockAgent.getCallHistory()?.filterCallsByHost('localhost:3000')91```92 93### filterCallsByPort94 95Filter MockCallHistoryLog by port.96 97> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)98 99```js100mockAgent.getCallHistory()?.filterCallsByPort(/3000/)101mockAgent.getCallHistory()?.filterCallsByPort('3000')102mockAgent.getCallHistory()?.filterCallsByPort('')103```104 105### filterCallsByOrigin106 107Filter MockCallHistoryLog by origin.108 109> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)110 111```js112mockAgent.getCallHistory()?.filterCallsByOrigin(/http:\/\/localhost:3000/)113mockAgent.getCallHistory()?.filterCallsByOrigin('http://localhost:3000')114```115 116### filterCallsByPath117 118Filter MockCallHistoryLog by path.119 120> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)121 122```js123mockAgent.getCallHistory()?.filterCallsByPath(/api\/v1\/graphql/)124mockAgent.getCallHistory()?.filterCallsByPath('/api/v1/graphql')125```126 127### filterCallsByHash128 129Filter MockCallHistoryLog by hash.130 131> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)132 133```js134mockAgent.getCallHistory()?.filterCallsByPath(/hash/)135mockAgent.getCallHistory()?.filterCallsByPath('#hash')136```137 138### filterCallsByFullUrl139 140Filter MockCallHistoryLog by fullUrl. fullUrl contains protocol, host, port, path, hash, and query params141 142> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)143 144```js145mockAgent.getCallHistory()?.filterCallsByFullUrl(/https:\/\/localhost:3000\/\?query=value#hash/)146mockAgent.getCallHistory()?.filterCallsByFullUrl('https://localhost:3000/?query=value#hash')147```148 149### filterCallsByMethod150 151Filter MockCallHistoryLog by method.152 153> more details for the first parameter can be found [here](/docs/docs/api/MockCallHistory.md#filter-parameter)154 155```js156mockAgent.getCallHistory()?.filterCallsByMethod(/POST/)157mockAgent.getCallHistory()?.filterCallsByMethod('POST')158```159 160### filterCalls161 162This class method is a meta function / alias to apply complex filtering in a single way.163 164Parameters :165 166- criteria : the first parameter. a function, regexp or object.167  - function : filter MockCallHistoryLog when the function returns false168  - regexp : filter MockCallHistoryLog when the regexp does not match on MockCallHistoryLog.toString() ([see](./MockCallHistoryLog.md#to-string))169  - object : an object with MockCallHistoryLog properties as keys to apply multiple filters. each values are a [filter parameter](/docs/docs/api/MockCallHistory.md#filter-parameter)170- options : the second parameter. an object.171  - options.operator : `'AND'` or `'OR'` (default `'OR'`). Used only if criteria is an object. see below172 173```js174mockAgent.getCallHistory()?.filterCalls((log) => log.hash === value && log.headers?.['authorization'] !== undefined)175mockAgent.getCallHistory()?.filterCalls(/"data": "{ "errors": "wrong body" }"/)176 177// returns an Array of MockCallHistoryLog which all have178// - a hash containing my-hash179// - OR180// - a path equal to /endpoint181mockAgent.getCallHistory()?.filterCalls({ hash: /my-hash/, path: '/endpoint' })182 183// returns an Array of MockCallHistoryLog which all have184// - a hash containing my-hash185// - AND186// - a path equal to /endpoint187mockAgent.getCallHistory()?.filterCalls({ hash: /my-hash/, path: '/endpoint' }, { operator: 'AND' })188```189 190## filter parameter191 192Can be :193 194- string. MockCallHistoryLog filtered if `value !== parameterValue`195- null. MockCallHistoryLog filtered if `value !== parameterValue`196- undefined. MockCallHistoryLog filtered if `value !== parameterValue`197- regexp. MockCallHistoryLog filtered if `!parameterValue.test(value)`198