Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove outdated interface information in readme #30

Merged
merged 1 commit into from
Nov 3, 2020
Merged

Remove outdated interface information in readme #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand All @@ -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
Expand Down Expand Up @@ -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
*/
Expand Down