@clickup/rest-client 2.10.294 → 2.11.0

package/docs/classes/RestRequest.md

@@ -1,6 +1,6 @@
 [@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestRequest
 
-# Class: RestRequest<TAssertShape\>
+# Class: RestRequest\<TAssertShape\>
 
 Type TAssertShape allows to limit json()'s assert callbacks to only those
 which return an object compatible with TAssertShape.
@@ -15,7 +15,7 @@ which return an object compatible with TAssertShape.
 
 ### constructor
 
-• **new RestRequest**<`TAssertShape`\>(`options`, `method`, `url`, `headers`, `body`, `shape?`)
+• **new RestRequest**\<`TAssertShape`\>(`options`, `method`, `url`, `headers`, `body`, `shape?`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
 
 #### Type parameters
 
@@ -34,6 +34,10 @@ which return an object compatible with TAssertShape.
 | `body` | `string` \| `Buffer` \| `ReadableStream` |
 | `shape?` | `string` |
 
+#### Returns
+
+[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
+
 #### Defined in
 
 [src/RestRequest.ts:30](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L30)
@@ -102,7 +106,7 @@ ___
 
 ### setHeader
 
-▸ **setHeader**(`name`, `value`): [`RestRequest`](RestRequest.md)<`TAssertShape`\>
+▸ **setHeader**(`name`, `value`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
 
 Modifies the request by adding a custom HTTP header.
 
@@ -115,7 +119,7 @@ Modifies the request by adding a custom HTTP header.
 
 #### Returns
 
-[`RestRequest`](RestRequest.md)<`TAssertShape`\>
+[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
 
 #### Defined in
 
@@ -125,7 +129,7 @@ ___
 
 ### setOptions
 
-▸ **setOptions**(`options`): [`RestRequest`](RestRequest.md)<`TAssertShape`\>
+▸ **setOptions**(`options`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
 
 Modifies the request by adding a custom request option.
 
@@ -133,11 +137,11 @@ Modifies the request by adding a custom request option.
 
 | Name | Type |
 | :------ | :------ |
-| `options` | `Partial`<[`RestOptions`](../interfaces/RestOptions.md)\> |
+| `options` | `Partial`\<[`RestOptions`](../interfaces/RestOptions.md)\> |
 
 #### Returns
 
-[`RestRequest`](RestRequest.md)<`TAssertShape`\>
+[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
 
 #### Defined in
 
@@ -147,7 +151,7 @@ ___
 
 ### setDebug
 
-▸ **setDebug**(`flag?`): [`RestRequest`](RestRequest.md)<`TAssertShape`\>
+▸ **setDebug**(`flag?`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
 
 Forces RestClient to debug-output the request and response to console.
 Never use in production.
@@ -160,7 +164,7 @@ Never use in production.
 
 #### Returns
 
-[`RestRequest`](RestRequest.md)<`TAssertShape`\>
+[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
 
 #### Defined in
 
@@ -170,7 +174,7 @@ ___
 
 ### json
 
-▸ **json**<`TJson`\>(`assert`, `...checkers`): `Promise`<`TJson`\>
+▸ **json**\<`TJson`\>(`assert`, `...checkers`): `Promise`\<`TJson`\>
 
 Sends the request and reads the response a JSON. In absolute most of the
 cases, this method is used to reach API responses. The assert callback
@@ -187,12 +191,12 @@ not let people to do anti-patterns.
 
 | Name | Type |
 | :------ | :------ |
-| `assert` | { `mask`: (`obj`: `any`) => `TJson`  } \| { `$assert`: (`obj`: `any`) => `TJson`  } \| (`obj`: `any`) => `TJson` |
+| `assert` | \{ `mask`: (`obj`: `any`) => `TJson`  } \| \{ `$assert`: (`obj`: `any`) => `TJson`  } \| (`obj`: `any`) => `TJson` |
 | `...checkers` | (`json`: `TJson`, `res`: [`RestResponse`](RestResponse.md)) => ``false`` \| `Error`[] |
 
 #### Returns
 
-`Promise`<`TJson`\>
+`Promise`\<`TJson`\>
 
 #### Defined in
 
@@ -202,13 +206,13 @@ ___
 
 ### text
 
-▸ **text**(): `Promise`<`string`\>
+▸ **text**(): `Promise`\<`string`\>
 
 Sends the request and returns plaintext response.
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`string`\>
 
 #### Defined in
 
@@ -218,7 +222,7 @@ ___
 
 ### response
 
-▸ **response**(): `Promise`<[`RestResponse`](RestResponse.md)\>
+▸ **response**(): `Promise`\<[`RestResponse`](RestResponse.md)\>
 
 Returns the entire RestResponse object with response status and headers
 information in it. Try to minimize usage of this method, because it doesn't
@@ -226,7 +230,7 @@ make any assumptions on the response structure.
 
 #### Returns
 
-`Promise`<[`RestResponse`](RestResponse.md)\>
+`Promise`\<[`RestResponse`](RestResponse.md)\>
 
 #### Defined in
 
@@ -236,7 +240,7 @@ ___
 
 ### stream
 
-▸ **stream**(`preloadChars?`): `Promise`<[`RestStream`](RestStream.md)\>
+▸ **stream**(`preloadChars?`): `Promise`\<[`RestStream`](RestStream.md)\>
 
 Sends the requests and returns RestStream object. You MUST iterate over
 this object entirely (or call its return() method), otherwise the
@@ -250,7 +254,7 @@ connection will remain dangling.
 
 #### Returns
 
-`Promise`<[`RestStream`](RestStream.md)\>
+`Promise`\<[`RestStream`](RestStream.md)\>
 
 #### Defined in
 

package/docs/classes/RestResponse.md

@@ -16,19 +16,23 @@ body and make it a part of RestResponse abstraction.
 
 ### constructor
 
-• **new RestResponse**(`req`, `agent`, `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:18](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L18)
@@ -37,7 +41,7 @@ body and make it a part of RestResponse abstraction.
 
 ### req
 
-• `Readonly` **req**: [`RestRequest`](RestRequest.md)<`any`\>
+• `Readonly` **req**: [`RestRequest`](RestRequest.md)\<`any`\>
 
 #### Defined in
 

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

@@ -5,36 +5,31 @@
 Pacer is a class which allows to pace requests on some resource identified by
 the instance of this class.
 
-## Implemented by
-
-- [`PacerComposite`](../classes/PacerComposite.md)
-- [`PacerQPS`](../classes/PacerQPS.md)
-
 ## Properties
 
-### name
+### key
 
-• `Readonly` **name**: `string`
+• `Readonly` **key**: `string`
 
 Human readable name of the pacer, used when composing multiple pacers.
 
 #### Defined in
 
-[src/pacers/Pacer.ts:15](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L15)
+[src/middlewares/paceRequests.ts:12](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L12)
 
 ## Methods
 
-### touch
+### pace
 
-▸ **touch**(): `Promise`<[`PacerDelay`](PacerDelay.md)\>
+▸ **pace**(): `Promise`\<[`PacerOutcome`](PacerOutcome.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`\<[`PacerOutcome`](PacerOutcome.md)\>
 
 #### Defined in
 
-[src/pacers/Pacer.ts:21](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L21)
+[src/middlewares/paceRequests.ts:18](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L18)

package/docs/interfaces/PacerOutcome.md

@@ -0,0 +1,25 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerOutcome
+
+# Interface: PacerOutcome
+
+A result of some Pacer work.
+
+## Properties
+
+### delayMs
+
+• **delayMs**: `number`
+
+#### Defined in
+
+[src/middlewares/paceRequests.ts:25](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L25)
+
+___
+
+### reason
+
+• **reason**: `string`
+
+#### Defined in
+
+[src/middlewares/paceRequests.ts:26](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L26)

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

@@ -79,8 +79,8 @@ 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
 
@@ -126,6 +126,18 @@ addresses are allowed.
 
 ___
 
+### responseEncoding
+
+• **responseEncoding**: `undefined` \| `BufferEncoding`
+
+Overrides the default encoding heuristics for responses.
+
+#### Defined in
+
+[src/RestOptions.ts:100](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L100)
+
+___
+
 ### isDebug
 
 • **isDebug**: `boolean`
@@ -134,7 +146,7 @@ If true, logs request-response pairs to console.
 
 #### Defined in
 
-[src/RestOptions.ts:100](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L100)
+[src/RestOptions.ts:102](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L102)
 
 ___
 
@@ -153,7 +165,7 @@ Sets Keep-Alive parameters (persistent connections).
 
 #### Defined in
 
-[src/RestOptions.ts:104](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L104)
+[src/RestOptions.ts:106](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L106)
 
 ___
 
@@ -165,7 +177,7 @@ When resolving DNS, use IPv4, IPv6 or both (see dns.lookup() docs).
 
 #### Defined in
 
-[src/RestOptions.ts:112](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L112)
+[src/RestOptions.ts:114](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L114)
 
 ___
 
@@ -177,7 +189,7 @@ Max timeout to wait for a response.
 
 #### Defined in
 
-[src/RestOptions.ts:114](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L114)
+[src/RestOptions.ts:116](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L116)
 
 ___
 
@@ -185,13 +197,13 @@ ___
 
 • **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`
 
-Logger to be used for each responses (including retried) plus for backoff
-delay events logging.
-
 ##### Parameters
 
 | Name | Type |
@@ -204,7 +216,7 @@ delay events logging.
 
 #### Defined in
 
-[src/RestOptions.ts:117](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L117)
+[src/RestOptions.ts:119](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L119)
 
 ___
 
@@ -216,7 +228,7 @@ Middlewares to wrap requests. May alter both request and response.
 
 #### Defined in
 
-[src/RestOptions.ts:119](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L119)
+[src/RestOptions.ts:121](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L121)
 
 ___
 
@@ -224,10 +236,6 @@ ___
 
 • **isSuccessResponse**: (`res`: [`RestResponse`](../classes/RestResponse.md)) => ``"SUCCESS"`` \| ``"THROW"`` \| ``"BEST_EFFORT"``
 
-#### Type declaration
-
-▸ (`res`): ``"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
@@ -241,6 +249,10 @@ remote API is that weird. Return values:
   performed to determine is the error is retriable, is OAuth token good,
   and etc.
 
+#### Type declaration
+
+▸ (`res`): ``"SUCCESS"`` \| ``"THROW"`` \| ``"BEST_EFFORT"``
+
 ##### Parameters
 
 | Name | Type |
@@ -253,7 +265,7 @@ remote API is that weird. Return values:
 
 #### Defined in
 
-[src/RestOptions.ts:132](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L132)
+[src/RestOptions.ts:134](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L134)
 
 ___
 
@@ -261,10 +273,6 @@ ___
 
 • **isRateLimitError**: (`res`: [`RestResponse`](../classes/RestResponse.md)) => `number` \| ``"BEST_EFFORT"`` \| ``"SOMETHING_ELSE"`` \| ``"RATE_LIMIT"``
 
-#### Type declaration
-
-▸ (`res`): `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
@@ -275,6 +283,10 @@ 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"``
+
 ##### Parameters
 
 | Name | Type |
@@ -287,7 +299,7 @@ contradictory information; then isRateLimitError wins.
 
 #### Defined in
 
-[src/RestOptions.ts:142](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L142)
+[src/RestOptions.ts:144](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L144)
 
 ___
 
@@ -295,13 +307,13 @@ ___
 
 • **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`
 
-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.
-
 ##### Parameters
 
 | Name | Type |
@@ -314,7 +326,7 @@ not, the response ought to be either success or some other error.
 
 #### Defined in
 
-[src/RestOptions.ts:147](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L147)
+[src/RestOptions.ts:149](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L149)
 
 ___
 
@@ -322,10 +334,6 @@ ___
 
 • **isRetriableError**: (`res`: [`RestResponse`](../classes/RestResponse.md), `_error`: `any`) => `number` \| ``"BEST_EFFORT"`` \| ``"NEVER_RETRY"`` \| ``"RETRY"``
 
-#### Type declaration
-
-▸ (`res`, `_error`): `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
@@ -334,6 +342,10 @@ 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"``
+
 ##### Parameters
 
 | Name | Type |
@@ -347,4 +359,4 @@ retry will happen in not less than this number of milliseconds.
 
 #### Defined in
 
-[src/RestOptions.ts:155](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L155)
+[src/RestOptions.ts:157](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L157)