feat: add TS libdef

.nycrc.json

@@ -11,7 +11,8 @@
   ],
   "exclude": [
     "test",
-    "node_modules"
+    "node_modules",
+    "patch-md.js"
   ],
   "check-coverage": true,
   "report-dir": ".nyc_output"

.travis.yml

@@ -3,6 +3,7 @@ dist: focal
 language: node_js
 
 node_js:
+  - '20'
   - '18'
   - '16'
   - '14'
@@ -27,7 +28,7 @@ script:
   - npm run readme
   - test -z "$(git diff)"
 
-  - npm test
+  # run tests with coverage
   - npm run cover
 
 after_success:
@@ -38,5 +39,5 @@ deploy:
   skip_cleanup: true
   script: semantic-release
   on:
-    node_js: '16'
+    node_js: '20'
     all_branches: true

index.d.ts

@@ -0,0 +1,19 @@
+type RetryOptions = {
+  retries?: number
+  initialDelay?: number
+  timeout?: number
+  factor?: number
+  log?: (msg: string) => void
+  shouldRetry?: (err: Error) => boolean
+}
+
+type Callable = (...args: any[]) => any
+
+type RetryWrapper = {
+  <T extends Callable = Callable>(fn: T): T
+  <T extends Callable = Callable>(opts: RetryOptions, fn: T): T
+}
+
+declare function retryify(opts: RetryOptions): RetryWrapper
+
+export = retryify

index.js

@@ -26,8 +26,9 @@ const getOpt = function(option, _default) {
  * @param {Number} context.initialDelay time to wait before making attempts
  * @param {Number} context.timeout time to wait between retries (in ms)
  * @param {Number} context.factor the exponential scaling factor
- * @param {function} options.shouldRetry - Invoked with the thrown error,
+ * @param {Function} context.shouldRetry - Invoked with the thrown error,
  * retryify will retry if this method returns true.
+ * @param {Function} context.log logging function that takes a message as input
  *
  * @return {Promise} a Promise for whatever the wrapped function eventually
  *   resolves to.
@@ -107,9 +108,9 @@ const execute = async function(context) {
  *   after 200 ms, the third after 400 ms, etc.... The formula used to
  *   calculate the delay between each retry:
  *   ```timeout * Math.pow(factor, attempts)```
- * @property {function} [options.shouldRetry=() => true] - Invoked with the
+ * @property {Function} [options.shouldRetry=() => true] - Invoked with the
  * thrown error, retryify will retry if this method returns true.
- * @property {Function} [options.log] Logging function that takes a message as
+ * @property {Function} [options.log] Logging function that takes a message as input
  */
 
 /**
@@ -191,4 +192,6 @@ const retryify = function(options = {}) {
   return retryWrapper;
 };
 
+retryify.retryify = retryify;
+
 module.exports = retryify;