Create TypeScript declarations from JSDoc (#45)

tinovyatkin · web-flow · commit a1fef8cd0b4c · 2020-06-10T16:09:02.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -62,5 +62,4 @@ typings/
 # dotenv environment variables file
 .env
 
-# next.js build output
-.next
+index.d.ts
diff --git a/index.d.ts b/index.d.ts
diff --git a/index.js b/index.js
@@ -129,7 +129,7 @@ class Blob {
 	 *
 	 * @param {number} [start]
 	 * @param {number} [end]
-	 * @param {string} [contentType]
+	 * @param {string} [type]
 	 */
 	slice(start = 0, end = this.size, type = '') {
 		const {size} = this;
diff --git a/package.json b/package.json
@@ -11,7 +11,8 @@
     "lint": "xo",
     "test": "xo && ava",
     "report": "nyc ava",
-    "coverage": "nyc --reporter json --reporter text ava && codecov -f coverage/coverage-final.json"
+    "coverage": "nyc --reporter json --reporter text ava && codecov -f coverage/coverage-final.json",
+    "prepublishOnly": "tsc --declaration --emitDeclarationOnly --allowJs index.js"
   },
   "repository": "https://github.com/node-fetch/fetch-blob.git",
   "keywords": [
@@ -33,6 +34,7 @@
     "get-stream": "^5.1.0",
     "node-fetch": "^2.6.0",
     "nyc": "^15.0.1",
+    "typescript": "^3.9.5",
     "xo": "^0.32.0"
   },
   "xo": {

Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ class Blob {`
`129`	`129`	`*`
`130`	`130`	`* @param {number} [start]`
`131`	`131`	`* @param {number} [end]`
`132`		`- * @param {string} [contentType]`
	`132`	`+ * @param {string} [type]`
`133`	`133`	`*/`
`134`	`134`	`slice(start = 0, end = this.size, type = '') {`
`135`	`135`	`const {size} = this;`