docs: add types and documentation

.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
+    - uses: gozala/[email protected]
+    # - run: yarn build
+    - run: yarn aegir dep-check
+    # - 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 aegir test -t node -- --bail
+  #     - uses: codecov/codecov-action@v1
+  # test-chrome:
+  #   needs: check
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - run: yarn
+  #     - run: npx aegir test -t browser -t webworker --bail
+  # test-firefox:
+  #   needs: check
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - run: yarn
+  #     - run: npx aegir test -t browser -t webworker --bail -- --browsers FirefoxHeadless
+  # test-electron-main:
+  #   needs: check
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - run: yarn
+  #     - run: npx xvfb-maybe 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 aegir test -t electron-renderer --bail

.gitignore

@@ -1 +1,2 @@
 node_modules
+dist