|
| 1 | +<a name="27.0.0"></a> |
| 2 | +# [27.0.0](https://github.com/ipfs/js-ipfs-http-client/compare/v26.1.2...v27.0.0) (2018-11-28) |
| 3 | + |
| 4 | + |
| 5 | +### Bug Fixes |
| 6 | + |
| 7 | +* also retry with misnemed format "dag-cbor" as "cbor" ([#888](https://github.com/ipfs/js-ipfs-http-client/issues/888)) ([348a144](https://github.com/ipfs/js-ipfs-http-client/commit/348a144)) |
| 8 | +* better input validation for add ([#876](https://github.com/ipfs/js-ipfs-http-client/issues/876)) ([315b7f7](https://github.com/ipfs/js-ipfs-http-client/commit/315b7f7)) |
| 9 | +* fix log.tail by calling add after listening for events ([#882](https://github.com/ipfs/js-ipfs-http-client/issues/882)) ([da35b0f](https://github.com/ipfs/js-ipfs-http-client/commit/da35b0f)) |
| 10 | +* handle peer-info validation errors ([#887](https://github.com/ipfs/js-ipfs-http-client/issues/887)) ([6e6d7a2](https://github.com/ipfs/js-ipfs-http-client/commit/6e6d7a2)), closes [#885](https://github.com/ipfs/js-ipfs-http-client/issues/885) |
| 11 | +* updates ipld-dag-pb dep to version without .cid properties ([#889](https://github.com/ipfs/js-ipfs-http-client/issues/889)) ([ac30a82](https://github.com/ipfs/js-ipfs-http-client/commit/ac30a82)) |
| 12 | + |
| 13 | + |
| 14 | +### Code Refactoring |
| 15 | + |
| 16 | +* object API write methods now return CIDs ([#896](https://github.com/ipfs/js-ipfs-http-client/issues/896)) ([38bed14](https://github.com/ipfs/js-ipfs-http-client/commit/38bed14)) |
| 17 | +* rename library to ipfs-http-client ([#897](https://github.com/ipfs/js-ipfs-http-client/issues/897)) ([d40cb6c](https://github.com/ipfs/js-ipfs-http-client/commit/d40cb6c)) |
| 18 | +* updated files API ([#878](https://github.com/ipfs/js-ipfs-http-client/issues/878)) ([39f4733](https://github.com/ipfs/js-ipfs-http-client/commit/39f4733)) |
| 19 | + |
| 20 | + |
| 21 | +### BREAKING CHANGES |
| 22 | + |
| 23 | +* the `ipfs-api` library has been renamed to `ipfs-http-client`. |
| 24 | + |
| 25 | +Now install via `npm install ipfs-http-client`. |
| 26 | + |
| 27 | +Note that in the browser build the object attached to `window` is now `window.IpfsHttpClient`. |
| 28 | + |
| 29 | +License: MIT |
| 30 | +Signed-off-by: Alan Shaw <alan.shaw@protocol.ai> |
| 31 | +* Object API refactor. |
| 32 | + |
| 33 | +Object API methods that write DAG nodes now return a CID instead of a DAG node. Affected methods: |
| 34 | + |
| 35 | +* `ipfs.object.new` |
| 36 | +* `ipfs.object.patch.addLink` |
| 37 | +* `ipfs.object.patch.appendData` |
| 38 | +* `ipfs.object.patch.rmLink` |
| 39 | +* `ipfs.object.patch.setData` |
| 40 | +* `ipfs.object.put` |
| 41 | + |
| 42 | +Example: |
| 43 | + |
| 44 | +```js |
| 45 | +// Before |
| 46 | +const dagNode = await ipfs.object.new() |
| 47 | +``` |
| 48 | + |
| 49 | +```js |
| 50 | +// After |
| 51 | +const cid = await ipfs.object.new() // now returns a CID |
| 52 | +const dagNode = await ipfs.object.get(cid) // fetch the DAG node that was created |
| 53 | +``` |
| 54 | + |
| 55 | +IMPORTANT: `DAGNode` instances, which are part of the IPLD dag-pb format have been refactored. |
| 56 | + |
| 57 | +These instances no longer have `multihash`, `cid` or `serialized` properties. |
| 58 | + |
| 59 | +This effects the following API methods that return these types of objects: |
| 60 | + |
| 61 | +* `ipfs.object.get` |
| 62 | +* `ipfs.dag.get` |
| 63 | + |
| 64 | +See https://github.com/ipld/js-ipld-dag-pb/pull/99 for more information. |
| 65 | + |
| 66 | +License: MIT |
| 67 | +Signed-off-by: Alan Shaw <alan.shaw@protocol.ai> |
| 68 | +* Files API methods `add*`, `cat*`, `get*` have moved from `files` to the root namespace. |
| 69 | + |
| 70 | +Specifically, the following changes have been made: |
| 71 | + |
| 72 | +* `ipfs.files.add` => `ipfs.add` |
| 73 | +* `ipfs.files.addPullStream` => `ipfs.addPullStream` |
| 74 | +* `ipfs.files.addReadableStream` => `ipfs.addReadableStream` |
| 75 | +* `ipfs.files.cat` => `ipfs.cat` |
| 76 | +* `ipfs.files.catPullStream` => `ipfs.catPullStream` |
| 77 | +* `ipfs.files.catReadableStream` => `ipfs.catReadableStream` |
| 78 | +* `ipfs.files.get` => `ipfs.get` |
| 79 | +* `ipfs.files.getPullStream` => `ipfs.getPullStream` |
| 80 | +* `ipfs.files.getReadableStream` => `ipfs.getReadableStream` |
| 81 | + |
| 82 | +Additionally, `addFromFs`, `addFromUrl`, `addFromStream` have moved from `util` to the root namespace: |
| 83 | + |
| 84 | +* `ipfs.util.addFromFs` => `ipfs.addFromFs` |
| 85 | +* `ipfs.util.addFromUrl` => `ipfs.addFromUrl` |
| 86 | +* `ipfs.util.addFromStream` => `ipfs.addFromStream` |
| 87 | + |
| 88 | +License: MIT |
| 89 | +Signed-off-by: Alan Shaw <alan.shaw@protocol.ai> |
| 90 | + |
| 91 | + |
| 92 | + |
1 | 93 | <a name="26.1.2"></a>
|
2 | 94 | ## [26.1.2](https://github.com/ipfs/js-ipfs-http-client/compare/v26.1.0...v26.1.2) (2018-11-03)
|
3 | 95 |
|
|
0 commit comments