Merge pull request #3454 from video-dev/add-typings

.github/workflows/build.yml

@@ -80,8 +80,7 @@ jobs:
 
       - name: build
         run: |
-          npm run type-check
-          npm run build
+          npm run build:ci
           npm run docs
           # check that hls.js doesn't error if requiring in node
           # see https://github.com/video-dev/hls.js/pull/1642

.gitignore

@@ -16,6 +16,7 @@ coverage/
 .idea/*
 
 # Build
+/lib
 /dist
 /dist.zip
 /netlify

.prettierignore

@@ -3,3 +3,4 @@
 package-lock.json
 /coverage
 libs/
+/api-extractor/report*

README.md

@@ -223,12 +223,6 @@ Or type
 npm install --save hls.js
 ```
 
-Optionally there is a declaration file available to help with code completion and hinting within your IDE for the hls.js api
-
-```sh
-npm install --save-dev @types/hls.js
-```
-
 ### Server-side-rendering (SSR) and `require` from a Node.js runtime
 
 We support this now. You can safely require this library in Node and absolutely nothing will happen :) See https://github.com/video-dev/hls.js/pull/1841

api-extractor.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "mainEntryPointFilePath": "<projectFolder>/lib/hls.d.ts",
+  "bundledPackages": [],
+  "compiler": {
+    "tsconfigFilePath": "<projectFolder>/tsconfig-lib.json"
+  },
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/api-extractor/report",
+    "reportTempFolder": "<projectFolder>/api-extractor/report-temp"
+  },
+  "docModel": {
+    "enabled": false
+  },
+  "dtsRollup": {
+    "enabled": true,
+    "untrimmedFilePath": "<projectFolder>/dist/hls.js.d.ts"
+  },
+  "tsdocMetadata": {
+    "enabled": false
+  },
+  "newlineKind": "lf",
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning",
+        "addToApiReportFile": true
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning",
+        "addToApiReportFile": true
+      }
+    },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none",
+        "addToApiReportFile": false
+      }
+    }
+  }
+}

api-extractor/.gitignore

@@ -0,0 +1 @@
+/report-temp