Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit 876ae7c

Browse files
author
Alan Shaw
authored
docs: tweak formatting in changelog for v40
1 parent 79ff532 commit 876ae7c

File tree

1 file changed

+12
-20
lines changed

1 file changed

+12
-20
lines changed

CHANGELOG.md

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,34 +22,26 @@
2222
### BREAKING CHANGES
2323

2424
* The `log.tail` method now returns an async iterator that yields log messages. Use it like:
25-
26-
```js
27-
for await (const message of ipfs.log.tail()) {
28-
console.log(message)
29-
}
30-
```
25+
```js
26+
for await (const message of ipfs.log.tail()) {
27+
console.log(message)
28+
}
29+
```
3130
* The response to a call to `log.level` now returns an object that has camel cased keys. i.e. `Message` and `Error` properties have changed to `message` and `error`.
3231
* Dropped support for go-ipfs <= 0.4.4 in `swarm.peers` response.
3332
* The signature for `ipfs.mount` has changed from `ipfs.mount([ipfsPath], [ipnsPath])` to `ipfs.mount([options])`. Where `options` is an optional object that may contain two boolean properties `ipfsPath` and `ipnsPath`. The response object has also changed to be camel case. See https://docs.ipfs.io/reference/api/http/#api-v0-mount.
3433
* Default ping `count` of 1 in client has been removed. The default ping count is now whatever the IPFS node defaults it to (currently 10). If you specifically need 1 ping message then please pass `count: 1` in options for `ipfs.ping()`.
3534
* Multi parameter constructor options are no longer supported. To create a new IPFS HTTP client, pass a single parameter to the constructor. The parameter can be one of:
36-
37-
* String, formatted as one of:
38-
* Multiaddr e.g. /ip4/127.0.0.1/tcp/5001
39-
* URL e.g. http://127.0.0.1:5001
40-
* [Multiaddr](https://www.npmjs.com/package/multiaddr) instance
41-
* Object, in format of either:
42-
* Address and path e.g. `{ apiAddr: '/ip4/127.0.0.1/tcp/5001': apiPath: '/api/v0' }` (Note: `apiAddr` can also be a string in URL form or a Multiaddr instance)
43-
* Node.js style address e.g. `{ host: '127.0.0.1', port: 5001, protocol: 'http' }`
35+
* String, formatted as one of:
36+
* Multiaddr e.g. /ip4/127.0.0.1/tcp/5001
37+
* URL e.g. http://127.0.0.1:5001
38+
* [Multiaddr](https://www.npmjs.com/package/multiaddr) instance
39+
* Object, in format of either:
40+
* Address and path e.g. `{ apiAddr: '/ip4/127.0.0.1/tcp/5001': apiPath: '/api/v0' }` (Note: `apiAddr` can also be a string in URL form or a Multiaddr instance)
41+
* Node.js style address e.g. `{ host: '127.0.0.1', port: 5001, protocol: 'http' }`
4442
* Errors returned from request failures are now all [`HTTPError`](https://github.com/sindresorhus/ky/blob/c0d9d2bb07e4c122a08f019b39e9c55a4c9324f3/index.js#L117-L123)s which carry a `response` property. This is a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) that can be used to inspect _all_ information relating to the HTTP response. This means that the `err.status` or `err.statusCode` property should now be accessed via `err.response.status`.
45-
46-
License: MIT
47-
Signed-off-by: Alan Shaw <[email protected]>
4843
* files in `src/files-regular` have moved to `src`. The `src/files-mfs` directory has been renamed to `src/files`. If you were previously requiring files from these directories e.g. `require('ipfs-http-client/src/files-regular/add')` then please be aware that they have moved.
4944

50-
License: MIT
51-
Signed-off-by: Alan Shaw <[email protected]>
52-
5345

5446

5547
<a name="39.0.2"></a>

0 commit comments

Comments
 (0)