@clickup/rest-client 2.10.293 → 2.10.296
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.base.js +20 -2
- package/README.md +3 -1
- package/SECURITY.md +39 -0
- package/dist/.eslintcache +1 -0
- package/dist/RestClient.js +1 -1
- package/dist/RestClient.js.map +1 -1
- package/dist/RestOptions.d.ts +5 -7
- package/dist/RestOptions.d.ts.map +1 -1
- package/dist/RestOptions.js +2 -2
- package/dist/RestOptions.js.map +1 -1
- package/dist/RestRequest.d.ts.map +1 -1
- package/dist/RestRequest.js +7 -13
- package/dist/RestRequest.js.map +1 -1
- package/dist/RestResponse.d.ts +4 -1
- package/dist/RestResponse.d.ts.map +1 -1
- package/dist/RestResponse.js +2 -1
- package/dist/RestResponse.js.map +1 -1
- package/dist/RestStream.js.map +1 -1
- package/dist/errors/RestRateLimitError.d.ts.map +1 -1
- package/dist/errors/RestRateLimitError.js.map +1 -1
- package/dist/errors/RestRetriableError.d.ts.map +1 -1
- package/dist/errors/RestRetriableError.js.map +1 -1
- package/dist/errors/RestTokenInvalidError.d.ts.map +1 -1
- package/dist/errors/RestTokenInvalidError.js.map +1 -1
- package/dist/helpers/depaginate.d.ts +1 -1
- package/dist/helpers/depaginate.d.ts.map +1 -1
- package/dist/helpers/depaginate.js.map +1 -1
- package/dist/internal/RestFetchReader.d.ts +9 -2
- package/dist/internal/RestFetchReader.d.ts.map +1 -1
- package/dist/internal/RestFetchReader.js +14 -3
- package/dist/internal/RestFetchReader.js.map +1 -1
- package/dist/internal/RestRangeUploader.js.map +1 -1
- package/dist/internal/calcRetryDelay.js.map +1 -1
- package/dist/internal/inferResBodyEncoding.js.map +1 -1
- package/dist/internal/inspectPossibleJSON.js.map +1 -1
- package/dist/internal/substituteParams.js.map +1 -1
- package/dist/internal/throwIfErrorResponse.js.map +1 -1
- package/dist/middlewares/paceRequests.js.map +1 -1
- package/dist/pacers/PacerQPS.js.map +1 -1
- package/docs/README.md +3 -1
- package/docs/classes/PacerComposite.md +7 -3
- package/docs/classes/PacerQPS.md +7 -3
- package/docs/classes/RestClient.md +32 -28
- package/docs/classes/RestContentSizeOverLimitError.md +5 -1
- package/docs/classes/RestError.md +5 -1
- package/docs/classes/RestRateLimitError.md +6 -2
- package/docs/classes/RestRequest.md +22 -18
- package/docs/classes/RestResponse.md +25 -10
- package/docs/classes/RestResponseError.md +5 -1
- package/docs/classes/RestRetriableError.md +6 -2
- package/docs/classes/RestStream.md +12 -8
- package/docs/classes/RestTimeoutError.md +5 -1
- package/docs/classes/RestTokenInvalidError.md +6 -2
- package/docs/interfaces/Middleware.md +4 -4
- package/docs/interfaces/Pacer.md +2 -2
- package/docs/interfaces/PacerQPSBackend.md +2 -2
- package/docs/interfaces/RestLogEvent.md +1 -1
- package/docs/interfaces/RestOptions.md +59 -23
- package/docs/interfaces/TokenGetter.md +3 -3
- package/docs/modules.md +4 -4
- package/jest.config.js +3 -0
- package/package.json +40 -8
- package/src/RestClient.ts +490 -0
- package/src/RestOptions.ts +186 -0
- package/src/RestRequest.ts +441 -0
- package/src/RestResponse.ts +49 -0
- package/src/RestStream.ts +89 -0
- package/src/errors/RestContentSizeOverLimitError.ts +3 -0
- package/src/errors/RestError.ts +6 -0
- package/src/errors/RestRateLimitError.ts +12 -0
- package/src/errors/RestResponseError.ts +46 -0
- package/src/errors/RestRetriableError.ts +12 -0
- package/src/errors/RestTimeoutError.ts +3 -0
- package/src/errors/RestTokenInvalidError.ts +11 -0
- package/src/helpers/depaginate.ts +37 -0
- package/src/index.ts +50 -0
- package/src/internal/RestFetchReader.ts +188 -0
- package/src/internal/RestRangeUploader.ts +61 -0
- package/src/internal/calcRetryDelay.ts +59 -0
- package/src/internal/inferResBodyEncoding.ts +33 -0
- package/src/internal/inspectPossibleJSON.ts +71 -0
- package/src/internal/prependNewlineIfMultiline.ts +3 -0
- package/src/internal/substituteParams.ts +25 -0
- package/src/internal/throwIfErrorResponse.ts +89 -0
- package/src/internal/toFloatMs.ts +3 -0
- package/src/middlewares/paceRequests.ts +42 -0
- package/src/pacers/Pacer.ts +22 -0
- package/src/pacers/PacerComposite.ts +29 -0
- package/src/pacers/PacerQPS.ts +147 -0
- package/tsconfig.json +5 -13
- package/typedoc.json +6 -1
- package/dist/tsconfig.tsbuildinfo +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RestFetchReader.js","sourceRoot":"","sources":["../../src/internal/RestFetchReader.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"RestFetchReader.js","sourceRoot":"","sources":["../../src/internal/RestFetchReader.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,wEAAyD;AACzD,qEAAkD;AAElD,yDAAqD;AACrD,kFAA0D;AAS1D;;;;;;;;;;;GAWG;AACH,MAAqB,eAAe;IAOlC,YACU,IAAY,EACZ,QAAqB,EACrB,QAAgC;QAFhC,SAAI,GAAJ,IAAI,CAAQ;QACZ,aAAQ,GAAR,QAAQ,CAAa;QACrB,aAAQ,GAAR,QAAQ,CAAwB;QATlC,YAAO,GAAG,CAAC,CAAC;QACZ,aAAQ,GAAG,IAAI,oBAAO,EAAE,CAAC;QACzB,iBAAY,GAAG,EAAE,CAAC;QAClB,mBAAc,GAAG,IAAI,CAAC;QACtB,eAAU,GAAG,CAAC,CAAC;IAMpB,CAAC;IAEJ;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,CACL,IAAI,CAAC,QAAQ,CAAC,KAAK;YACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,QAAQ;YACvC,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC9B,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK;YACrB,CAAC,CAAC,IAAI,CACW,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,YAAoB;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QAC/C,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,UAAU,GAAG,YAAY,EAAE,CAAC;gBACtC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC/C,IAAI,IAAI,EAAE,CAAC;oBACT,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;oBAC5B,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;oBACzB,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC;YAC7B,CAAC;QACH,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;OAMG;IAEI,AAAP,KAAK,CAAC,CAAC,MAAC,MAAM,CAAC,aAAa,CAAC;;QAC3B,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QAE5D,oDAAoD;QACpD,MAAM,UAAU,GACd,OAAO,eAAe,KAAK,WAAW;YACpC,CAAC,CAAC,IAAI,0BAAyB,EAAE;YACjC,CAAC,CAAC,IAAI,eAAe,EAAE,CAAC;QAE5B,MAAM,OAAO,GAAG,SAAS;YACvB,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC;YACjD,CAAC,CAAC,SAAS,CAAC;QAEd,IAAI,CAAC;YACH,qEAAqE;YACrE,wEAAwE;YACxE,gEAAgE;YAChE,mDAAmD;YACnD,uCAAuC;YACvC,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAK,EACrB,IAAI,CAAC,IAAI,EACT,IAAI,oBAAO,CAAC,IAAI,CAAC,IAAI,EAAE;gBACrB,GAAG,IAAI,CAAC,QAAQ;gBAChB,MAAM,EAAE,UAAU,CAAC,MAAa;aACjC,CAAC,CACH,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC;YAC1B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC;YAE5B,wEAAwE;YACxE,uEAAuE;YACvE,wEAAwE;YACxE,6DAA6D;YAC7D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,IAAA,8BAAoB,EAAC,GAAG,CAAC,CAAC,CAAC;YAEhD,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,EAAC,SAAS,kDAAI,CAAA,CAAC;YAClC,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;gBACnC,MAAM,CAAA,MAAA,MAAA,IAAI,CAAC,QAAQ,EAAC,SAAS,kDAAI,CAAA,CAAC;gBAClC,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC;gBAChC,MAAM,KAAe,CAAC;gBACtB,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAG,IAAI,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,IAAI,SAAS,EAAE,CAAC;gBAC3C,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,OAAO,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;YACjC,kEAAkE;YAClE,oEAAoE;YACpE,uEAAuE;YACvE,0EAA0E;YAC1E,kCAAkC;YAClC,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;CACF;AAjKD,kCAiKC;AA1DQ;IADN,IAAA,iCAAO,GAAE;uCA0DT"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RestRangeUploader.js","sourceRoot":"","sources":["../../src/internal/RestRangeUploader.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;GASG;AACH,MAAqB,iBAAiB;IAGpC,YACU,OAAmB,EACnB,UAAkB,EAClB,OAAuB,EACvB,KAAa,EACb,SAAiB;QAJjB,YAAO,GAAP,OAAO,CAAY;QACnB,eAAU,GAAV,UAAU,CAAQ;QAClB,YAAO,GAAP,OAAO,CAAgB;QACvB,UAAK,GAAL,KAAK,CAAQ;QACb,cAAS,GAAT,SAAS,CAAQ;QAPnB,SAAI,GAAG,CAAC,CAAC;IAQd,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,MAA6B;QACxC,IAAI,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,GAAG,GAAkB,IAAI,CAAC;QAC9B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"RestRangeUploader.js","sourceRoot":"","sources":["../../src/internal/RestRangeUploader.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;GASG;AACH,MAAqB,iBAAiB;IAGpC,YACU,OAAmB,EACnB,UAAkB,EAClB,OAAuB,EACvB,KAAa,EACb,SAAiB;QAJjB,YAAO,GAAP,OAAO,CAAY;QACnB,eAAU,GAAV,UAAU,CAAQ;QAClB,YAAO,GAAP,OAAO,CAAgB;QACvB,UAAK,GAAL,KAAK,CAAQ;QACb,cAAS,GAAT,SAAS,CAAQ;QAPnB,SAAI,GAAG,CAAC,CAAC;IAQd,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,MAA6B;QACxC,IAAI,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,GAAG,GAAkB,IAAI,CAAC;QAC9B,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,MAAM,EAAE,CAAC;YACpC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;YACrC,OAAO,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;gBACzC,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC9D,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;YAChD,CAAC;YACD,0EAA0E;YAC1E,qEAAqE;YACrE,4CAA4C;QAC9C,CAAC;QAED,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnB,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,MAAe;QAC/C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;QACxD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO;aAC3B,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC;aAC9D,SAAS,CACR,eAAe,EACf,SAAS,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,SAAS,EAAE,CAChE;aACA,IAAI,EAAE,CAAC;QACV,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC;QACxB,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAhDD,oCAgDC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"calcRetryDelay.js","sourceRoot":"","sources":["../../src/internal/calcRetryDelay.ts"],"names":[],"mappings":";;;;;AAAA,4GAAoF;AACpF,sFAA8D;AAC9D,sFAA8D;AAC9D,4FAAoE;AAIpE;;;GAGG;AACH,SAAwB,cAAc,CACpC,KAAU,EACV,OAAoB,EACpB,GAAiB,EACjB,YAAoB;IAEpB,IACE,KAAK,YAAY,4BAAkB;QACnC,KAAK,YAAY,4BAAkB,EACnC;
|
|
1
|
+
{"version":3,"file":"calcRetryDelay.js","sourceRoot":"","sources":["../../src/internal/calcRetryDelay.ts"],"names":[],"mappings":";;;;;AAAA,4GAAoF;AACpF,sFAA8D;AAC9D,sFAA8D;AAC9D,4FAAoE;AAIpE;;;GAGG;AACH,SAAwB,cAAc,CACpC,KAAU,EACV,OAAoB,EACpB,GAAiB,EACjB,YAAoB;IAEpB,IACE,KAAK,YAAY,4BAAkB;QACnC,KAAK,YAAY,4BAAkB,EACnC,CAAC;QACD,qDAAqD;QACrD,OAAO,IAAI,CAAC,GAAG,CACb,OAAO,CAAC,eAAe,EACvB,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,CACtC,CAAC;IACJ,CAAC;IAED,QAAQ,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QAC7C,KAAK,OAAO,CAAC;QACb;YACE,MAAM,CAAC,kBAAkB;QAE3B,KAAK,aAAa;YAChB,IAAI,KAAK,YAAY,+BAAqB,EAAE,CAAC;gBAC3C,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,IACE,CAAC,CAAC,KAAK,YAAY,4BAAkB,CAAC;gBACtC,GAAG,CAAC,MAAM,IAAI,GAAG;gBACjB,GAAG,CAAC,MAAM,IAAI,GAAG,EACjB,CAAC;gBACD,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,IAAI,KAAK,YAAY,uCAA6B,EAAE,CAAC;gBACnD,+BAA+B;gBAC/B,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,MAAM;QAER,KAAK,aAAa;YAChB,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AA/CD,iCA+CC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inferResBodyEncoding.js","sourceRoot":"","sources":["../../src/internal/inferResBodyEncoding.ts"],"names":[],"mappings":";;AAEA,MAAM,UAAU,GACd,kEAAkE,CAAC;AACrE,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhF;;;GAGG;AACH,SAAwB,oBAAoB,CAAC,GAAa;;IACxD,MAAM,WAAW,GAAG,MAAA,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,0CAAE,WAAW,EAAE,CAAC;IACnE,MAAM,OAAO,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,CAAC,UAAU,CAAC;QAC5C,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE;QACzB,CAAC,CAAC,SAAS,CAAC;IACd,OAAO,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,CAAC,0BAA0B,CAAC;QACxD,CAAC,CAAC,8BAA8B;YAC9B,QAAQ;QACV,CAAC,CAAC,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"inferResBodyEncoding.js","sourceRoot":"","sources":["../../src/internal/inferResBodyEncoding.ts"],"names":[],"mappings":";;AAEA,MAAM,UAAU,GACd,kEAAkE,CAAC;AACrE,MAAM,gBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAEhF;;;GAGG;AACH,SAAwB,oBAAoB,CAAC,GAAa;;IACxD,MAAM,WAAW,GAAG,MAAA,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,0CAAE,WAAW,EAAE,CAAC;IACnE,MAAM,OAAO,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,CAAC,UAAU,CAAC;QAC5C,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE;QACzB,CAAC,CAAC,SAAS,CAAC;IACd,OAAO,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,CAAC,0BAA0B,CAAC;QACxD,CAAC,CAAC,8BAA8B;YAC9B,QAAQ;QACV,CAAC,CAAC,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC9C,CAAC,CAAC,kEAAkE;gBAClE,QAAQ;YACV,CAAC,CAAC,OAAO,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAC7C,CAAC,CAAC,+DAA+D;oBAC/D,oBAAoB;oBACnB,OAA0B;gBAC7B,CAAC,CAAC,kEAAkE;oBAClE,0EAA0E;oBAC1E,yEAAyE;oBACzE,oEAAoE;oBACpE,sEAAsE;oBACtE,+DAA+D;oBAC/D,OAAO,CAAC;AAClB,CAAC;AAtBD,uCAsBC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"inspectPossibleJSON.js","sourceRoot":"","sources":["../../src/internal/inspectPossibleJSON.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,2DAAmC;AACnC,+DAAuC;AAEvC,SAAwB,mBAAmB,CACzC,OAA6C,EAC7C,IAA6C,EAC7C,YAAoB;IAEpB,MAAM,oBAAoB,GAAG,IAAI,GAAG,IAAI,CAAC;IAEzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,oBAAoB,EAAE;
|
|
1
|
+
{"version":3,"file":"inspectPossibleJSON.js","sourceRoot":"","sources":["../../src/internal/inspectPossibleJSON.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,2DAAmC;AACnC,+DAAuC;AAEvC,SAAwB,mBAAmB,CACzC,OAA6C,EAC7C,IAA6C,EAC7C,YAAoB;IAEpB,MAAM,oBAAoB,GAAG,IAAI,GAAG,IAAI,CAAC;IAEzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,GAAG,oBAAoB,EAAE,CAAC;QACnE,wDAAwD;QACxD,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;QAC3B,OAAO,YAAY,IAAI,CAAC,MAAM,SAAS,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAE9B,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;gBACjE,qEAAqE;gBACrE,uEAAuE;gBACvE,mEAAmE;gBACnE,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAC7B,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CACzC,CAAC;YACJ,CAAC;YAED,OAAO,QAAQ,CACb,IAAA,cAAO,EAAC,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,EAC3C,YAAY,CACb,CAAC;QACJ,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,OAAO,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA3CD,sCA2CC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CACzB,GAAwB,EACxB,MAA8C;IAE9C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACpC,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;QACpB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,MAAM,CACX,GAAG,EACH,MAAM,CAAC,WAAW,CAAC,IAAA,gBAAM,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,IAAS,EAAE,MAAc;IACzC,OAAO,IAAA,kBAAQ,EAAC,EAAE,GAAG,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;AACnD,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"substituteParams.js","sourceRoot":"","sources":["../../src/internal/substituteParams.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,SAAwB,gBAAgB,CACtC,GAAW,EACX,IAAW;IAEX,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;
|
|
1
|
+
{"version":3,"file":"substituteParams.js","sourceRoot":"","sources":["../../src/internal/substituteParams.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,SAAwB,gBAAgB,CACtC,GAAW,EACX,IAAW;IAEX,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrB,CAAC;IAED,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACpD,MAAM,KAAK,GAAI,IAAY,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC3D,IAAI,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YACnB,OAAQ,IAAY,CAAC,KAAK,CAAC,CAAC;YAC5B,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACrB,CAAC;AAnBD,mCAmBC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"throwIfErrorResponse.js","sourceRoot":"","sources":["../../src/internal/throwIfErrorResponse.ts"],"names":[],"mappings":";;;;;AAAA,sFAA8D;AAC9D,oFAA4D;AAC5D,sFAA8D;AAC9D,4FAAoE;AAIpE,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAErC;;;;;;GAMG;AACH,SAAwB,oBAAoB,CAC1C,OAAoB,EACpB,GAAiB;IAEjB,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzD,IAAI,iBAAiB,KAAK,SAAS,EAAE;
|
|
1
|
+
{"version":3,"file":"throwIfErrorResponse.js","sourceRoot":"","sources":["../../src/internal/throwIfErrorResponse.ts"],"names":[],"mappings":";;;;;AAAA,sFAA8D;AAC9D,oFAA4D;AAC5D,sFAA8D;AAC9D,4FAAoE;AAIpE,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAErC;;;;;;GAMG;AACH,SAAwB,oBAAoB,CAC1C,OAAoB,EACpB,GAAiB;IAEjB,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzD,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO;IACT,CAAC;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACvD,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,YAAY;YACf,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,gBAAgB,EAAE,EACjD,CAAC,EACD,GAAG,CACJ,CAAC;QACJ,KAAK,aAAa;YAChB,IAAI,GAAG,CAAC,MAAM,KAAK,wBAAwB,EAAE,CAAC;gBAC5C,MAAM,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC;gBAC/D,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,wBAAwB,EAAE,EACzD,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAC/B,GAAG,CACJ,CAAC;YACJ,CAAC;YAED,MAAM;QACR,KAAK,gBAAgB;YACnB,MAAM;QACR;YACE,MAAM,IAAI,4BAAkB,CAC1B,2CAA2C,gBAAgB,KAAK,EAChE,gBAAgB,EAChB,GAAG,CACJ,CAAC;IACN,CAAC;IAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC7D,IAAI,mBAAmB,EAAE,CAAC;QACxB,MAAM,IAAI,+BAAqB,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACzD,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,OAAO;YACV,MAAM,IAAI,4BAAkB,CAC1B,+BAA+B,YAAY,EAAE,EAC7C,CAAC,EACD,GAAG,CACJ,CAAC;QACJ,KAAK,aAAa,CAAC;QACnB,KAAK,aAAa;YAChB,MAAM;QACR;YACE,MAAM,IAAI,4BAAkB,CAC1B,4CAA4C,YAAY,KAAK,EAC7D,YAAY,EACZ,GAAG,CACJ,CAAC;IACN,CAAC;IAED,IAAI,iBAAiB,KAAK,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,2BAAiB,CACzB,gCAAgC,iBAAiB,EAAE,EACnD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QACtB,MAAM,IAAI,2BAAiB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACvC,CAAC;AACH,CAAC;AAxED,uCAwEC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paceRequests.js","sourceRoot":"","sources":["../../src/middlewares/paceRequests.ts"],"names":[],"mappings":";;AAIA,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B;;;GAGG;AACH,SAAwB,YAAY,CAClC,KAAmE;IAEnE,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACzB,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;
|
|
1
|
+
{"version":3,"file":"paceRequests.js","sourceRoot":"","sources":["../../src/middlewares/paceRequests.ts"],"names":[],"mappings":";;AAIA,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAE5B;;;GAGG;AACH,SAAwB,YAAY,CAClC,KAAmE;IAEnE,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACzB,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YAChC,KAAK,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;YAChD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBAChB,MAAM,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC/C,CAAC;YAED,IAAI,OAAO,GAAG,gBAAgB,EAAE,CAAC;gBAC/B,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;oBACjB,OAAO,EAAE,CAAC;oBACV,GAAG;oBACH,GAAG,EAAE,eAAe;oBACpB,SAAS,EAAE,IAAI;oBACf,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;oBACrB,OAAO,EAAE,OAAO;oBAChB,cAAc,EAAE,IAAI;oBACpB,qBAAqB,EAAE,KAAK;oBAC5B,OAAO,EAAE,MAAM;iBAChB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AA/BD,+BA+BC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PacerQPS.js","sourceRoot":"","sources":["../../src/pacers/PacerQPS.ts"],"names":[],"mappings":";;;;;AAAA,2DAAmC;AAInC;;;4CAG4C;AAC5C,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAExC,oCAAoC;AACpC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B;;;;6CAI6C;AAC7C,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;yBAIyB;AACzB,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAEtC,4DAA4D;AAC5D,MAAM,iBAAiB,GAAG,GAAG,CAAC;AA8B9B;;;;;;;;;;GAUG;AACH,MAAqB,QAAQ;IAI3B,YACU,QAAyB,EACzB,QAAyB;QADzB,aAAQ,GAAR,QAAQ,CAAiB;QACzB,aAAQ,GAAR,QAAQ,CAAiB;QAL3B,kBAAa,GAAG,IAAI,CAAC;QACrB,WAAM,GAAG,CAAC,CAAC;IAKhB,CAAC;IAEJ,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,KAAK;;QACT,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,QAAQ,CAAC,SAAS,mCAAI,kBAAkB,CAAC;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,iBAAiB,GACrB,MAAA,IAAI,CAAC,QAAQ,CAAC,iBAAiB,mCAAI,0BAA0B,CAAC;QAEhE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3D,IAAI;YACJ,OAAO,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI;YAChC,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,0BAA0B,EAAE,8BAA8B;SAC3D,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;
|
|
1
|
+
{"version":3,"file":"PacerQPS.js","sourceRoot":"","sources":["../../src/pacers/PacerQPS.ts"],"names":[],"mappings":";;;;;AAAA,2DAAmC;AAInC;;;4CAG4C;AAC5C,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAExC,oCAAoC;AACpC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B;;;;6CAI6C;AAC7C,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C;;;;yBAIyB;AACzB,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAEtC,4DAA4D;AAC5D,MAAM,iBAAiB,GAAG,GAAG,CAAC;AA8B9B;;;;;;;;;;GAUG;AACH,MAAqB,QAAQ;IAI3B,YACU,QAAyB,EACzB,QAAyB;QADzB,aAAQ,GAAR,QAAQ,CAAiB;QACzB,aAAQ,GAAR,QAAQ,CAAiB;QAL3B,kBAAa,GAAG,IAAI,CAAC;QACrB,WAAM,GAAG,CAAC,CAAC;IAKhB,CAAC;IAEJ,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,KAAK;;QACT,MAAM,SAAS,GAAG,MAAA,IAAI,CAAC,QAAQ,CAAC,SAAS,mCAAI,kBAAkB,CAAC;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACxD,MAAM,iBAAiB,GACrB,MAAA,IAAI,CAAC,QAAQ,CAAC,iBAAiB,mCAAI,0BAA0B,CAAC;QAEhE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3D,IAAI;YACJ,OAAO,EAAE,IAAI,GAAG,SAAS,GAAG,IAAI;YAChC,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,0BAA0B,EAAE,8BAA8B;SAC3D,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;QAC7B,CAAC;QAED,uEAAuE;QACvE,mEAAmE;QACnE,0EAA0E;QAC1E,oDAAoD;QACpD,MAAM,uBAAuB,GAAG,IAAI,CAAC,KAAK,CACxC,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,wBAAwB,CACxD,CAAC;QAEF,4EAA4E;QAC5E,2EAA2E;QAC3E,uDAAuD;QACvD,MAAM,sBAAsB,GAAG,IAAI,CAAC,KAAK,CACvC,GAAG;YACD,wBAAwB;YACxB,IAAA,gBAAM,EAAC,CAAC,GAAG,iBAAiB,EAAE,CAAC,GAAG,iBAAiB,EAAE,IAAI,CAAC,CAC7D,CAAC;QAEF,qEAAqE;QACrE,iCAAiC;QACjC,MAAM,WAAW,GAAG,sBAAsB,IAAI,uBAAuB,IAAI,CAAC,CAAC;QAE3E,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;YAClB,uEAAuE;YACvE,0EAA0E;YAC1E,uEAAuE;YACvE,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC;QAC7B,CAAC;aAAM,IAAI,KAAK,GAAG,KAAK,GAAG,iBAAiB,EAAE,CAAC;YAC7C,6DAA6D;YAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC;QACvD,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,MAAM;YACpB,MAAM,EAAE;gBACN,SAAS,KAAK,QAAQ,SAAS,YAAY,KAAK,GAAG;gBACnD,SAAS,IAAI,CAAC,MAAM,SAAS,WAAW,gBAAgB,WAAW,EAAE;gBACrE,UAAU,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE;gBAC9B,aAAa,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;gBACtC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;aACzB,CAAC,IAAI,CAAC,IAAI,CAAC;SACb,CAAC;IACJ,CAAC;CACF;AA7ED,2BA6EC"}
|
package/docs/README.md
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
@clickup/rest-client / [Exports](modules.md)
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# rest-client: a syntax sugar tool around Node fetch() API, tailored to work with typescript-is or superstruct validators
|
|
4
4
|
|
|
5
5
|
See also [Full API documentation](https://github.com/clickup/rest-client/blob/master/docs/modules.md).
|
|
6
6
|
|
|
7
|
+

|
|
8
|
+
|
|
7
9
|
## Examples
|
|
8
10
|
|
|
9
11
|
In the example below we use
|
|
@@ -12,7 +12,7 @@ A Pacer which runs all sub-pacers and chooses the largest delay.
|
|
|
12
12
|
|
|
13
13
|
### constructor
|
|
14
14
|
|
|
15
|
-
• **new PacerComposite**(`_pacers`)
|
|
15
|
+
• **new PacerComposite**(`_pacers`): [`PacerComposite`](PacerComposite.md)
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
@@ -20,6 +20,10 @@ A Pacer which runs all sub-pacers and chooses the largest delay.
|
|
|
20
20
|
| :------ | :------ |
|
|
21
21
|
| `_pacers` | [`Pacer`](../interfaces/Pacer.md)[] |
|
|
22
22
|
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
[`PacerComposite`](PacerComposite.md)
|
|
26
|
+
|
|
23
27
|
#### Defined in
|
|
24
28
|
|
|
25
29
|
[src/pacers/PacerComposite.ts:10](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerComposite.ts#L10)
|
|
@@ -44,14 +48,14 @@ Human readable name of the pacer, used when composing multiple pacers.
|
|
|
44
48
|
|
|
45
49
|
### touch
|
|
46
50
|
|
|
47
|
-
▸ **touch**(): `Promise
|
|
51
|
+
▸ **touch**(): `Promise`\<\{ `delayMs`: `number` ; `reason`: `string` }\>
|
|
48
52
|
|
|
49
53
|
Signals that we're about to send a request. Returns the delay we need to
|
|
50
54
|
wait for before actually sending.
|
|
51
55
|
|
|
52
56
|
#### Returns
|
|
53
57
|
|
|
54
|
-
`Promise
|
|
58
|
+
`Promise`\<\{ `delayMs`: `number` ; `reason`: `string` }\>
|
|
55
59
|
|
|
56
60
|
#### Implementation of
|
|
57
61
|
|
package/docs/classes/PacerQPS.md
CHANGED
|
@@ -20,7 +20,7 @@ the pacing algorithm.
|
|
|
20
20
|
|
|
21
21
|
### constructor
|
|
22
22
|
|
|
23
|
-
• **new PacerQPS**(`_options`, `_backend`)
|
|
23
|
+
• **new PacerQPS**(`_options`, `_backend`): [`PacerQPS`](PacerQPS.md)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -29,6 +29,10 @@ the pacing algorithm.
|
|
|
29
29
|
| `_options` | [`PacerQPSOptions`](../interfaces/PacerQPSOptions.md) |
|
|
30
30
|
| `_backend` | [`PacerQPSBackend`](../interfaces/PacerQPSBackend.md) |
|
|
31
31
|
|
|
32
|
+
#### Returns
|
|
33
|
+
|
|
34
|
+
[`PacerQPS`](PacerQPS.md)
|
|
35
|
+
|
|
32
36
|
#### Defined in
|
|
33
37
|
|
|
34
38
|
[src/pacers/PacerQPS.ts:74](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L74)
|
|
@@ -57,14 +61,14 @@ Human readable name of the pacer, used when composing multiple pacers.
|
|
|
57
61
|
|
|
58
62
|
### touch
|
|
59
63
|
|
|
60
|
-
▸ **touch**(): `Promise
|
|
64
|
+
▸ **touch**(): `Promise`\<[`PacerDelay`](../interfaces/PacerDelay.md)\>
|
|
61
65
|
|
|
62
66
|
Signals that we're about to send a request. Returns the delay we need to
|
|
63
67
|
wait for before actually sending.
|
|
64
68
|
|
|
65
69
|
#### Returns
|
|
66
70
|
|
|
67
|
-
`Promise
|
|
71
|
+
`Promise`\<[`PacerDelay`](../interfaces/PacerDelay.md)\>
|
|
68
72
|
|
|
69
73
|
#### Implementation of
|
|
70
74
|
|
|
@@ -11,13 +11,17 @@ RestClient is an immutable object which allows to:
|
|
|
11
11
|
|
|
12
12
|
### constructor
|
|
13
13
|
|
|
14
|
-
• **new RestClient**(`options?`)
|
|
14
|
+
• **new RestClient**(`options?`): [`RestClient`](RestClient.md)
|
|
15
15
|
|
|
16
16
|
#### Parameters
|
|
17
17
|
|
|
18
18
|
| Name | Type |
|
|
19
19
|
| :------ | :------ |
|
|
20
|
-
| `options` | `Partial
|
|
20
|
+
| `options` | `Partial`\<[`RestOptions`](../interfaces/RestOptions.md)\> |
|
|
21
|
+
|
|
22
|
+
#### Returns
|
|
23
|
+
|
|
24
|
+
[`RestClient`](RestClient.md)
|
|
21
25
|
|
|
22
26
|
#### Defined in
|
|
23
27
|
|
|
@@ -35,7 +39,7 @@ Returns a new RestClient with some options updated with the passed ones.
|
|
|
35
39
|
|
|
36
40
|
| Name | Type |
|
|
37
41
|
| :------ | :------ |
|
|
38
|
-
| `options` | `Partial
|
|
42
|
+
| `options` | `Partial`\<[`RestOptions`](../interfaces/RestOptions.md)\> |
|
|
39
43
|
|
|
40
44
|
#### Returns
|
|
41
45
|
|
|
@@ -86,7 +90,7 @@ appears here which we must protect against in the code below.
|
|
|
86
90
|
|
|
87
91
|
| Name | Type |
|
|
88
92
|
| :------ | :------ |
|
|
89
|
-
| `base` | `string` \| () => `Promise
|
|
93
|
+
| `base` | `string` \| () => `Promise`\<`string`\> |
|
|
90
94
|
|
|
91
95
|
#### Returns
|
|
92
96
|
|
|
@@ -109,7 +113,7 @@ Returns a new RestClient with a custom header.
|
|
|
109
113
|
| Name | Type |
|
|
110
114
|
| :------ | :------ |
|
|
111
115
|
| `name` | `string` |
|
|
112
|
-
| `value` | `string` \| () => `Promise
|
|
116
|
+
| `value` | `string` \| () => `Promise`\<`string`\> |
|
|
113
117
|
|
|
114
118
|
#### Returns
|
|
115
119
|
|
|
@@ -152,7 +156,7 @@ logic, e.g.:
|
|
|
152
156
|
|
|
153
157
|
| Name | Type | Default value |
|
|
154
158
|
| :------ | :------ | :------ |
|
|
155
|
-
| `token` | [`TokenGetter`](../interfaces/TokenGetter.md)
|
|
159
|
+
| `token` | [`TokenGetter`](../interfaces/TokenGetter.md)\<`string`\> | `undefined` |
|
|
156
160
|
| `bearerPrefix` | `string` | `"Bearer "` |
|
|
157
161
|
|
|
158
162
|
#### Returns
|
|
@@ -186,7 +190,7 @@ of arbitrary requests, it can only send its own requests.
|
|
|
186
190
|
| `consumer` | `Object` |
|
|
187
191
|
| `consumer.consumerKey` | `string` |
|
|
188
192
|
| `consumer.consumerSecret` | `string` |
|
|
189
|
-
| `token` | [`TokenGetter`](../interfaces/TokenGetter.md)
|
|
193
|
+
| `token` | [`TokenGetter`](../interfaces/TokenGetter.md)\<\{ `token`: `string` ; `tokenSecret`: `string` }\> |
|
|
190
194
|
|
|
191
195
|
#### Returns
|
|
192
196
|
|
|
@@ -208,7 +212,7 @@ Returns a new RestClient with basic authorization workflow.
|
|
|
208
212
|
|
|
209
213
|
| Name | Type |
|
|
210
214
|
| :------ | :------ |
|
|
211
|
-
| `token` | [`TokenGetter`](../interfaces/TokenGetter.md)
|
|
215
|
+
| `token` | [`TokenGetter`](../interfaces/TokenGetter.md)\<\{ `name`: `string` ; `password`: `string` }\> |
|
|
212
216
|
|
|
213
217
|
#### Returns
|
|
214
218
|
|
|
@@ -222,7 +226,7 @@ ___
|
|
|
222
226
|
|
|
223
227
|
### get
|
|
224
228
|
|
|
225
|
-
▸ **get**(`path`, `args?`, `accept?`): [`RestRequest`](RestRequest.md)
|
|
229
|
+
▸ **get**(`path`, `args?`, `accept?`): [`RestRequest`](RestRequest.md)\<`any`\>
|
|
226
230
|
|
|
227
231
|
Sends a plain GET request without body.
|
|
228
232
|
|
|
@@ -233,12 +237,12 @@ NOTE, all args will be passed through `encodeURIComponent`.
|
|
|
233
237
|
| Name | Type | Default value |
|
|
234
238
|
| :------ | :------ | :------ |
|
|
235
239
|
| `path` | `string` | `undefined` |
|
|
236
|
-
| `args` | `Partial
|
|
240
|
+
| `args` | `Partial`\<`Record`\<`string`, `string` \| `number` \| `string`[]\>\> | `{}` |
|
|
237
241
|
| `accept` | `string` | `"application/json"` |
|
|
238
242
|
|
|
239
243
|
#### Returns
|
|
240
244
|
|
|
241
|
-
[`RestRequest`](RestRequest.md)
|
|
245
|
+
[`RestRequest`](RestRequest.md)\<`any`\>
|
|
242
246
|
|
|
243
247
|
#### Defined in
|
|
244
248
|
|
|
@@ -248,7 +252,7 @@ ___
|
|
|
248
252
|
|
|
249
253
|
### writeRaw
|
|
250
254
|
|
|
251
|
-
▸ **writeRaw**(`path`, `body`, `contentType`, `method?`, `accept?`): [`RestRequest`](RestRequest.md)
|
|
255
|
+
▸ **writeRaw**(`path`, `body`, `contentType`, `method?`, `accept?`): [`RestRequest`](RestRequest.md)\<`any`\>
|
|
252
256
|
|
|
253
257
|
Writes some raw string, buffer or a stream.
|
|
254
258
|
|
|
@@ -264,7 +268,7 @@ Writes some raw string, buffer or a stream.
|
|
|
264
268
|
|
|
265
269
|
#### Returns
|
|
266
270
|
|
|
267
|
-
[`RestRequest`](RestRequest.md)
|
|
271
|
+
[`RestRequest`](RestRequest.md)\<`any`\>
|
|
268
272
|
|
|
269
273
|
#### Defined in
|
|
270
274
|
|
|
@@ -274,7 +278,7 @@ ___
|
|
|
274
278
|
|
|
275
279
|
### writeJson
|
|
276
280
|
|
|
277
|
-
▸ **writeJson**(`path`, `body`, `method?`, `accept?`): [`RestRequest`](RestRequest.md)
|
|
281
|
+
▸ **writeJson**(`path`, `body`, `method?`, `accept?`): [`RestRequest`](RestRequest.md)\<`any`\>
|
|
278
282
|
|
|
279
283
|
A shortcut method to write JSON body.
|
|
280
284
|
|
|
@@ -289,7 +293,7 @@ A shortcut method to write JSON body.
|
|
|
289
293
|
|
|
290
294
|
#### Returns
|
|
291
295
|
|
|
292
|
-
[`RestRequest`](RestRequest.md)
|
|
296
|
+
[`RestRequest`](RestRequest.md)\<`any`\>
|
|
293
297
|
|
|
294
298
|
#### Defined in
|
|
295
299
|
|
|
@@ -299,7 +303,7 @@ ___
|
|
|
299
303
|
|
|
300
304
|
### writeForm
|
|
301
305
|
|
|
302
|
-
▸ **writeForm**(`path`, `body`, `method?`, `accept?`): [`RestRequest`](RestRequest.md)
|
|
306
|
+
▸ **writeForm**(`path`, `body`, `method?`, `accept?`): [`RestRequest`](RestRequest.md)\<`any`\>
|
|
303
307
|
|
|
304
308
|
A shortcut method to write "application/x-www-form-urlencoded" data.
|
|
305
309
|
|
|
@@ -308,13 +312,13 @@ A shortcut method to write "application/x-www-form-urlencoded" data.
|
|
|
308
312
|
| Name | Type | Default value |
|
|
309
313
|
| :------ | :------ | :------ |
|
|
310
314
|
| `path` | `string` | `undefined` |
|
|
311
|
-
| `body` | `string` \| `Partial
|
|
315
|
+
| `body` | `string` \| `Partial`\<`Record`\<`string`, `string`\>\> | `undefined` |
|
|
312
316
|
| `method` | ``"POST"`` \| ``"PUT"`` \| ``"PATCH"`` | `"POST"` |
|
|
313
317
|
| `accept` | `string` | `"application/json"` |
|
|
314
318
|
|
|
315
319
|
#### Returns
|
|
316
320
|
|
|
317
|
-
[`RestRequest`](RestRequest.md)
|
|
321
|
+
[`RestRequest`](RestRequest.md)\<`any`\>
|
|
318
322
|
|
|
319
323
|
#### Defined in
|
|
320
324
|
|
|
@@ -324,7 +328,7 @@ ___
|
|
|
324
328
|
|
|
325
329
|
### writeDelete
|
|
326
330
|
|
|
327
|
-
▸ **writeDelete**(`path`, `args?`, `accept?`): [`RestRequest`](RestRequest.md)
|
|
331
|
+
▸ **writeDelete**(`path`, `args?`, `accept?`): [`RestRequest`](RestRequest.md)\<`any`\>
|
|
328
332
|
|
|
329
333
|
A shortcut method to write DELETE request.
|
|
330
334
|
|
|
@@ -333,12 +337,12 @@ A shortcut method to write DELETE request.
|
|
|
333
337
|
| Name | Type | Default value |
|
|
334
338
|
| :------ | :------ | :------ |
|
|
335
339
|
| `path` | `string` | `undefined` |
|
|
336
|
-
| `args` | `Partial
|
|
340
|
+
| `args` | `Partial`\<`Record`\<`string`, `string`\>\> | `{}` |
|
|
337
341
|
| `accept` | `string` | `"application/json"` |
|
|
338
342
|
|
|
339
343
|
#### Returns
|
|
340
344
|
|
|
341
|
-
[`RestRequest`](RestRequest.md)
|
|
345
|
+
[`RestRequest`](RestRequest.md)\<`any`\>
|
|
342
346
|
|
|
343
347
|
#### Defined in
|
|
344
348
|
|
|
@@ -348,7 +352,7 @@ ___
|
|
|
348
352
|
|
|
349
353
|
### writeGraphQLX
|
|
350
354
|
|
|
351
|
-
▸ **writeGraphQLX**(`query`, `variables?`): [`RestRequest`](RestRequest.md)
|
|
355
|
+
▸ **writeGraphQLX**(`query`, `variables?`): [`RestRequest`](RestRequest.md)\<`any`\>
|
|
352
356
|
|
|
353
357
|
Returns a RestRequest prepared for sending GraphQL operation.
|
|
354
358
|
- Expects the response to contain no errors; throws otherwise.
|
|
@@ -365,7 +369,7 @@ Returns a RestRequest prepared for sending GraphQL operation.
|
|
|
365
369
|
|
|
366
370
|
#### Returns
|
|
367
371
|
|
|
368
|
-
[`RestRequest`](RestRequest.md)
|
|
372
|
+
[`RestRequest`](RestRequest.md)\<`any`\>
|
|
369
373
|
|
|
370
374
|
#### Defined in
|
|
371
375
|
|
|
@@ -375,7 +379,7 @@ ___
|
|
|
375
379
|
|
|
376
380
|
### writeGraphQLNullable
|
|
377
381
|
|
|
378
|
-
▸ **writeGraphQLNullable**(`query`, `variables?`): [`RestRequest`](RestRequest.md)
|
|
382
|
+
▸ **writeGraphQLNullable**(`query`, `variables?`): [`RestRequest`](RestRequest.md)\<`undefined` \| ``null`` \| \{ `data?`: `any` ; `error?`: `any` ; `errors?`: `any`[] }\>
|
|
379
383
|
|
|
380
384
|
Same as writeGraphQLX(), but doesn't throw if GraphQL response contains
|
|
381
385
|
non-empty `error` or `errors` fields and instead returns the full response.
|
|
@@ -390,7 +394,7 @@ I.e. allows the caller to process these errors.
|
|
|
390
394
|
|
|
391
395
|
#### Returns
|
|
392
396
|
|
|
393
|
-
[`RestRequest`](RestRequest.md)
|
|
397
|
+
[`RestRequest`](RestRequest.md)\<`undefined` \| ``null`` \| \{ `data?`: `any` ; `error?`: `any` ; `errors?`: `any`[] }\>
|
|
394
398
|
|
|
395
399
|
#### Defined in
|
|
396
400
|
|
|
@@ -400,7 +404,7 @@ ___
|
|
|
400
404
|
|
|
401
405
|
### rangeUpload
|
|
402
406
|
|
|
403
|
-
▸ **rangeUpload**(`path`, `mimeType`, `stream`, `method?`, `chunkSize`): `Promise
|
|
407
|
+
▸ **rangeUpload**(`path`, `mimeType`, `stream`, `method?`, `chunkSize`): `Promise`\<``null`` \| `string`\>
|
|
404
408
|
|
|
405
409
|
Performs a series of Content-Range requests with content from a sequence of
|
|
406
410
|
Buffers.
|
|
@@ -411,13 +415,13 @@ Buffers.
|
|
|
411
415
|
| :------ | :------ | :------ |
|
|
412
416
|
| `path` | `string` | `undefined` |
|
|
413
417
|
| `mimeType` | `string` | `undefined` |
|
|
414
|
-
| `stream` | `AsyncIterable
|
|
418
|
+
| `stream` | `AsyncIterable`\<`Buffer`\> | `undefined` |
|
|
415
419
|
| `method` | ``"POST"`` \| ``"PUT"`` | `"POST"` |
|
|
416
420
|
| `chunkSize` | `number` | `undefined` |
|
|
417
421
|
|
|
418
422
|
#### Returns
|
|
419
423
|
|
|
420
|
-
`Promise
|
|
424
|
+
`Promise`\<``null`` \| `string`\>
|
|
421
425
|
|
|
422
426
|
#### Defined in
|
|
423
427
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
### constructor
|
|
14
14
|
|
|
15
|
-
• **new RestContentSizeOverLimitError**(`message`, `res`)
|
|
15
|
+
• **new RestContentSizeOverLimitError**(`message`, `res`): [`RestContentSizeOverLimitError`](RestContentSizeOverLimitError.md)
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
@@ -21,6 +21,10 @@
|
|
|
21
21
|
| `message` | `string` |
|
|
22
22
|
| `res` | [`RestResponse`](RestResponse.md) |
|
|
23
23
|
|
|
24
|
+
#### Returns
|
|
25
|
+
|
|
26
|
+
[`RestContentSizeOverLimitError`](RestContentSizeOverLimitError.md)
|
|
27
|
+
|
|
24
28
|
#### Inherited from
|
|
25
29
|
|
|
26
30
|
[RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
### constructor
|
|
16
16
|
|
|
17
|
-
• **new RestError**(`message`)
|
|
17
|
+
• **new RestError**(`message`): [`RestError`](RestError.md)
|
|
18
18
|
|
|
19
19
|
#### Parameters
|
|
20
20
|
|
|
@@ -22,6 +22,10 @@
|
|
|
22
22
|
| :------ | :------ |
|
|
23
23
|
| `message` | `string` |
|
|
24
24
|
|
|
25
|
+
#### Returns
|
|
26
|
+
|
|
27
|
+
[`RestError`](RestError.md)
|
|
28
|
+
|
|
25
29
|
#### Overrides
|
|
26
30
|
|
|
27
31
|
Error.constructor
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
### constructor
|
|
14
14
|
|
|
15
|
-
• **new RestRateLimitError**(`message`, `delayMs`, `res`)
|
|
15
|
+
• **new RestRateLimitError**(`message`, `delayMs`, `res`): [`RestRateLimitError`](RestRateLimitError.md)
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
@@ -22,6 +22,10 @@
|
|
|
22
22
|
| `delayMs` | `number` |
|
|
23
23
|
| `res` | [`RestResponse`](RestResponse.md) |
|
|
24
24
|
|
|
25
|
+
#### Returns
|
|
26
|
+
|
|
27
|
+
[`RestRateLimitError`](RestRateLimitError.md)
|
|
28
|
+
|
|
25
29
|
#### Overrides
|
|
26
30
|
|
|
27
31
|
[RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)
|
|
@@ -38,7 +42,7 @@
|
|
|
38
42
|
|
|
39
43
|
#### Defined in
|
|
40
44
|
|
|
41
|
-
[src/errors/RestRateLimitError.ts:
|
|
45
|
+
[src/errors/RestRateLimitError.ts:7](https://github.com/clickup/rest-client/blob/master/src/errors/RestRateLimitError.ts#L7)
|
|
42
46
|
|
|
43
47
|
___
|
|
44
48
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestRequest
|
|
2
2
|
|
|
3
|
-
# Class: RestRequest
|
|
3
|
+
# Class: RestRequest\<TAssertShape\>
|
|
4
4
|
|
|
5
5
|
Type TAssertShape allows to limit json()'s assert callbacks to only those
|
|
6
6
|
which return an object compatible with TAssertShape.
|
|
@@ -15,7 +15,7 @@ which return an object compatible with TAssertShape.
|
|
|
15
15
|
|
|
16
16
|
### constructor
|
|
17
17
|
|
|
18
|
-
• **new RestRequest
|
|
18
|
+
• **new RestRequest**\<`TAssertShape`\>(`options`, `method`, `url`, `headers`, `body`, `shape?`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
19
19
|
|
|
20
20
|
#### Type parameters
|
|
21
21
|
|
|
@@ -34,6 +34,10 @@ which return an object compatible with TAssertShape.
|
|
|
34
34
|
| `body` | `string` \| `Buffer` \| `ReadableStream` |
|
|
35
35
|
| `shape?` | `string` |
|
|
36
36
|
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
40
|
+
|
|
37
41
|
#### Defined in
|
|
38
42
|
|
|
39
43
|
[src/RestRequest.ts:30](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L30)
|
|
@@ -102,7 +106,7 @@ ___
|
|
|
102
106
|
|
|
103
107
|
### setHeader
|
|
104
108
|
|
|
105
|
-
▸ **setHeader**(`name`, `value`): [`RestRequest`](RestRequest.md)
|
|
109
|
+
▸ **setHeader**(`name`, `value`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
106
110
|
|
|
107
111
|
Modifies the request by adding a custom HTTP header.
|
|
108
112
|
|
|
@@ -115,7 +119,7 @@ Modifies the request by adding a custom HTTP header.
|
|
|
115
119
|
|
|
116
120
|
#### Returns
|
|
117
121
|
|
|
118
|
-
[`RestRequest`](RestRequest.md)
|
|
122
|
+
[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
119
123
|
|
|
120
124
|
#### Defined in
|
|
121
125
|
|
|
@@ -125,7 +129,7 @@ ___
|
|
|
125
129
|
|
|
126
130
|
### setOptions
|
|
127
131
|
|
|
128
|
-
▸ **setOptions**(`options`): [`RestRequest`](RestRequest.md)
|
|
132
|
+
▸ **setOptions**(`options`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
129
133
|
|
|
130
134
|
Modifies the request by adding a custom request option.
|
|
131
135
|
|
|
@@ -133,11 +137,11 @@ Modifies the request by adding a custom request option.
|
|
|
133
137
|
|
|
134
138
|
| Name | Type |
|
|
135
139
|
| :------ | :------ |
|
|
136
|
-
| `options` | `Partial
|
|
140
|
+
| `options` | `Partial`\<[`RestOptions`](../interfaces/RestOptions.md)\> |
|
|
137
141
|
|
|
138
142
|
#### Returns
|
|
139
143
|
|
|
140
|
-
[`RestRequest`](RestRequest.md)
|
|
144
|
+
[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
141
145
|
|
|
142
146
|
#### Defined in
|
|
143
147
|
|
|
@@ -147,7 +151,7 @@ ___
|
|
|
147
151
|
|
|
148
152
|
### setDebug
|
|
149
153
|
|
|
150
|
-
▸ **setDebug**(`flag?`): [`RestRequest`](RestRequest.md)
|
|
154
|
+
▸ **setDebug**(`flag?`): [`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
151
155
|
|
|
152
156
|
Forces RestClient to debug-output the request and response to console.
|
|
153
157
|
Never use in production.
|
|
@@ -160,7 +164,7 @@ Never use in production.
|
|
|
160
164
|
|
|
161
165
|
#### Returns
|
|
162
166
|
|
|
163
|
-
[`RestRequest`](RestRequest.md)
|
|
167
|
+
[`RestRequest`](RestRequest.md)\<`TAssertShape`\>
|
|
164
168
|
|
|
165
169
|
#### Defined in
|
|
166
170
|
|
|
@@ -170,7 +174,7 @@ ___
|
|
|
170
174
|
|
|
171
175
|
### json
|
|
172
176
|
|
|
173
|
-
▸ **json
|
|
177
|
+
▸ **json**\<`TJson`\>(`assert`, `...checkers`): `Promise`\<`TJson`\>
|
|
174
178
|
|
|
175
179
|
Sends the request and reads the response a JSON. In absolute most of the
|
|
176
180
|
cases, this method is used to reach API responses. The assert callback
|
|
@@ -187,12 +191,12 @@ not let people to do anti-patterns.
|
|
|
187
191
|
|
|
188
192
|
| Name | Type |
|
|
189
193
|
| :------ | :------ |
|
|
190
|
-
| `assert` | { `mask`: (`obj`: `any`) => `TJson` } \| { `$assert`: (`obj`: `any`) => `TJson` } \| (`obj`: `any`) => `TJson` |
|
|
194
|
+
| `assert` | \{ `mask`: (`obj`: `any`) => `TJson` } \| \{ `$assert`: (`obj`: `any`) => `TJson` } \| (`obj`: `any`) => `TJson` |
|
|
191
195
|
| `...checkers` | (`json`: `TJson`, `res`: [`RestResponse`](RestResponse.md)) => ``false`` \| `Error`[] |
|
|
192
196
|
|
|
193
197
|
#### Returns
|
|
194
198
|
|
|
195
|
-
`Promise
|
|
199
|
+
`Promise`\<`TJson`\>
|
|
196
200
|
|
|
197
201
|
#### Defined in
|
|
198
202
|
|
|
@@ -202,13 +206,13 @@ ___
|
|
|
202
206
|
|
|
203
207
|
### text
|
|
204
208
|
|
|
205
|
-
▸ **text**(): `Promise
|
|
209
|
+
▸ **text**(): `Promise`\<`string`\>
|
|
206
210
|
|
|
207
211
|
Sends the request and returns plaintext response.
|
|
208
212
|
|
|
209
213
|
#### Returns
|
|
210
214
|
|
|
211
|
-
`Promise
|
|
215
|
+
`Promise`\<`string`\>
|
|
212
216
|
|
|
213
217
|
#### Defined in
|
|
214
218
|
|
|
@@ -218,7 +222,7 @@ ___
|
|
|
218
222
|
|
|
219
223
|
### response
|
|
220
224
|
|
|
221
|
-
▸ **response**(): `Promise
|
|
225
|
+
▸ **response**(): `Promise`\<[`RestResponse`](RestResponse.md)\>
|
|
222
226
|
|
|
223
227
|
Returns the entire RestResponse object with response status and headers
|
|
224
228
|
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.
|
|
|
226
230
|
|
|
227
231
|
#### Returns
|
|
228
232
|
|
|
229
|
-
`Promise
|
|
233
|
+
`Promise`\<[`RestResponse`](RestResponse.md)\>
|
|
230
234
|
|
|
231
235
|
#### Defined in
|
|
232
236
|
|
|
@@ -236,7 +240,7 @@ ___
|
|
|
236
240
|
|
|
237
241
|
### stream
|
|
238
242
|
|
|
239
|
-
▸ **stream**(`preloadChars?`): `Promise
|
|
243
|
+
▸ **stream**(`preloadChars?`): `Promise`\<[`RestStream`](RestStream.md)\>
|
|
240
244
|
|
|
241
245
|
Sends the requests and returns RestStream object. You MUST iterate over
|
|
242
246
|
this object entirely (or call its return() method), otherwise the
|
|
@@ -250,7 +254,7 @@ connection will remain dangling.
|
|
|
250
254
|
|
|
251
255
|
#### Returns
|
|
252
256
|
|
|
253
|
-
`Promise
|
|
257
|
+
`Promise`\<[`RestStream`](RestStream.md)\>
|
|
254
258
|
|
|
255
259
|
#### Defined in
|
|
256
260
|
|