Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

chore: minor migration guide fixes #4118

Merged
merged 1 commit into from
Jun 1, 2022
Merged

chore: minor migration guide fixes #4118

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
8 changes: 4 additions & 4 deletions docs/upgrading/v0.62-v0.63.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

The biggest change to `ipfs@0.63.x` is that the module is now [ESM-only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).

ESM is the module system for JavaScript, it allows us to structure our code in separate files without polluting a global namespace.
ESM is the module system for JavaScript. It allows us to structure our code in separate files without polluting a global namespace.

Other systems have tried to fill this gap, notably CommonJS, AMD, RequireJS and others, but ESM is [the official standard format](https://tc39.es/ecma262/#sec-modules) to package JavaScript code for reuse.

Expand All @@ -34,11 +34,11 @@ async function loadIpfs () {
}
```

## libp2p@0.37.x
## `libp2p@0.37.x`

`ipfs@0.63.x` upgrades to `libp2p@0.37.x`. This is a significant refactor that ports the entire stack to TypeScript and publishes all modules as ESM-only code.

Please see the [libp2p 0.37.x` upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.36-v.037.md) for how this may affect your application.
Please see the [libp2p 0.37.x upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.36-v.037.md) for how this may affect your application.

## PeerIds

Expand Down Expand Up @@ -116,7 +116,7 @@ const peerId = await createEd25519PeerId()

## multiaddrs

The `multiaddr` module has been ported to Typescript and is now published as ESM-only.
The `multiaddr` module has been ported to TypeScript and is now published as ESM-only.

It has been renamed to `@multiformats/multiaddr` so please update your dependencies and replace usage in your code.

Expand Down