@clickup/rest-client 2.10.294 → 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.
Files changed (53) hide show
  1. package/.eslintrc.base.js +2 -1
  2. package/README.md +2 -0
  3. package/dist/.eslintcache +1 -1
  4. package/dist/errors/RestRateLimitError.d.ts.map +1 -1
  5. package/dist/errors/RestRateLimitError.js.map +1 -1
  6. package/dist/errors/RestRetriableError.d.ts.map +1 -1
  7. package/dist/errors/RestRetriableError.js.map +1 -1
  8. package/dist/errors/RestTokenInvalidError.d.ts.map +1 -1
  9. package/dist/errors/RestTokenInvalidError.js.map +1 -1
  10. package/dist/internal/inferResBodyEncoding.js.map +1 -1
  11. package/docs/README.md +2 -0
  12. package/docs/classes/PacerComposite.md +7 -3
  13. package/docs/classes/PacerQPS.md +7 -3
  14. package/docs/classes/RestClient.md +32 -28
  15. package/docs/classes/RestContentSizeOverLimitError.md +5 -1
  16. package/docs/classes/RestError.md +5 -1
  17. package/docs/classes/RestRateLimitError.md +6 -2
  18. package/docs/classes/RestRequest.md +22 -18
  19. package/docs/classes/RestResponse.md +7 -3
  20. package/docs/classes/RestResponseError.md +5 -1
  21. package/docs/classes/RestRetriableError.md +6 -2
  22. package/docs/classes/RestStream.md +12 -8
  23. package/docs/classes/RestTimeoutError.md +5 -1
  24. package/docs/classes/RestTokenInvalidError.md +6 -2
  25. package/docs/interfaces/Middleware.md +4 -4
  26. package/docs/interfaces/Pacer.md +2 -2
  27. package/docs/interfaces/PacerQPSBackend.md +2 -2
  28. package/docs/interfaces/RestLogEvent.md +1 -1
  29. package/docs/interfaces/RestOptions.md +39 -2
  30. package/docs/interfaces/TokenGetter.md +3 -3
  31. package/docs/modules.md +4 -4
  32. package/package.json +5 -2
  33. package/src/RestClient.ts +19 -19
  34. package/src/RestOptions.ts +3 -3
  35. package/src/RestRequest.ts +11 -11
  36. package/src/RestResponse.ts +1 -1
  37. package/src/RestStream.ts +1 -1
  38. package/src/errors/RestRateLimitError.ts +5 -1
  39. package/src/errors/RestResponseError.ts +3 -3
  40. package/src/errors/RestRetriableError.ts +5 -1
  41. package/src/errors/RestTokenInvalidError.ts +4 -1
  42. package/src/helpers/depaginate.ts +3 -3
  43. package/src/internal/RestFetchReader.ts +2 -2
  44. package/src/internal/RestRangeUploader.ts +2 -2
  45. package/src/internal/calcRetryDelay.ts +2 -2
  46. package/src/internal/inferResBodyEncoding.ts +13 -13
  47. package/src/internal/inspectPossibleJSON.ts +5 -5
  48. package/src/internal/substituteParams.ts +1 -1
  49. package/src/internal/throwIfErrorResponse.ts +7 -7
  50. package/src/middlewares/paceRequests.ts +1 -1
  51. package/src/pacers/PacerComposite.ts +1 -1
  52. package/src/pacers/PacerQPS.ts +3 -3
  53. package/tsconfig.json +3 -4
package/.eslintrc.base.js CHANGED
@@ -54,10 +54,11 @@ module.exports = (projectRoot) => ({
54
54
  },
55
55
  ignorePatterns: [
56
56
  "node_modules",
57
+ "dist",
57
58
  "webpack.config.ts",
58
59
  "**/bin/**",
59
60
  "*.d.ts",
60
- "**/jest.config.js",
61
+ "*.js",
61
62
  ],
62
63
  rules: {
63
64
  // TODO: slowly enable no-extraneous-dependencies rule below. For now, it's
package/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  See also [Full API documentation](https://github.com/clickup/rest-client/blob/master/docs/modules.md).
4
4
 
5
+ ![CI run](https://github.com/clickup/rest-client/actions/workflows/ci.yml/badge.svg?branch=main)
6
+
5
7
  ## Examples
6
8
 
7
9
  In the example below we use
package/dist/.eslintcache CHANGED
@@ -1 +1 @@
1
- [{"/Users/dmitry/git/rest-client/src/RestClient.ts":"1","/Users/dmitry/git/rest-client/src/RestOptions.ts":"2","/Users/dmitry/git/rest-client/src/RestRequest.ts":"3","/Users/dmitry/git/rest-client/src/RestResponse.ts":"4","/Users/dmitry/git/rest-client/src/RestStream.ts":"5","/Users/dmitry/git/rest-client/src/__tests__/RestClient.test.ts":"6","/Users/dmitry/git/rest-client/src/__tests__/RestFetchReader.test.ts":"7","/Users/dmitry/git/rest-client/src/__tests__/RestRequest.test.ts":"8","/Users/dmitry/git/rest-client/src/__tests__/RestStream.test.ts":"9","/Users/dmitry/git/rest-client/src/__tests__/example.ts":"10","/Users/dmitry/git/rest-client/src/__tests__/helpers.ts":"11","/Users/dmitry/git/rest-client/src/errors/RestContentSizeOverLimitError.ts":"12","/Users/dmitry/git/rest-client/src/errors/RestError.ts":"13","/Users/dmitry/git/rest-client/src/errors/RestRateLimitError.ts":"14","/Users/dmitry/git/rest-client/src/errors/RestResponseError.ts":"15","/Users/dmitry/git/rest-client/src/errors/RestRetriableError.ts":"16","/Users/dmitry/git/rest-client/src/errors/RestTimeoutError.ts":"17","/Users/dmitry/git/rest-client/src/errors/RestTokenInvalidError.ts":"18","/Users/dmitry/git/rest-client/src/helpers/depaginate.ts":"19","/Users/dmitry/git/rest-client/src/index.ts":"20","/Users/dmitry/git/rest-client/src/internal/RestFetchReader.ts":"21","/Users/dmitry/git/rest-client/src/internal/RestRangeUploader.ts":"22","/Users/dmitry/git/rest-client/src/internal/calcRetryDelay.ts":"23","/Users/dmitry/git/rest-client/src/internal/inferResBodyEncoding.ts":"24","/Users/dmitry/git/rest-client/src/internal/inspectPossibleJSON.ts":"25","/Users/dmitry/git/rest-client/src/internal/prependNewlineIfMultiline.ts":"26","/Users/dmitry/git/rest-client/src/internal/substituteParams.ts":"27","/Users/dmitry/git/rest-client/src/internal/throwIfErrorResponse.ts":"28","/Users/dmitry/git/rest-client/src/internal/toFloatMs.ts":"29","/Users/dmitry/git/rest-client/src/middlewares/paceRequests.ts":"30","/Users/dmitry/git/rest-client/src/pacers/Pacer.ts":"31","/Users/dmitry/git/rest-client/src/pacers/PacerComposite.ts":"32","/Users/dmitry/git/rest-client/src/pacers/PacerQPS.ts":"33"},{"size":15492,"mtime":1697211234000,"results":"34","hashOfConfig":"35"},{"size":7281,"mtime":1700187605000,"results":"36","hashOfConfig":"35"},{"size":14105,"mtime":1700185016000,"results":"37","hashOfConfig":"35"},{"size":2039,"mtime":1700185016000,"results":"38","hashOfConfig":"35"},{"size":2951,"mtime":1697508046000,"results":"39","hashOfConfig":"35"},{"size":1794,"mtime":1697211234000,"results":"40","hashOfConfig":"35"},{"size":4633,"mtime":1697507251000,"results":"41","hashOfConfig":"35"},{"size":5787,"mtime":1700185016000,"results":"42","hashOfConfig":"35"},{"size":1785,"mtime":1643144935000,"results":"43","hashOfConfig":"35"},{"size":966,"mtime":1697211234000,"results":"44","hashOfConfig":"35"},{"size":4765,"mtime":1703329476000,"results":"45","hashOfConfig":"35"},{"size":134,"mtime":1697211234000,"results":"46","hashOfConfig":"35"},{"size":206,"mtime":1697211234000,"results":"47","hashOfConfig":"35"},{"size":278,"mtime":1697211234000,"results":"48","hashOfConfig":"35"},{"size":1703,"mtime":1697211234000,"results":"49","hashOfConfig":"35"},{"size":278,"mtime":1697211234000,"results":"50","hashOfConfig":"35"},{"size":121,"mtime":1697211234000,"results":"51","hashOfConfig":"35"},{"size":281,"mtime":1697211234000,"results":"52","hashOfConfig":"35"},{"size":1165,"mtime":1701575071000,"results":"53","hashOfConfig":"35"},{"size":1431,"mtime":1697211234000,"results":"54","hashOfConfig":"35"},{"size":5803,"mtime":1700185016000,"results":"55","hashOfConfig":"35"},{"size":1958,"mtime":1697161645000,"results":"56","hashOfConfig":"35"},{"size":1499,"mtime":1697211234000,"results":"57","hashOfConfig":"35"},{"size":1504,"mtime":1697508294000,"results":"58","hashOfConfig":"35"},{"size":1965,"mtime":1667636290000,"results":"59","hashOfConfig":"35"},{"size":122,"mtime":1644728801000,"results":"60","hashOfConfig":"35"},{"size":715,"mtime":1697211234000,"results":"61","hashOfConfig":"35"},{"size":2601,"mtime":1697211234000,"results":"62","hashOfConfig":"35"},{"size":111,"mtime":1644728801000,"results":"63","hashOfConfig":"35"},{"size":1056,"mtime":1700181803000,"results":"64","hashOfConfig":"35"},{"size":532,"mtime":1653166697000,"results":"65","hashOfConfig":"35"},{"size":766,"mtime":1697161701000,"results":"66","hashOfConfig":"35"},{"size":5652,"mtime":1697161712000,"results":"67","hashOfConfig":"35"},{"filePath":"68","messages":"69","suppressedMessages":"70","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1y3keoe",{"filePath":"71","messages":"72","suppressedMessages":"73","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"74","messages":"75","suppressedMessages":"76","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"77","messages":"78","suppressedMessages":"79","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"80","messages":"81","suppressedMessages":"82","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"83","messages":"84","suppressedMessages":"85","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"86","messages":"87","suppressedMessages":"88","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"89","messages":"90","suppressedMessages":"91","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"92","messages":"93","suppressedMessages":"94","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"95","messages":"96","suppressedMessages":"97","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"98","messages":"99","suppressedMessages":"100","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"101","messages":"102","suppressedMessages":"103","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"104","messages":"105","suppressedMessages":"106","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"107","messages":"108","suppressedMessages":"109","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"110","messages":"111","suppressedMessages":"112","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"113","messages":"114","suppressedMessages":"115","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"116","messages":"117","suppressedMessages":"118","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"119","messages":"120","suppressedMessages":"121","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"122","messages":"123","suppressedMessages":"124","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"125","messages":"126","suppressedMessages":"127","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"128","messages":"129","suppressedMessages":"130","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"131","messages":"132","suppressedMessages":"133","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"134","messages":"135","suppressedMessages":"136","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"137","messages":"138","suppressedMessages":"139","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"140","messages":"141","suppressedMessages":"142","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"143","messages":"144","suppressedMessages":"145","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"146","messages":"147","suppressedMessages":"148","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"149","messages":"150","suppressedMessages":"151","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"152","messages":"153","suppressedMessages":"154","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"155","messages":"156","suppressedMessages":"157","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"158","messages":"159","suppressedMessages":"160","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"161","messages":"162","suppressedMessages":"163","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"164","messages":"165","suppressedMessages":"166","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/dmitry/git/rest-client/src/RestClient.ts",[],[],"/Users/dmitry/git/rest-client/src/RestOptions.ts",[],[],"/Users/dmitry/git/rest-client/src/RestRequest.ts",[],["167","168"],"/Users/dmitry/git/rest-client/src/RestResponse.ts",[],[],"/Users/dmitry/git/rest-client/src/RestStream.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestClient.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestFetchReader.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestRequest.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestStream.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/example.ts",[],["169","170","171"],"/Users/dmitry/git/rest-client/src/__tests__/helpers.ts",[],["172"],"/Users/dmitry/git/rest-client/src/errors/RestContentSizeOverLimitError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestRateLimitError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestResponseError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestRetriableError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestTimeoutError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestTokenInvalidError.ts",[],[],"/Users/dmitry/git/rest-client/src/helpers/depaginate.ts",[],[],"/Users/dmitry/git/rest-client/src/index.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/RestFetchReader.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/RestRangeUploader.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/calcRetryDelay.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/inferResBodyEncoding.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/inspectPossibleJSON.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/prependNewlineIfMultiline.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/substituteParams.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/throwIfErrorResponse.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/toFloatMs.ts",[],[],"/Users/dmitry/git/rest-client/src/middlewares/paceRequests.ts",[],[],"/Users/dmitry/git/rest-client/src/pacers/Pacer.ts",[],[],"/Users/dmitry/git/rest-client/src/pacers/PacerComposite.ts",[],[],"/Users/dmitry/git/rest-client/src/pacers/PacerQPS.ts",[],[],{"ruleId":"173","severity":2,"message":"174","line":416,"column":7,"nodeType":"175","messageId":"176","endLine":416,"endColumn":18,"suggestions":"177","suppressions":"178"},{"ruleId":"173","severity":2,"message":"174","line":418,"column":7,"nodeType":"175","messageId":"176","endLine":418,"endColumn":18,"suggestions":"179","suppressions":"180"},{"ruleId":"173","severity":2,"message":"174","line":32,"column":3,"nodeType":"175","messageId":"176","endLine":32,"endColumn":14,"suggestions":"181","suppressions":"182"},{"ruleId":"173","severity":2,"message":"174","line":33,"column":3,"nodeType":"175","messageId":"176","endLine":33,"endColumn":14,"suggestions":"183","suppressions":"184"},{"ruleId":"173","severity":2,"message":"174","line":36,"column":21,"nodeType":"175","messageId":"176","endLine":36,"endColumn":34,"suppressions":"185"},{"ruleId":"186","severity":2,"message":"187","line":17,"column":41,"nodeType":"188","messageId":"189","endLine":87,"endColumn":2,"suppressions":"190"},"no-console","Unexpected console statement.","MemberExpression","unexpected",["191"],["192"],["193"],["194"],["195"],["196"],["197"],["198"],["199"],"@typescript-eslint/no-misused-promises","Promise returned in function argument where a void return was expected.","ArrowFunctionExpression","voidReturnArgument",["200"],{"messageId":"201","data":"202","fix":"203","desc":"204"},{"kind":"205","justification":"206"},{"messageId":"201","data":"207","fix":"208","desc":"204"},{"kind":"205","justification":"206"},{"messageId":"201","data":"209","fix":"210","desc":"204"},{"kind":"205","justification":"206"},{"messageId":"201","data":"211","fix":"212","desc":"204"},{"kind":"205","justification":"206"},{"kind":"205","justification":"206"},{"kind":"205","justification":"206"},"removeConsole",{"propertyName":"213"},{"range":"214","text":"206"},"Remove the console.log().","directive","",{"propertyName":"213"},{"range":"215","text":"206"},{"propertyName":"213"},{"range":"216","text":"206"},{"propertyName":"213"},{"range":"217","text":"206"},"log",[13236,13283],[13335,13389],[799,851],[854,923]]
1
+ [{"/Users/dmitry/git/rest-client/src/RestClient.ts":"1","/Users/dmitry/git/rest-client/src/RestOptions.ts":"2","/Users/dmitry/git/rest-client/src/RestRequest.ts":"3","/Users/dmitry/git/rest-client/src/RestResponse.ts":"4","/Users/dmitry/git/rest-client/src/RestStream.ts":"5","/Users/dmitry/git/rest-client/src/__tests__/RestClient.test.ts":"6","/Users/dmitry/git/rest-client/src/__tests__/RestFetchReader.test.ts":"7","/Users/dmitry/git/rest-client/src/__tests__/RestRequest.test.ts":"8","/Users/dmitry/git/rest-client/src/__tests__/RestStream.test.ts":"9","/Users/dmitry/git/rest-client/src/__tests__/helpers.ts":"10","/Users/dmitry/git/rest-client/src/errors/RestContentSizeOverLimitError.ts":"11","/Users/dmitry/git/rest-client/src/errors/RestError.ts":"12","/Users/dmitry/git/rest-client/src/errors/RestRateLimitError.ts":"13","/Users/dmitry/git/rest-client/src/errors/RestResponseError.ts":"14","/Users/dmitry/git/rest-client/src/errors/RestRetriableError.ts":"15","/Users/dmitry/git/rest-client/src/errors/RestTimeoutError.ts":"16","/Users/dmitry/git/rest-client/src/errors/RestTokenInvalidError.ts":"17","/Users/dmitry/git/rest-client/src/helpers/depaginate.ts":"18","/Users/dmitry/git/rest-client/src/index.ts":"19","/Users/dmitry/git/rest-client/src/internal/RestFetchReader.ts":"20","/Users/dmitry/git/rest-client/src/internal/RestRangeUploader.ts":"21","/Users/dmitry/git/rest-client/src/internal/calcRetryDelay.ts":"22","/Users/dmitry/git/rest-client/src/internal/inferResBodyEncoding.ts":"23","/Users/dmitry/git/rest-client/src/internal/inspectPossibleJSON.ts":"24","/Users/dmitry/git/rest-client/src/internal/prependNewlineIfMultiline.ts":"25","/Users/dmitry/git/rest-client/src/internal/substituteParams.ts":"26","/Users/dmitry/git/rest-client/src/internal/throwIfErrorResponse.ts":"27","/Users/dmitry/git/rest-client/src/internal/toFloatMs.ts":"28","/Users/dmitry/git/rest-client/src/middlewares/paceRequests.ts":"29","/Users/dmitry/git/rest-client/src/pacers/Pacer.ts":"30","/Users/dmitry/git/rest-client/src/pacers/PacerComposite.ts":"31","/Users/dmitry/git/rest-client/src/pacers/PacerQPS.ts":"32"},{"size":15511,"mtime":1705131952000,"results":"33","hashOfConfig":"34"},{"size":7284,"mtime":1705131952000,"results":"35","hashOfConfig":"34"},{"size":14116,"mtime":1705131952000,"results":"36","hashOfConfig":"34"},{"size":2040,"mtime":1705131952000,"results":"37","hashOfConfig":"34"},{"size":2952,"mtime":1705131952000,"results":"38","hashOfConfig":"34"},{"size":1798,"mtime":1705131952000,"results":"39","hashOfConfig":"34"},{"size":4641,"mtime":1705131952000,"results":"40","hashOfConfig":"34"},{"size":5841,"mtime":1705131952000,"results":"41","hashOfConfig":"34"},{"size":1786,"mtime":1705131952000,"results":"42","hashOfConfig":"34"},{"size":4772,"mtime":1705131952000,"results":"43","hashOfConfig":"34"},{"size":134,"mtime":1697211234000,"results":"44","hashOfConfig":"34"},{"size":206,"mtime":1697211234000,"results":"45","hashOfConfig":"34"},{"size":295,"mtime":1705131952000,"results":"46","hashOfConfig":"34"},{"size":1706,"mtime":1705131952000,"results":"47","hashOfConfig":"34"},{"size":295,"mtime":1705131952000,"results":"48","hashOfConfig":"34"},{"size":121,"mtime":1697211234000,"results":"49","hashOfConfig":"34"},{"size":294,"mtime":1705131952000,"results":"50","hashOfConfig":"34"},{"size":1168,"mtime":1705131952000,"results":"51","hashOfConfig":"34"},{"size":1431,"mtime":1697211234000,"results":"52","hashOfConfig":"34"},{"size":5805,"mtime":1705131952000,"results":"53","hashOfConfig":"34"},{"size":1960,"mtime":1705131952000,"results":"54","hashOfConfig":"34"},{"size":1501,"mtime":1705131952000,"results":"55","hashOfConfig":"34"},{"size":1550,"mtime":1705131636000,"results":"56","hashOfConfig":"34"},{"size":1970,"mtime":1705131952000,"results":"57","hashOfConfig":"34"},{"size":122,"mtime":1644728801000,"results":"58","hashOfConfig":"34"},{"size":716,"mtime":1705131952000,"results":"59","hashOfConfig":"34"},{"size":2608,"mtime":1705131952000,"results":"60","hashOfConfig":"34"},{"size":111,"mtime":1644728801000,"results":"61","hashOfConfig":"34"},{"size":1057,"mtime":1705131952000,"results":"62","hashOfConfig":"34"},{"size":532,"mtime":1653166697000,"results":"63","hashOfConfig":"34"},{"size":767,"mtime":1705131952000,"results":"64","hashOfConfig":"34"},{"size":5655,"mtime":1705131952000,"results":"65","hashOfConfig":"34"},{"filePath":"66","messages":"67","suppressedMessages":"68","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"bfbxpo",{"filePath":"69","messages":"70","suppressedMessages":"71","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"72","messages":"73","suppressedMessages":"74","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"75","messages":"76","suppressedMessages":"77","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"78","messages":"79","suppressedMessages":"80","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"81","messages":"82","suppressedMessages":"83","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"84","messages":"85","suppressedMessages":"86","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"87","messages":"88","suppressedMessages":"89","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"90","messages":"91","suppressedMessages":"92","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"93","messages":"94","suppressedMessages":"95","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"96","messages":"97","suppressedMessages":"98","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"99","messages":"100","suppressedMessages":"101","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"102","messages":"103","suppressedMessages":"104","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"105","messages":"106","suppressedMessages":"107","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"108","messages":"109","suppressedMessages":"110","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"111","messages":"112","suppressedMessages":"113","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"114","messages":"115","suppressedMessages":"116","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"117","messages":"118","suppressedMessages":"119","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"120","messages":"121","suppressedMessages":"122","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"123","messages":"124","suppressedMessages":"125","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"126","messages":"127","suppressedMessages":"128","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"129","messages":"130","suppressedMessages":"131","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"132","messages":"133","suppressedMessages":"134","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"135","messages":"136","suppressedMessages":"137","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"138","messages":"139","suppressedMessages":"140","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"141","messages":"142","suppressedMessages":"143","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"144","messages":"145","suppressedMessages":"146","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"147","messages":"148","suppressedMessages":"149","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"150","messages":"151","suppressedMessages":"152","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"153","messages":"154","suppressedMessages":"155","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"156","messages":"157","suppressedMessages":"158","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"159","messages":"160","suppressedMessages":"161","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/dmitry/git/rest-client/src/RestClient.ts",[],[],"/Users/dmitry/git/rest-client/src/RestOptions.ts",[],[],"/Users/dmitry/git/rest-client/src/RestRequest.ts",[],["162","163"],"/Users/dmitry/git/rest-client/src/RestResponse.ts",[],[],"/Users/dmitry/git/rest-client/src/RestStream.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestClient.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestFetchReader.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestRequest.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/RestStream.test.ts",[],[],"/Users/dmitry/git/rest-client/src/__tests__/helpers.ts",[],["164"],"/Users/dmitry/git/rest-client/src/errors/RestContentSizeOverLimitError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestRateLimitError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestResponseError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestRetriableError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestTimeoutError.ts",[],[],"/Users/dmitry/git/rest-client/src/errors/RestTokenInvalidError.ts",[],[],"/Users/dmitry/git/rest-client/src/helpers/depaginate.ts",[],[],"/Users/dmitry/git/rest-client/src/index.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/RestFetchReader.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/RestRangeUploader.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/calcRetryDelay.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/inferResBodyEncoding.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/inspectPossibleJSON.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/prependNewlineIfMultiline.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/substituteParams.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/throwIfErrorResponse.ts",[],[],"/Users/dmitry/git/rest-client/src/internal/toFloatMs.ts",[],[],"/Users/dmitry/git/rest-client/src/middlewares/paceRequests.ts",[],[],"/Users/dmitry/git/rest-client/src/pacers/Pacer.ts",[],[],"/Users/dmitry/git/rest-client/src/pacers/PacerComposite.ts",[],[],"/Users/dmitry/git/rest-client/src/pacers/PacerQPS.ts",[],[],{"ruleId":"165","severity":2,"message":"166","line":416,"column":7,"nodeType":"167","messageId":"168","endLine":416,"endColumn":18,"suggestions":"169","suppressions":"170"},{"ruleId":"165","severity":2,"message":"166","line":418,"column":7,"nodeType":"167","messageId":"168","endLine":418,"endColumn":18,"suggestions":"171","suppressions":"172"},{"ruleId":"173","severity":2,"message":"174","line":17,"column":41,"nodeType":"175","messageId":"176","endLine":87,"endColumn":2,"suppressions":"177"},"no-console","Unexpected console statement.","MemberExpression","unexpected",["178"],["179"],["180"],["181"],"@typescript-eslint/no-misused-promises","Promise returned in function argument where a void return was expected.","ArrowFunctionExpression","voidReturnArgument",["182"],{"messageId":"183","data":"184","fix":"185","desc":"186"},{"kind":"187","justification":"188"},{"messageId":"183","data":"189","fix":"190","desc":"186"},{"kind":"187","justification":"188"},{"kind":"187","justification":"188"},"removeConsole",{"propertyName":"191"},{"range":"192","text":"188"},"Remove the console.log().","directive","",{"propertyName":"191"},{"range":"193","text":"188"},"log",[13246,13293],[13345,13399]]
package/dist/errors/RestRateLimitError.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RestRateLimitError.d.ts","sourceRoot":"","sources":["../../src/errors/RestRateLimitError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,iBAAiB;IAC3B,OAAO,EAAE,MAAM;gBAAvC,OAAO,EAAE,MAAM,EAAS,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY;CAGvE"}
1
+ {"version":3,"file":"RestRateLimitError.d.ts","sourceRoot":"","sources":["../../src/errors/RestRateLimitError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,iBAAiB;IAGtD,OAAO,EAAE,MAAM;gBADtB,OAAO,EAAE,MAAM,EACR,OAAO,EAAE,MAAM,EACtB,GAAG,EAAE,YAAY;CAIpB"}
package/dist/errors/RestRateLimitError.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RestRateLimitError.js","sourceRoot":"","sources":["../../src/errors/RestRateLimitError.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAEpD,MAAqB,kBAAmB,SAAQ,2BAAiB;IAC/D,YAAY,OAAe,EAAS,OAAe,EAAE,GAAiB;QACpE,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QADc,YAAO,GAAP,OAAO,CAAQ;IAEnD,CAAC;CACF;AAJD,qCAIC"}
1
+ {"version":3,"file":"RestRateLimitError.js","sourceRoot":"","sources":["../../src/errors/RestRateLimitError.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAEpD,MAAqB,kBAAmB,SAAQ,2BAAiB;IAC/D,YACE,OAAe,EACR,OAAe,EACtB,GAAiB;QAEjB,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAHb,YAAO,GAAP,OAAO,CAAQ;IAIxB,CAAC;CACF;AARD,qCAQC"}
package/dist/errors/RestRetriableError.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RestRetriableError.d.ts","sourceRoot":"","sources":["../../src/errors/RestRetriableError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,iBAAiB;IAC3B,OAAO,EAAE,MAAM;gBAAvC,OAAO,EAAE,MAAM,EAAS,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY;CAGvE"}
1
+ {"version":3,"file":"RestRetriableError.d.ts","sourceRoot":"","sources":["../../src/errors/RestRetriableError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,iBAAiB;IAGtD,OAAO,EAAE,MAAM;gBADtB,OAAO,EAAE,MAAM,EACR,OAAO,EAAE,MAAM,EACtB,GAAG,EAAE,YAAY;CAIpB"}
package/dist/errors/RestRetriableError.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RestRetriableError.js","sourceRoot":"","sources":["../../src/errors/RestRetriableError.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAEpD,MAAqB,kBAAmB,SAAQ,2BAAiB;IAC/D,YAAY,OAAe,EAAS,OAAe,EAAE,GAAiB;QACpE,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QADc,YAAO,GAAP,OAAO,CAAQ;IAEnD,CAAC;CACF;AAJD,qCAIC"}
1
+ {"version":3,"file":"RestRetriableError.js","sourceRoot":"","sources":["../../src/errors/RestRetriableError.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAEpD,MAAqB,kBAAmB,SAAQ,2BAAiB;IAC/D,YACE,OAAe,EACR,OAAe,EACtB,GAAiB;QAEjB,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAHb,YAAO,GAAP,OAAO,CAAQ;IAIxB,CAAC;CACF;AARD,qCAQC"}
package/dist/errors/RestTokenInvalidError.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RestTokenInvalidError.d.ts","sourceRoot":"","sources":["../../src/errors/RestTokenInvalidError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,iBAAiB;aACtC,WAAW,EAAE,MAAM;gBAAnB,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,YAAY;CAGnE"}
1
+ {"version":3,"file":"RestTokenInvalidError.d.ts","sourceRoot":"","sources":["../../src/errors/RestTokenInvalidError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,iBAAiB,CAAC;AAChD,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,iBAAiB;aAEhD,WAAW,EAAE,MAAM;gBAAnB,WAAW,EAAE,MAAM,EACnC,GAAG,EAAE,YAAY;CAIpB"}
package/dist/errors/RestTokenInvalidError.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"RestTokenInvalidError.js","sourceRoot":"","sources":["../../src/errors/RestTokenInvalidError.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAEpD,MAAqB,qBAAsB,SAAQ,2BAAiB;IAClE,YAA4B,WAAmB,EAAE,GAAiB;QAChE,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QADE,gBAAW,GAAX,WAAW,CAAQ;IAE/C,CAAC;CACF;AAJD,wCAIC"}
1
+ {"version":3,"file":"RestTokenInvalidError.js","sourceRoot":"","sources":["../../src/errors/RestTokenInvalidError.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAEpD,MAAqB,qBAAsB,SAAQ,2BAAiB;IAClE,YACkB,WAAmB,EACnC,GAAiB;QAEjB,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAHR,gBAAW,GAAX,WAAW,CAAQ;IAIrC,CAAC;CACF;AAPD,wCAOC"}
package/dist/internal/inferResBodyEncoding.js.map CHANGED
@@ -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;YAChD,CAAC,CAAC,kEAAkE;gBAClE,QAAQ;YACV,CAAC,CAAC,OAAO,IAAI,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAC/C,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;AACd,CAAC;AAtBD,uCAsBC"}
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"}
package/docs/README.md CHANGED
@@ -4,6 +4,8 @@
4
4
 
5
5
  See also [Full API documentation](https://github.com/clickup/rest-client/blob/master/docs/modules.md).
6
6
 
7
+ ![CI run](https://github.com/clickup/rest-client/actions/workflows/ci.yml/badge.svg?branch=main)
8
+
7
9
  ## Examples
8
10
 
9
11
  In the example below we use
package/docs/classes/PacerComposite.md CHANGED
@@ -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`<{ `delayMs`: `number` ; `reason`: `string` }\>
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`<{ `delayMs`: `number` ; `reason`: `string` }\>
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`<[`PacerDelay`](../interfaces/PacerDelay.md)\>
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`<[`PacerDelay`](../interfaces/PacerDelay.md)\>
71
+ `Promise`\<[`PacerDelay`](../interfaces/PacerDelay.md)\>
68
72
 
69
73
  #### Implementation of
70
74
 
package/docs/classes/RestClient.md CHANGED
@@ -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`<[`RestOptions`](../interfaces/RestOptions.md)\> |
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`<[`RestOptions`](../interfaces/RestOptions.md)\> |
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`<`string`\> |
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`<`string`\> |
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)<`string`\> | `undefined` |
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)<{ `token`: `string` ; `tokenSecret`: `string` }\> |
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)<{ `name`: `string` ; `password`: `string` }\> |
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)<`any`\>
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`<`Record`<`string`, `string` \| `number` \| `string`[]\>\> | `{}` |
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)<`any`\>
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)<`any`\>
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)<`any`\>
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)<`any`\>
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)<`any`\>
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)<`any`\>
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`<`Record`<`string`, `string`\>\> | `undefined` |
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)<`any`\>
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)<`any`\>
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`<`Record`<`string`, `string`\>\> | `{}` |
340
+ | `args` | `Partial`\<`Record`\<`string`, `string`\>\> | `{}` |
337
341
  | `accept` | `string` | `"application/json"` |
338
342
 
339
343
  #### Returns
340
344
 
341
- [`RestRequest`](RestRequest.md)<`any`\>
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)<`any`\>
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)<`any`\>
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)<`undefined` \| ``null`` \| { `data?`: `any` ; `error?`: `any` ; `errors?`: `any`[] }\>
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)<`undefined` \| ``null`` \| { `data?`: `any` ; `error?`: `any` ; `errors?`: `any`[] }\>
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`<``null`` \| `string`\>
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`<`Buffer`\> | `undefined` |
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`<``null`` \| `string`\>
424
+ `Promise`\<``null`` \| `string`\>
421
425
 
422
426
  #### Defined in
423
427
 
package/docs/classes/RestContentSizeOverLimitError.md CHANGED
@@ -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)
package/docs/classes/RestError.md CHANGED
@@ -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
package/docs/classes/RestRateLimitError.md CHANGED
@@ -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:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestRateLimitError.ts#L5)
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