UNPKG

@clickup/rest-client

Version:

A syntax sugar tool around Node fetch() API, tailored to work with TypeScript and response validators

github.com/clickup/rest-client

clickup/rest-client

36 lines (19 loc) • 871 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
[@clickup/rest-client](../README.md) / [Exports](../modules.md) / Pacer # Interface: Pacer Pacer is a class which allows to pace requests on some resource identified by the instance of this class. ## Properties ### key • `Readonly` **key**: `string` Human readable name of the pacer, used when composing multiple pacers. #### Defined in [src/middlewares/paceRequests.ts:12](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L12) ## Methods ### pace ▸ **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`\<[`PacerOutcome`](PacerOutcome.md)\> #### Defined in [src/middlewares/paceRequests.ts:18](https://github.com/clickup/rest-client/blob/master/src/middlewares/paceRequests.ts#L18)