From f0650c4f879ccd9caad41118106199c5d99c6d1b Mon Sep 17 00:00:00 2001 From: Erik Marks Date: Mon, 2 Nov 2020 17:04:56 -0800 Subject: [PATCH] Fix readme --- README.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d5dd4fe..5229e02 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ and [making unknown errors compliant with either spec](#parsing-unknown-errors). ## Basic Usage +In TypeScript or JavaScript: + ```js import { ethErrors } from 'eth-rpc-errors' @@ -32,6 +34,8 @@ Installation: `npm install eth-rpc-errors` or `yarn add eth-rpc-errors` `import` or `require` as normal (no default export). +The package is implemented in TypeScript, and all exports are typed. + ### Errors API ```js @@ -101,16 +105,6 @@ response.error = serializeError(maybeAnError, fallbackError) ### Other Exports ```js -/** - * TypeScript interfaces - */ -import { - // these describe to the corresponding exports from index.js - IEthErrors, IEthereumRpcError, IEthereumProviderError, ISerializeError, - // these describe the options argument to error getters in ethErrors - IErrorOptions, IRpcServerErrorOptions, IProviderCustomErrorOptions -} from 'eth-rpc-errors/@types' - /** * Classes */