@clickup/rest-client 2.10.293 → 2.10.296

package/docs/classes/RestResponse.md

@@ -16,31 +16,46 @@ body and make it a part of RestResponse abstraction.
 
 ### constructor
 
-• **new RestResponse**(`req`, `status`, `headers`, `text`, `textIsPartial`)
+• **new RestResponse**(`req`, `agent`, `status`, `headers`, `text`, `textIsPartial`): [`RestResponse`](RestResponse.md)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `req` | [`RestRequest`](RestRequest.md)<`any`\> |
+| `req` | [`RestRequest`](RestRequest.md)\<`any`\> |
+| `agent` | ``null`` \| `Agent` |
 | `status` | `number` |
 | `headers` | `Headers` |
 | `text` | `string` |
 | `textIsPartial` | `boolean` |
 
+#### Returns
+
+[`RestResponse`](RestResponse.md)
+
 #### Defined in
 
-[src/RestResponse.ts:17](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L17)
+[src/RestResponse.ts:18](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L18)
 
 ## Properties
 
 ### req
 
-• `Readonly` **req**: [`RestRequest`](RestRequest.md)<`any`\>
+• `Readonly` **req**: [`RestRequest`](RestRequest.md)\<`any`\>
 
 #### Defined in
 
-[src/RestResponse.ts:18](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L18)
+[src/RestResponse.ts:19](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L19)
+
+___
+
+### agent
+
+• `Readonly` **agent**: ``null`` \| `Agent`
+
+#### Defined in
+
+[src/RestResponse.ts:20](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L20)
 
 ___
 
@@ -50,7 +65,7 @@ ___
 
 #### Defined in
 
-[src/RestResponse.ts:19](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L19)
+[src/RestResponse.ts:21](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L21)
 
 ___
 
@@ -60,7 +75,7 @@ ___
 
 #### Defined in
 
-[src/RestResponse.ts:20](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L20)
+[src/RestResponse.ts:22](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L22)
 
 ___
 
@@ -70,7 +85,7 @@ ___
 
 #### Defined in
 
-[src/RestResponse.ts:21](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L21)
+[src/RestResponse.ts:23](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L23)
 
 ___
 
@@ -80,7 +95,7 @@ ___
 
 #### Defined in
 
-[src/RestResponse.ts:22](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L22)
+[src/RestResponse.ts:24](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L24)
 
 ## Accessors
 
@@ -107,4 +122,4 @@ RestRequest.json() instead.
 
 #### Defined in
 
-[src/RestResponse.ts:40](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L40)
+[src/RestResponse.ts:42](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L42)

package/docs/classes/RestResponseError.md

@@ -22,7 +22,7 @@
 
 ### constructor
 
-• **new RestResponseError**(`message`, `res`)
+• **new RestResponseError**(`message`, `res`): [`RestResponseError`](RestResponseError.md)
 
 #### Parameters
 
@@ -31,6 +31,10 @@
 | `message` | `string` |
 | `res` | [`RestResponse`](RestResponse.md) |
 
+#### Returns
+
+[`RestResponseError`](RestResponseError.md)
+
 #### Overrides
 
 [RestError](RestError.md).[constructor](RestError.md#constructor)

package/docs/classes/RestRetriableError.md

@@ -12,7 +12,7 @@
 
 ### constructor
 
-• **new RestRetriableError**(`message`, `delayMs`, `res`)
+• **new RestRetriableError**(`message`, `delayMs`, `res`): [`RestRetriableError`](RestRetriableError.md)
 
 #### Parameters
 
@@ -22,6 +22,10 @@
 | `delayMs` | `number` |
 | `res` | [`RestResponse`](RestResponse.md) |
 
+#### Returns
+
+[`RestRetriableError`](RestRetriableError.md)
+
 #### Overrides
 
 [RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)
@@ -136,4 +140,4 @@ ___
 
 #### Defined in
 
-[src/errors/RestRetriableError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestRetriableError.ts#L5)
+[src/errors/RestRetriableError.ts:7](https://github.com/clickup/rest-client/blob/master/src/errors/RestRetriableError.ts#L7)

package/docs/classes/RestStream.md

@@ -15,7 +15,7 @@ use something like `Buffer.from(responseText, "binary")`.
 
 ### constructor
 
-• **new RestStream**(`res`, `readerIterable`)
+• **new RestStream**(`res`, `readerIterable`): [`RestStream`](RestStream.md)
 
 #### Parameters
 
@@ -23,7 +23,11 @@ use something like `Buffer.from(responseText, "binary")`.
 | :------ | :------ |
 | `res` | [`RestResponse`](RestResponse.md) |
 | `readerIterable` | `Object` |
-| `readerIterable.[asyncIterator]` | () => `AsyncGenerator`<`string`, `void`, `unknown`\> |
+| `readerIterable.[asyncIterator]` | () => `AsyncGenerator`\<`string`, `void`, `unknown`\> |
+
+#### Returns
+
+[`RestStream`](RestStream.md)
 
 #### Defined in
 
@@ -43,7 +47,7 @@ use something like `Buffer.from(responseText, "binary")`.
 
 ### consumeReturningPrefix
 
-▸ **consumeReturningPrefix**(`maxChars`): `Promise`<`string`\>
+▸ **consumeReturningPrefix**(`maxChars`): `Promise`\<`string`\>
 
 Reads the prefix of the stream. Closes the connection after the read is
 done in all cases, so safe to be used to e.g. receive a trimmed response.
@@ -56,7 +60,7 @@ done in all cases, so safe to be used to e.g. receive a trimmed response.
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`string`\>
 
 #### Defined in
 
@@ -66,13 +70,13 @@ ___
 
 ### close
 
-▸ **close**(): `Promise`<`void`\>
+▸ **close**(): `Promise`\<`void`\>
 
 Closes the connection.
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Defined in
 
@@ -82,7 +86,7 @@ ___
 
 ### [asyncIterator]
 
-▸ **[asyncIterator]**(): `AsyncGenerator`<`string`, `void`, `unknown`\>
+▸ **[asyncIterator]**(): `AsyncGenerator`\<`string`, `void`, `unknown`\>
 
 Allows to iterate over the entire stream of data. You must consume the
 entire iterable or at least call this.close(), otherwise the connection may
@@ -90,7 +94,7 @@ remain open.
 
 #### Returns
 
-`AsyncGenerator`<`string`, `void`, `unknown`\>
+`AsyncGenerator`\<`string`, `void`, `unknown`\>
 
 #### Defined in
 

package/docs/classes/RestTimeoutError.md

@@ -12,7 +12,7 @@
 
 ### constructor
 
-• **new RestTimeoutError**(`message`, `res`)
+• **new RestTimeoutError**(`message`, `res`): [`RestTimeoutError`](RestTimeoutError.md)
 
 #### Parameters
 
@@ -21,6 +21,10 @@
 | `message` | `string` |
 | `res` | [`RestResponse`](RestResponse.md) |
 
+#### Returns
+
+[`RestTimeoutError`](RestTimeoutError.md)
+
 #### Inherited from
 
 [RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)

package/docs/classes/RestTokenInvalidError.md

@@ -12,7 +12,7 @@
 
 ### constructor
 
-• **new RestTokenInvalidError**(`humanReason`, `res`)
+• **new RestTokenInvalidError**(`humanReason`, `res`): [`RestTokenInvalidError`](RestTokenInvalidError.md)
 
 #### Parameters
 
@@ -21,6 +21,10 @@
 | `humanReason` | `string` |
 | `res` | [`RestResponse`](RestResponse.md) |
 
+#### Returns
+
+[`RestTokenInvalidError`](RestTokenInvalidError.md)
+
 #### Overrides
 
 [RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)
@@ -135,4 +139,4 @@ ___
 
 #### Defined in
 
-[src/errors/RestTokenInvalidError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestTokenInvalidError.ts#L5)
+[src/errors/RestTokenInvalidError.ts:6](https://github.com/clickup/rest-client/blob/master/src/errors/RestTokenInvalidError.ts#L6)

package/docs/interfaces/Middleware.md

@@ -9,18 +9,18 @@ request processing.
 
 ### Middleware
 
-▸ **Middleware**(`req`, `next`): `Promise`<[`RestResponse`](../classes/RestResponse.md)\>
+▸ **Middleware**(`req`, `next`): `Promise`\<[`RestResponse`](../classes/RestResponse.md)\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `req` | [`RestRequest`](../classes/RestRequest.md)<`any`\> |
-| `next` | (`req`: [`RestRequest`](../classes/RestRequest.md)<`any`\>) => `Promise`<[`RestResponse`](../classes/RestResponse.md)\> |
+| `req` | [`RestRequest`](../classes/RestRequest.md)\<`any`\> |
+| `next` | (`req`: [`RestRequest`](../classes/RestRequest.md)\<`any`\>) => `Promise`\<[`RestResponse`](../classes/RestResponse.md)\> |
 
 #### Returns
 
-`Promise`<[`RestResponse`](../classes/RestResponse.md)\>
+`Promise`\<[`RestResponse`](../classes/RestResponse.md)\>
 
 #### Defined in
 

package/docs/interfaces/Pacer.md

@@ -26,14 +26,14 @@ Human readable name of the pacer, used when composing multiple pacers.
 
 ### touch
 
-▸ **touch**(): `Promise`<[`PacerDelay`](PacerDelay.md)\>
+▸ **touch**(): `Promise`\<[`PacerDelay`](PacerDelay.md)\>
 
 Signals that we're about to send a request. Returns the delay we need to
 wait for before actually sending.
 
 #### Returns
 
-`Promise`<[`PacerDelay`](PacerDelay.md)\>
+`Promise`\<[`PacerDelay`](PacerDelay.md)\>
 
 #### Defined in
 

package/docs/interfaces/PacerQPSBackend.md

@@ -18,7 +18,7 @@ Resource key which this backend is operating on.
 
 ### push
 
-▸ **push**(`props`): `Promise`<{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
+▸ **push**(`props`): `Promise`\<\{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
 
 Maintains the array of numbers somewhere in memory (time-value pairs),
 inserts a new time-value pair to the end of this list, and removes all the
@@ -37,7 +37,7 @@ array and some central tendency statistics about its values.
 
 #### Returns
 
-`Promise`<{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
+`Promise`\<\{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
 
 #### Defined in
 

package/docs/interfaces/RestLogEvent.md

@@ -18,7 +18,7 @@ ___
 
 ### req
 
-• **req**: [`RestRequest`](../classes/RestRequest.md)<`any`\>
+• **req**: [`RestRequest`](../classes/RestRequest.md)\<`any`\>
 
 #### Defined in
 

package/docs/interfaces/RestOptions.md

@@ -16,7 +16,7 @@ web app, and we don't want to retry them.
 
 #### Defined in
 
-[src/RestOptions.ts:69](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L69)
+[src/RestOptions.ts:70](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L70)
 
 ___
 
@@ -28,7 +28,7 @@ How much time to wait by default on the 1st retry attempt.
 
 #### Defined in
 
-[src/RestOptions.ts:71](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L71)
+[src/RestOptions.ts:72](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L72)
 
 ___
 
@@ -40,7 +40,7 @@ How much to increase the retry delay on each retry.
 
 #### Defined in
 
-[src/RestOptions.ts:73](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L73)
+[src/RestOptions.ts:74](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L74)
 
 ___
 
@@ -53,7 +53,7 @@ Use this fraction (random) of the current retry delay to jitter both ways
 
 #### Defined in
 
-[src/RestOptions.ts:76](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L76)
+[src/RestOptions.ts:77](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L77)
 
 ___
 
@@ -65,7 +65,7 @@ Maximum delay between each retry.
 
 #### Defined in
 
-[src/RestOptions.ts:78](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L78)
+[src/RestOptions.ts:79](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L79)
 
 ___
 
@@ -79,12 +79,12 @@ A logic which runs on different IO stages (delay and heartbeats).
 
 | Name | Type |
 | :------ | :------ |
-| `heartbeat` | () => `Promise`<`void`\> |
-| `delay` | (`ms`: `number`) => `Promise`<`void`\> |
+| `heartbeat` | () => `Promise`\<`void`\> |
+| `delay` | (`ms`: `number`) => `Promise`\<`void`\> |
 
 #### Defined in
 
-[src/RestOptions.ts:80](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L80)
+[src/RestOptions.ts:81](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L81)
 
 ___
 
@@ -96,7 +96,7 @@ Allows to limit huge requests and throw instead.
 
 #### Defined in
 
-[src/RestOptions.ts:91](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L91)
+[src/RestOptions.ts:92](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L92)
 
 ___
 
@@ -109,7 +109,7 @@ response or not.
 
 #### Defined in
 
-[src/RestOptions.ts:94](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L94)
+[src/RestOptions.ts:95](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L95)
 
 ___
 
@@ -122,7 +122,7 @@ addresses are allowed.
 
 #### Defined in
 
-[src/RestOptions.ts:97](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L97)
+[src/RestOptions.ts:98](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L98)
 
 ___
 
@@ -134,7 +134,7 @@ If true, logs request-response pairs to console.
 
 #### Defined in
 
-[src/RestOptions.ts:99](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L99)
+[src/RestOptions.ts:100](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L100)
 
 ___
 
@@ -148,13 +148,12 @@ Sets Keep-Alive parameters (persistent connections).
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `timeout` | `number` | A hint to the server, how much time to keep the connection alive. Not all the servers respect it though (e.g. nginx and express do not). |
-| `max` | `number` | How many requests are allowed to be processed in one connection. |
+| `timeoutMs` | `number` | How much time to keep an idle connection alive in the pool. If 0, closes the connection immediately after the response. |
 | `maxSockets?` | `number` | How many sockets at maximum will be kept open. |
 
 #### Defined in
 
-[src/RestOptions.ts:103](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L103)
+[src/RestOptions.ts:104](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L104)
 
 ___
 
@@ -166,7 +165,7 @@ When resolving DNS, use IPv4, IPv6 or both (see dns.lookup() docs).
 
 #### Defined in
 
-[src/RestOptions.ts:113](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L113)
+[src/RestOptions.ts:112](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L112)
 
 ___
 
@@ -178,7 +177,7 @@ Max timeout to wait for a response.
 
 #### Defined in
 
-[src/RestOptions.ts:115](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L115)
+[src/RestOptions.ts:114](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L114)
 
 ___
 
@@ -186,6 +185,9 @@ ___
 
 • **logger**: (`event`: [`RestLogEvent`](RestLogEvent.md)) => `void`
 
+Logger to be used for each responses (including retried) plus for backoff
+delay events logging.
+
 #### Type declaration
 
 ▸ (`event`): `void`
@@ -205,7 +207,7 @@ delay events logging.
 
 #### Defined in
 
-[src/RestOptions.ts:118](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L118)
+[src/RestOptions.ts:117](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L117)
 
 ___
 
@@ -217,7 +219,7 @@ Middlewares to wrap requests. May alter both request and response.
 
 #### Defined in
 
-[src/RestOptions.ts:120](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L120)
+[src/RestOptions.ts:119](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L119)
 
 ___
 
@@ -225,6 +227,19 @@ ___
 
 • **isSuccessResponse**: (`res`: [`RestResponse`](../classes/RestResponse.md)) => ``"SUCCESS"`` \| ``"THROW"`` \| ``"BEST_EFFORT"``
 
+If set, makes decision whether the response is successful or not. The
+response will either be returned to the client, or an error will be thrown.
+This allows to treat some non-successful HTTP statuses as success if the
+remote API is that weird. Return values:
+* "SUCCESS" - the request will be considered successful, no further checks
+  will be performed;
+* "BEST_EFFORT" - inconclusive, the request may be either successful or
+  unsuccessful, additional tests (e.g. will check HTTP status code) will be
+  performed;
+* "THROW" - the request resulted in error. Additional tests will be
+  performed to determine is the error is retriable, is OAuth token good,
+  and etc.
+
 #### Type declaration
 
 ▸ (`res`): ``"SUCCESS"`` \| ``"THROW"`` \| ``"BEST_EFFORT"``
@@ -254,7 +269,7 @@ remote API is that weird. Return values:
 
 #### Defined in
 
-[src/RestOptions.ts:134](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L134)
+[src/RestOptions.ts:132](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L132)
 
 ___
 
@@ -262,6 +277,16 @@ ___
 
 • **isRateLimitError**: (`res`: [`RestResponse`](../classes/RestResponse.md)) => `number` \| ``"BEST_EFFORT"`` \| ``"SOMETHING_ELSE"`` \| ``"RATE_LIMIT"``
 
+Decides whether the response is a rate-limit error or not. Returning
+non-zero value is treated as retry delay (if retries are set up). In case
+the returned value is "SOMETHING_ELSE", the response ought to be either
+success or some other error. Returning "BEST_EFFORT" turns on built-in
+heuristic (e.g. relying on HTTP status code and Retry-After header). In
+case we've made a decision that it's a rate limited error, the request is
+always retried; this covers a very common case when we have both
+isRateLimitError and isRetriableError handlers set up, and they return
+contradictory information; then isRateLimitError wins.
+
 #### Type declaration
 
 ▸ (`res`): `number` \| ``"BEST_EFFORT"`` \| ``"SOMETHING_ELSE"`` \| ``"RATE_LIMIT"``
@@ -288,7 +313,7 @@ contradictory information; then isRateLimitError wins.
 
 #### Defined in
 
-[src/RestOptions.ts:144](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L144)
+[src/RestOptions.ts:142](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L142)
 
 ___
 
@@ -296,6 +321,9 @@ ___
 
 • **isTokenInvalidError**: (`res`: [`RestResponse`](../classes/RestResponse.md)) => `boolean`
 
+Decides whether the response is a token-invalid error or not. In case it's
+not, the response ought to be either success or some other error.
+
 #### Type declaration
 
 ▸ (`res`): `boolean`
@@ -315,7 +343,7 @@ not, the response ought to be either success or some other error.
 
 #### Defined in
 
-[src/RestOptions.ts:149](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L149)
+[src/RestOptions.ts:147](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L147)
 
 ___
 
@@ -323,6 +351,14 @@ ___
 
 • **isRetriableError**: (`res`: [`RestResponse`](../classes/RestResponse.md), `_error`: `any`) => `number` \| ``"BEST_EFFORT"`` \| ``"NEVER_RETRY"`` \| ``"RETRY"``
 
+Called only if we haven't decided earlier that it's a rate limit error.
+Decides whether the response is a retriable error or not. In case the
+returned value is "NEVER_RETRY", the response ought to be either success or
+some other error, but it's guaranteed that the request won't be retried.
+Returning "BEST_EFFORT" turns on built-in heuristics (e.g. never retry "not
+found" errors). Returning a number is treated as "RETRY", and the next
+retry will happen in not less than this number of milliseconds.
+
 #### Type declaration
 
 ▸ (`res`, `_error`): `number` \| ``"BEST_EFFORT"`` \| ``"NEVER_RETRY"`` \| ``"RETRY"``
@@ -348,4 +384,4 @@ retry will happen in not less than this number of milliseconds.
 
 #### Defined in
 
-[src/RestOptions.ts:157](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L157)
+[src/RestOptions.ts:155](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L155)

package/docs/interfaces/TokenGetter.md

@@ -1,6 +1,6 @@
 [@clickup/rest-client](../README.md) / [Exports](../modules.md) / TokenGetter
 
-# Interface: TokenGetter<TData\>
+# Interface: TokenGetter\<TData\>
 
 A callback which returns access token, possibly after refreshing it, and also
 possibly before a retry on "invalid token" condition. I.e. it can be called
@@ -17,7 +17,7 @@ will be passed as a parameter).
 
 ### TokenGetter
 
-▸ **TokenGetter**(`prevError`): `Promise`<`TData`\>
+▸ **TokenGetter**(`prevError`): `Promise`\<`TData`\>
 
 #### Parameters
 
@@ -27,7 +27,7 @@ will be passed as a parameter).
 
 #### Returns
 
-`Promise`<`TData`\>
+`Promise`\<`TData`\>
 
 #### Defined in
 

package/docs/modules.md

@@ -33,7 +33,7 @@
 
 ### depaginate
 
-▸ **depaginate**<`TItem`, `TCursor`\>(`readFunc`): `AsyncGenerator`<`TItem`, `void`, `undefined`\>
+▸ **depaginate**\<`TItem`, `TCursor`\>(`readFunc`): `AsyncGenerator`\<`TItem`, `void`, `undefined`\>
 
 Keeps calling a function with an updating cursor, and depaginates all the
 results until the cursor returned is null or undefined.
@@ -53,11 +53,11 @@ On each call, the inner function needs to return an array with two elements:
 
 | Name | Type |
 | :------ | :------ |
-| `readFunc` | (`cursor`: `undefined` \| `TCursor`) => `Promise`<[`TItem`[], `undefined` \| ``null`` \| `TCursor`]\> |
+| `readFunc` | (`cursor`: `undefined` \| `TCursor`) => `Promise`\<readonly [`TItem`[], `undefined` \| ``null`` \| `TCursor`]\> |
 
 #### Returns
 
-`AsyncGenerator`<`TItem`, `void`, `undefined`\>
+`AsyncGenerator`\<`TItem`, `void`, `undefined`\>
 
 #### Defined in
 
@@ -76,7 +76,7 @@ Pacer implementations.
 
 | Name | Type |
 | :------ | :------ |
-| `pacer` | ``null`` \| [`Pacer`](interfaces/Pacer.md) \| (`req`: [`RestRequest`](classes/RestRequest.md)<`any`\>) => `Promise`<``null`` \| [`Pacer`](interfaces/Pacer.md)\> |
+| `pacer` | ``null`` \| [`Pacer`](interfaces/Pacer.md) \| (`req`: [`RestRequest`](classes/RestRequest.md)\<`any`\>) => `Promise`\<``null`` \| [`Pacer`](interfaces/Pacer.md)\> |
 
 #### Returns
 

package/jest.config.js

@@ -2,6 +2,9 @@
 module.exports = {
   roots: ["<rootDir>/src"],
   testMatch: ["**/*.test.ts"],
+  clearMocks: true,
+  restoreMocks: true,
+  ...(process.env.IN_JEST_PROJECT ? {} : { forceExit: true }),
   transform: {
     "\\.ts$": "ts-jest",
   },