feat: add ts types with aegir

this is a best effort approach since multiformats/multiformats will probably superseed this repo soon.

.github/workflows/main.yml

@@ -0,0 +1,67 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - run: yarn
+    - run: yarn lint
+    - run: yarn build
+    - uses: gozala/typescript-error-reporter-action@v1.0.4
+    - run: yarn aegir dep-check -- -i aegir
+    - uses: ipfs/aegir/actions/bundle-size@master
+      name: size
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+  test-node:
+    needs: check
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        node: [12, 14]
+      fail-fast: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - run: yarn
+      - run: npx nyc --reporter=lcov npm run test:node -- --bail
+      - uses: codecov/codecov-action@v1
+  test-chrome:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn
+      - run: yarn aegir test -t browser -t webworker
+  test-firefox:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn
+      - run: yarn aegir test -t browser -t webworker -- --browsers FirefoxHeadless
+  test-electron-main:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn
+      - run: npx xvfb-maybe yarn aegir test -t electron-main --bail
+  test-electron-renderer:
+    needs: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn
+      - run: npx xvfb-maybe yarn aegir test -t electron-renderer --bail

package.json

@@ -17,6 +17,10 @@
     "coverage": "aegir coverage",
     "docs": "aegir docs"
   },
+  "files": [
+    "src",
+    "dist"
+  ],
   "pre-push": [
     "lint",
     "test"
@@ -35,20 +39,22 @@
     "url": "https://github.com/multiformats/js-cid/issues"
   },
   "dependencies": {
-    "class-is": "^1.1.0",
     "multibase": "^3.0.1",
     "multicodec": "^2.0.1",
     "multihashes": "^3.0.1",
     "uint8arrays": "^1.1.0"
   },
   "devDependencies": {
-    "aegir": "^26.0.0",
+    "aegir": "^29.0.1",
     "multihashing-async": "^2.0.1"
   },
   "engines": {
     "node": ">=4.0.0",
     "npm": ">=3.0.0"
   },
+  "eslintConfig": {
+    "extends": "ipfs"
+  },
   "contributors": [
     "David Dias <daviddias.p@gmail.com>",
     "Volker Mische <volker.mische@gmail.com>",

src/cid-util.js

@@ -9,7 +9,7 @@ const CIDUtil = {
    * Returns undefined if it is a valid CID.
    *
    * @param {any} other
-   * @returns {string}
+   * @returns {string|undefined}
    */
   checkCIDComponents: function (other) {
     if (other == null) {