|
| 1 | +<a name="40.0.0"></a> |
| 2 | +# [40.0.0](https://github.com/ipfs/js-ipfs-http-client/compare/v39.0.2...v40.0.0) (2019-11-22) |
| 3 | + |
| 4 | + |
| 5 | +### Code Refactoring |
| 6 | + |
| 7 | +* async await roundup ([#1173](https://github.com/ipfs/js-ipfs-http-client/issues/1173)) ([3e5967a](https://github.com/ipfs/js-ipfs-http-client/commit/3e5967a)), closes [#1103](https://github.com/ipfs/js-ipfs-http-client/issues/1103) |
| 8 | +* convert config API to async await ([#1155](https://github.com/ipfs/js-ipfs-http-client/issues/1155)) ([621973c](https://github.com/ipfs/js-ipfs-http-client/commit/621973c)) |
| 9 | +* move files to root level ([#1150](https://github.com/ipfs/js-ipfs-http-client/issues/1150)) ([559a97d](https://github.com/ipfs/js-ipfs-http-client/commit/559a97d)) |
| 10 | + |
| 11 | + |
| 12 | +### Features |
| 13 | + |
| 14 | +* support name.resolve of peerid as cid ([#1145](https://github.com/ipfs/js-ipfs-http-client/issues/1145)) ([2d9afc8](https://github.com/ipfs/js-ipfs-http-client/commit/2d9afc8)) |
| 15 | + |
| 16 | + |
| 17 | +### Reverts |
| 18 | + |
| 19 | +* chore: update multiaddr to version 7.2.0 ([#1136](https://github.com/ipfs/js-ipfs-http-client/issues/1136)) ([#1143](https://github.com/ipfs/js-ipfs-http-client/issues/1143)) ([4131d09](https://github.com/ipfs/js-ipfs-http-client/commit/4131d09)) |
| 20 | + |
| 21 | + |
| 22 | +### BREAKING CHANGES |
| 23 | + |
| 24 | +* 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 | +``` |
| 31 | +* 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`. |
| 32 | +* Dropped support for go-ipfs <= 0.4.4 in `swarm.peers` response. |
| 33 | +* 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. |
| 34 | +* 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()`. |
| 35 | +* 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' }` |
| 44 | +* 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]> |
| 48 | +* 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. |
| 49 | + |
| 50 | +License: MIT |
| 51 | +Signed-off-by: Alan Shaw < [email protected]> |
| 52 | + |
| 53 | + |
| 54 | + |
1 | 55 | <a name="39.0.2"></a>
|
2 | 56 | ## [39.0.2](https://github.com/ipfs/js-ipfs-http-client/compare/v39.0.1...v39.0.2) (2019-10-23)
|
3 | 57 |
|
|
0 commit comments