Merge pull request #11 from Gozala/fix-types

fix: type declarations

Author: Gozala

.github/workflows/node.js.yml

@@ -37,10 +37,29 @@ jobs:
       - name: Type Check
         run: npm run check --if-present
       - name: Test ES
-        if: ${{matrix.node-version < 12}}
+        if: ${{!startsWith(matrix.node-version, '10.')}}
         run: npm run test:es --if-present
       - name: Test CommonJS
         run: npm run test:cjs --if-present
+  validate-types:
+    name: Check type use
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        test-package: ['ts', 'esm', 'cjs']
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache node_modules
+        id: cache-modules
+        uses: actions/cache@v1
+        with:
+          path: node_modules
+          key: 12.x-${{ runner.OS }}-build-${{ hashFiles('package.json') }}
+      - name: Install
+        if: steps.cache-modules.outputs.cache-hit != 'true'
+        run: npm install
+      - name: Test ${{ matrix.test-package }}
+        run: npm run test:types:${{matrix.test-package}}
   publish:
     name: Publish
     needs: test

.gitignore

@@ -1 +1,2 @@
 node_modules
+test/**/package-lock.json

package.json

@@ -23,7 +23,11 @@
     "test:browser": "playwright-test test/test-*.cjs",
     "test:es": "mocha test/test-*.spec.js",
     "test:cjs": "npm run test:node && npm run test:browser",
-    "test": "npm run test:es && npm run test:cjs"
+    "test:types:ts": "npm test --prefix test/ts-use",
+    "test:types:esm": "npm test --prefix test/esm-use",
+    "test:types:cjs": "npm test --prefix test/cjs-use",
+    "test:types": "npm run test:types:ts && npm run test:types:esm && npm run test:types:cjs",
+    "test": "npm run test:es && npm run test:cjs && npm run test:types"
   },
   "license": "MIT",
   "author": "Irakli Gozalishvili <[email protected]>",

src/lib.d.ts

@@ -1,4 +1,4 @@
-type Encoder = TextEncoder
-type Decoder = TextDecoder
+declare var TextEncoder: typeof self.TextEncoder
+declare var TextDecoder: typeof self.TextDecoder
 
-export { Encoder as TextEncoder, Decoder as TextDecoder }
+export { TextEncoder, TextDecoder }

test/cjs-use/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "cjs-use",
+  "private": true,
+  "dependencies": {
+    "web-encoding": "file:../.."
+  },
+  "scripts": {
+    "test": "npm install && npx typescript --noEmit --allowJs --checkJs src/main.js"
+  }
+}

test/cjs-use/src/main.js

@@ -0,0 +1,19 @@
+// @ts-check
+
+const { TextEncoder, TextDecoder } = require("web-encoding")
+
+/**
+ * @param {string} text
+ * @returns {Uint8Array}
+ */
+const encode = (text) =>
+  new TextEncoder().encode(text)
+
+/**
+ * @param {Uint8Array} bytes
+ * @returns {string}
+ */
+const decode = (bytes) =>
+  new TextDecoder().decode(bytes)
+
+module.exports = { encode, decode }

test/esm-use/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "esm-use",
+  "private": true,
+  "dependencies": {
+    "web-encoding": "file:../.."
+  },
+  "scripts": {
+    "test": "npm install && npx typescript --noEmit --allowJs --checkJs src/main.js"
+  }
+}

test/esm-use/src/main.js

@@ -0,0 +1,17 @@
+// @ts-check
+
+import { TextEncoder, TextDecoder } from "web-encoding"
+
+/**
+ * @param {string} text
+ * @returns {Uint8Array}
+ */
+export const encode = (text) =>
+  new TextEncoder().encode(text)
+
+/**
+ * @param {Uint8Array} bytes
+ * @returns {string}
+ */
+export const decode = (bytes) =>
+  new TextDecoder().decode(bytes)

test/ts-use/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "ts-use",
+  "private": true,
+  "dependencies": {
+    "web-encoding": "file:../.."
+  },
+  "scripts": {
+    "test": "npm install && npx typescript --noEmit"
+  }
+}

test/ts-use/src/main.ts

@@ -0,0 +1,7 @@
+import { TextEncoder, TextDecoder } from "web-encoding"
+
+export const encode = (text:string):Uint8Array =>
+  new TextEncoder().encode(text)
+
+export const decode = (bytes:Uint8Array):string =>
+  new TextDecoder().decode(bytes)