Extends: undici.Pool
A mock Pool class that implements the Pool API and is used by MockAgent to intercept real requests and return mocked responses.
", "signatures": [ { "textRaw": "`new MockPool(origin, [options])`", "name": "MockPool", "type": "ctor", "params": [ { "name": "origin" }, { "name": "options", "optional": true } ], "desc": "Arguments:
\nstring - It should only include the protocol, hostname, and port.MockPoolOptions - It extends the Pool options.Returns: MockPool
Extends: PoolOptions
Agent - the agent to associate this MockPool with.We can use MockAgent to instantiate a MockPool ready to be used to intercept specified requests. It will not do anything until registered as the agent to use and any mock request are registered.
\nimport { MockAgent } from 'undici'\n\nconst mockAgent = new MockAgent()\n\nconst mockPool = mockAgent.get('http://localhost:3000')\nThis method defines the interception rules for matching against requests for a MockPool or MockPool. We can intercept multiple times on a single instance, but each intercept is only used once. For example if you expect to make 2 requests inside a test, you need to call intercept() twice. Assuming you use disableNetConnect() you will get MockNotMatchedError on the second request when you only call intercept() once.
When defining interception rules, all the rules must pass for a request to be intercepted. If a request is not intercepted, a real request will be attempted.
\n| Matcher type | \nCondition to pass | \n
|---|---|
string | \nExact match against string | \n
RegExp | \nRegex must pass | \n
Function | \nFunction must return true | \n
Arguments:
\nMockPoolInterceptOptions - Interception options.Returns: MockInterceptor corresponding to the input options.
Closes the mock pool and de-registers from associated MockAgent.
\nReturns: Promise<void>
import { MockAgent } from 'undici'\n\nconst mockAgent = new MockAgent()\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nawait mockPool.close()\nImplements Dispatcher.dispatch(options, handlers).
See Dispatcher.request(options [, callback]).
import { MockAgent } from 'undici'\n\nconst mockAgent = new MockAgent()\n\nconst mockPool = mockAgent.get('http://localhost:3000')\nmockPool.intercept({\n path: '/foo',\n method: 'GET',\n}).reply(200, 'foo')\n\nconst {\n statusCode,\n body\n} = await mockPool.request({\n origin: 'http://localhost:3000',\n path: '/foo',\n method: 'GET'\n})\n\nconsole.log('response received', statusCode) // response received 200\n\nfor await (const data of body) {\n console.log('data', data.toString('utf8')) // data foo\n}\nThis method cleans up all the prepared mocks.
\nReturns: void
string | RegExp | (path: string) => boolean - a matcher for the HTTP request path. When a RegExp or callback is used, it will match against the request path including all query parameters in alphabetical order. When a string is provided, the query parameters can be conveniently specified through the MockPoolInterceptOptions.query setting.string | RegExp | (method: string) => boolean - (optional) - a matcher for the HTTP request method. Defaults to GET.string | RegExp | (body: string) => boolean - (optional) - a matcher for the HTTP request body.Record<string, string | RegExp | (body: string) => boolean> - (optional) - a matcher for the HTTP request headers. To be intercepted, a request must match all defined headers. Extra headers not defined here may (or may not) be included in the request and do not affect the interception in any way.Record<string, any> | null - (optional) - a matcher for the HTTP request query string params. Only applies when a string was provided for MockPoolInterceptOptions.path.boolean - (optional) - set to true if the matcher should also match by ignoring potential trailing slashes in MockPoolInterceptOptions.path.We can define the behaviour of an intercepted request with the following options.
\n(statusCode: number, replyData: string | Buffer | object | MockInterceptor.MockResponseDataHandler, responseOptions?: MockResponseOptions) => MockScope - define a reply for a matching request. You can define the replyData as a callback to read incoming request data. Default for responseOptions is {}.(callback: MockInterceptor.MockReplyOptionsCallback) => MockScope - define a reply for a matching request, allowing dynamic mocking of all reply options rather than just the data.(error: Error) => MockScope - define an error for a matching request to throw.(headers: Record<string, string>) => MockInterceptor - define default headers to be included in subsequent replies. These are in addition to headers on a specific reply.(trailers: Record<string, string>) => MockInterceptor - define default trailers to be included in subsequent replies. These are in addition to trailers on a specific reply.() => MockInterceptor - define automatically calculated content-length headers to be included in subsequent replies.The reply data of an intercepted request may either be a string, buffer, or JavaScript object. Objects are converted to JSON while strings and buffers are sent as-is.
\nBy default, reply and replyWithError define the behaviour for the first matching request only. Subsequent requests will not be affected (this can be changed using the returned MockScope).
Record<string, string> - headers to be included on the mocked reply.Record<string, string> - trailers to be included on the mocked reply.A MockScope is associated with a single MockInterceptor. With this, we can configure the default behaviour of an intercepted reply.
(waitInMs: number) => MockScope - delay the associated reply by a set amount in ms.() => MockScope - any matching request will always reply with the defined response indefinitely.(repeatTimes: number) => MockScope - any matching request will reply with the defined response a fixed amount of times. This is overridden by persist.import { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\n// MockPool\nconst mockPool = mockAgent.get('http://localhost:3000')\nmockPool.intercept({ path: '/foo' }).reply(200, 'foo')\n\nconst {\n statusCode,\n body\n} = await request('http://localhost:3000/foo')\n\nconsole.log('response received', statusCode) // response received 200\n\nfor await (const data of body) {\n console.log('data', data.toString('utf8')) // data foo\n}\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/echo',\n method: 'GET',\n headers: {\n 'User-Agent': 'undici',\n Host: 'example.com'\n }\n}).reply(200, ({ headers }) => ({ message: headers.get('message') }))\n\nconst { statusCode, body, headers } = await request('http://localhost:3000', {\n headers: {\n message: 'hello world!'\n }\n})\n\nconsole.log('response received', statusCode) // response received 200\nconsole.log('headers', headers) // { 'content-type': 'application/json' }\n\nfor await (const data of body) {\n console.log('data', data.toString('utf8')) // { \"message\":\"hello world!\" }\n}\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/echo',\n method: 'GET',\n headers: {\n 'User-Agent': 'undici',\n Host: 'example.com'\n }\n}).reply(({ headers }) => ({ statusCode: 200, data: { message: headers.get('message') }})))\n\nconst { statusCode, body, headers } = await request('http://localhost:3000', {\n headers: {\n message: 'hello world!'\n }\n})\n\nconsole.log('response received', statusCode) // response received 200\nconsole.log('headers', headers) // { 'content-type': 'application/json' }\n\nfor await (const data of body) {\n console.log('data', data.toString('utf8')) // { \"message\":\"hello world!\" }\n}\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).reply(200, 'foo')\n\nmockPool.intercept({\n path: '/hello',\n method: 'GET',\n}).reply(200, 'hello')\n\nconst result1 = await request('http://localhost:3000/foo')\n\nconsole.log('response received', result1.statusCode) // response received 200\n\nfor await (const data of result1.body) {\n console.log('data', data.toString('utf8')) // data foo\n}\n\nconst result2 = await request('http://localhost:3000/hello')\n\nconsole.log('response received', result2.statusCode) // response received 200\n\nfor await (const data of result2.body) {\n console.log('data', data.toString('utf8')) // data hello\n}\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo?hello=there&see=ya',\n method: 'POST',\n body: 'form1=data1&form2=data2',\n headers: {\n 'User-Agent': 'undici',\n Host: 'example.com'\n }\n}).reply(200, { foo: 'bar' }, {\n headers: { 'content-type': 'application/json' },\n trailers: { 'Content-MD5': 'test' }\n})\n\nconst {\n statusCode,\n headers,\n trailers,\n body\n} = await request('http://localhost:3000/foo?hello=there&see=ya', {\n method: 'POST',\n body: 'form1=data1&form2=data2',\n headers: {\n foo: 'bar',\n 'User-Agent': 'undici',\n Host: 'example.com'\n }\n })\n\nconsole.log('response received', statusCode) // response received 200\nconsole.log('headers', headers) // { 'content-type': 'application/json' }\n\nfor await (const data of body) {\n console.log('data', data.toString('utf8')) // '{\"foo\":\"bar\"}'\n}\n\nconsole.log('trailers', trailers) // { 'content-md5': 'test' }\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: /^GET$/,\n body: (value) => value === 'form=data',\n headers: {\n 'User-Agent': 'undici',\n Host: /^example.com$/\n }\n}).reply(200, 'foo')\n\nconst {\n statusCode,\n body\n} = await request('http://localhost:3000/foo', {\n method: 'GET',\n body: 'form=data',\n headers: {\n foo: 'bar',\n 'User-Agent': 'undici',\n Host: 'example.com'\n }\n})\n\nconsole.log('response received', statusCode) // response received 200\n\nfor await (const data of body) {\n console.log('data', data.toString('utf8')) // data foo\n}\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).replyWithError(new Error('kaboom'))\n\ntry {\n await request('http://localhost:3000/foo', {\n method: 'GET'\n })\n} catch (error) {\n console.error(error) // TypeError: fetch failed\n console.error(error.cause) // Error: kaboom\n}\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).defaultReplyHeaders({ foo: 'bar' })\n .reply(200, 'foo')\n\nconst { headers } = await request('http://localhost:3000/foo')\n\nconsole.log('headers', headers) // headers { foo: 'bar' }\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).defaultReplyTrailers({ foo: 'bar' })\n .reply(200, 'foo')\n\nconst { trailers } = await request('http://localhost:3000/foo')\n\nconsole.log('trailers', trailers) // trailers { foo: 'bar' }\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).replyContentLength().reply(200, 'foo')\n\nconst { headers } = await request('http://localhost:3000/foo')\n\nconsole.log('headers', headers) // headers { 'content-length': '3' }\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).replyContentLength().reply(200, { foo: 'bar' })\n\nconst { headers } = await request('http://localhost:3000/foo')\n\nconsole.log('headers', headers) // headers { 'content-length': '13' }\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).reply(200, 'foo').persist()\n\nconst result1 = await request('http://localhost:3000/foo')\n// Will match and return mocked data\n\nconst result2 = await request('http://localhost:3000/foo')\n// Will match and return mocked data\n\n// Etc\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nmockPool.intercept({\n path: '/foo',\n method: 'GET'\n}).reply(200, 'foo').times(2)\n\nconst result1 = await request('http://localhost:3000/foo')\n// Will match and return mocked data\n\nconst result2 = await request('http://localhost:3000/foo')\n// Will match and return mocked data\n\nconst result3 = await request('http://localhost:3000/foo')\n// Will not match and make attempt a real request\nimport { MockAgent, setGlobalDispatcher, request } from 'undici'\nimport querystring from 'querystring'\n\nconst mockAgent = new MockAgent()\nsetGlobalDispatcher(mockAgent)\n\nconst mockPool = mockAgent.get('http://localhost:3000')\n\nconst matchPath = requestPath => {\n const [pathname, search] = requestPath.split('?')\n const requestQuery = querystring.parse(search)\n\n if (!pathname.startsWith('/foo')) {\n return false\n }\n\n if (!Object.keys(requestQuery).includes('foo') || requestQuery.foo !== 'bar') {\n return false\n }\n\n return true\n}\n\nmockPool.intercept({\n path: matchPath,\n method: 'GET'\n}).reply(200, 'foo')\n\nconst result = await request('http://localhost:3000/foo?foo=bar')\n// Will match and return mocked data\n