Skip to content

feat!: convert to interface #274

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

Merged
merged 3 commits into from
Sep 21, 2022
Merged

feat!: convert to interface #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe548a5
feat!: convert to interface
achingbrain Sep 20, 2022
f1cede9
chore: reduce redundancy
achingbrain Sep 20, 2022
4f7dd4c
chore: linting
achingbrain Sep 20, 2022
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
18 changes: 4 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
## Table of contents <!-- omit in toc -->

- [Install](#install)
- [Lead Maintainer](#lead-maintainer)
- [Background](#background)
- [What is multiaddr?](#what-is-multiaddr)
- [Browser: `<script>` Tag](#browser-script-tag)
Expand All @@ -25,10 +24,6 @@
$ npm i @multiformats/multiaddr
```

## Lead Maintainer

[Jacob Heun](https://github.com/jacobheun)

## Background

### What is multiaddr?
Expand Down Expand Up @@ -57,15 +52,11 @@ the global namespace.
## Usage

```js
// if we are coming from <= 8.x you can use the factory function
const { multiaddr } = require('multiaddr')
import { multiaddr } from 'multiaddr'
const addr = multiaddr("/ip4/127.0.0.1/udp/1234")
// <Multiaddr /ip4/127.0.0.1/udp/1234>

// or just the class directly
const { Multiaddr } = require('multiaddr')

const addr = new Multiaddr("/ip4/127.0.0.1/udp/1234")
const addr = multiaddr("/ip4/127.0.0.1/udp/1234")
// <Multiaddr /ip4/127.0.0.1/udp/1234>

addr.bytes
Expand Down Expand Up @@ -106,10 +97,9 @@ addr.encapsulate('/sctp/5678')
To provide multiaddr resolvers you can do:

```js
const { Multiaddr } = require('multiaddr')
const resolvers = require('multiaddr/src/resolvers')
import { resolvers } from 'multiaddr'

Multiaddr.resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
resolvers.set('dnsaddr', resolvers.dnsaddrResolver)
```

The available resolvers are:
Expand Down
Loading