feat: add ts types (#70)

multiformats · Dec 11, 2020 · 25cf33f · 25cf33f
1 parent 11cf881
commit 25cf33f
Show file tree

Hide file tree

Showing 15 changed files with 636 additions and 550 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -14,7 +14,7 @@ jobs:
     - uses: actions/checkout@v2
     - run: yarn
     - run: yarn lint
-    # - uses: gozala/typescript-error-reporter-action@v1.0.4
+    - uses: gozala/typescript-error-reporter-action@v1.0.4
     - run: yarn build
     - run: yarn aegir dep-check
     - uses: ipfs/aegir/actions/bundle-size@master

diff --git a/README.md b/README.md
@@ -29,12 +29,6 @@
 > npm install multicodec
 ```
 
-The type definitions for this package are available on http://definitelytyped.org/. To install just use:
-
- ```sh
- $ npm install -D @types/multicodec
- ```
-
 ## Usage
 
 ### Example

diff --git a/example.js b/example.js
diff --git a/package.json b/package.json
@@ -4,6 +4,10 @@
   "description": "JavaScript implementation of the multicodec specification",
   "leadMaintainer": "Henrique Dias <hacdias@gmail.com>",
   "main": "src/index.js",
+  "types": "dist/src/index.d.ts",
+  "typesVersions": {
+    "*": { "src/*": ["dist/src/*", "dist/src/*/index"] }
+  },
   "scripts": {
     "lint": "aegir lint",
     "test": "aegir test",