Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
version: 2
updates:
- package-ecosystem: npm
directories:
- "/"
directory: "/"
schedule:
interval: daily
time: "10:00"
Expand Down
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,20 @@ multiaddr(maWithCustomTuple)
registry.removeProtocol(protocol.code)
```

# Install

```console
$ npm i @multiformats/multiaddr
```

## Browser `<script>` tag

Loading this module through a script tag will make its exports available as `MultiformatsMultiaddr` in the global namespace.

```html
<script src="https://unpkg.com/@multiformats/multiaddr/dist/index.min.js"></script>
```

# API Docs

- <https://multiformats.github.io/js-multiaddr>
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
"exports": {
".": {
"types": "./dist/src/index.d.ts",
"import": "./dist/src/index.js"
"import": "./dist/src/index.js",
"module-sync": "./dist/src/index.js"
}
},
"release": {
Expand Down Expand Up @@ -150,7 +151,7 @@
"uint8arrays": "^5.0.0"
},
"devDependencies": {
"aegir": "^47.0.16"
"aegir": "^48.0.4"
},
"browser": {
"./dist/src/resolvers/dns.js": "./dist/src/resolvers/dns.browser.js"
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
* ```
*/

import { Multiaddr as MultiaddrClass, symbol } from './multiaddr.js'
import { Multiaddr as MultiaddrClass, symbol } from './multiaddr.ts'
import { registry, V } from './registry.ts'
import type { ProtocolCodec } from './registry.ts'

Expand Down
6 changes: 3 additions & 3 deletions src/multiaddr.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
import { bytesToComponents, componentsToBytes, componentsToString, stringToComponents } from './components.js'
import { bytesToComponents, componentsToBytes, componentsToString, stringToComponents } from './components.ts'
import { InvalidMultiaddrError, InvalidParametersError } from './errors.ts'
import { isMultiaddr } from './index.ts'
import { registry } from './registry.ts'
import { isMultiaddr } from './index.js'
import type { MultiaddrInput, Multiaddr as MultiaddrInterface, Component } from './index.js'
import type { MultiaddrInput, Multiaddr as MultiaddrInterface, Component } from './index.ts'

const inspect = Symbol.for('nodejs.util.inspect.custom')
export const symbol = Symbol.for('@multiformats/multiaddr')
Expand Down
3 changes: 1 addition & 2 deletions test/codec.spec.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
/* eslint-env mocha */
import { expect } from 'aegir/chai'
import { componentsToString, stringToComponents } from '../src/components.ts'
import { CODE_HTTP, CODE_HTTP_PATH, CODE_IP4, CODE_UNIX, CODE_UTP } from '../src/constants.ts'
import type { Component } from '../src/index.js'
import type { Component } from '../src/index.ts'

interface TestCase {
name: string
Expand Down
5 changes: 2 additions & 3 deletions test/index.spec.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
/* eslint max-nested-callbacks: ["error", 8] */
/* eslint-env mocha */
import { expect } from 'aegir/chai'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
import { multiaddr, isMultiaddr, CODE_IP4 } from '../src/index.js'
import type { Multiaddr } from '../src/index.js'
import { multiaddr, isMultiaddr, CODE_IP4 } from '../src/index.ts'
import type { Multiaddr } from '../src/index.ts'

function roundTrip (str: string): void {
const output = str.replace('/ipfs/', '/p2p/')
Expand Down
1 change: 0 additions & 1 deletion test/utils.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/* eslint-env mocha */
import { expect } from 'aegir/chai'
import { base64url } from 'multiformats/bases/base64'
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
Expand Down
Loading