feat: move to ts

.gitignore

@@ -7,4 +7,7 @@ node_modules
 
 .nyc_output
 coverage
-coverage.*
+coverage.*
+
+/lib
+/dist

.prettierignore

@@ -1 +1,3 @@
-# noop
+# noop
+/lib
+/dist

README.md

@@ -23,26 +23,27 @@ this package require async/await environment.
 ## API
 
 ```js
-const pretry = require('promise.retry')
-const TimeoutError = pretry.TimeoutError
-const RetryError = pretry.RetryError
+import { pretry, TimeoutError, RetryError } from 'promise.retry'
 ```
 
 ### pretry
 
-```
-const fnWithRetry = pretry(fn, options);
+```js
+const fnWithRetry = pretry(fn, options)
 ```
 
 - `fn` the original async function
 - `options`
   - `times` : `int` try how many times
   - `timeout` : `int` the timeout for each attempt, in ms
-  - `onerror` : `function(err, index)` add extra action on an attempt error
+  - `delay`: `number` or `(i: number) => number`, retry delay, in ms.
+  - `onerror` : `(err: any, i: number) => any` add extra action on an attempt error
+
+i is always `0` based. (starts from `0`)
 
 ### TimeoutError
 
-reexport from `promise.timeout`, see https://github.com/magicdawn/promise.timeout#api
+re-export from `promise.timeout`, see https://github.com/magicdawn/promise.timeout#api
 
 ### RetryError
 
@@ -57,7 +58,7 @@ props
 
 ### `AbortSignal`
 
-if `options.timeout` Provided, ptimeout will provide a extra runtime argument `signal?: AbortSignal`
+if `options.timeout` is provided, ptimeout will provide a extra runtime argument `signal?: AbortSignal`
 use like below, see more at https://github.com/magicdawn/promise.timeout#singal
 
 ```ts

package.json

@@ -2,20 +2,19 @@
   "name": "promise.retry",
   "version": "1.2.0",
   "description": "add (timeout and fail) retry for async functions",
-  "main": "index.js",
-  "types": "types/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "files": [
-    "index.js",
-    "types/index.d.ts",
+    "lib/",
     "README.md",
     "package.json"
   ],
   "scripts": {
     "gen-readme": "swig render ./_readme/readme.md > README.md && prettier --write README.md",
     "prepare": "husky install",
     "tsd": "tsd",
-    "test": "vitest run && tsd",
-    "test-cover": "vitest run --coverage && tsd"
+    "test": "vitest run",
+    "test-cover": "vitest run --coverage"
   },
   "repository": {
     "type": "git",
@@ -38,17 +37,18 @@
   "devDependencies": {
     "@magicdawn/eslint-config": "^0.1.0",
     "@magicdawn/prettier-config": "^0.0.3",
-    "@types/jest": "^29.5.11",
-    "@vitest/coverage-v8": "^1.2.1",
-    "eslint": "^8.56.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.5",
+    "@vitest/coverage-v8": "^1.4.0",
+    "eslint": "^8.57.0",
     "husky": "^8.0.3",
     "jest": "^29.7.0",
-    "lint-staged": "^15.2.0",
-    "prettier": "^3.2.4",
+    "lint-staged": "^15.2.2",
+    "prettier": "^3.2.5",
     "should": "^13.2.3",
     "swig-templates": "^2.0.3",
-    "tsd": "^0.30.4",
-    "vitest": "^1.2.1"
+    "tsd": "^0.31.0",
+    "vitest": "^1.4.0"
   },
   "engines": {
     "node": ">=7.6.0"