v42.0.0-pre.0
Pre-releaseBREAKING CHANGE: Callbacks are no longer supported on any API methods. Please use a utility such as callbackify
on API methods that return Promises to emulate previous behaviour.
BREAKING CHANGE: PeerId
and PeerInfo
classes are no longer statically exported from ipfs-http-client
since they are no longer used internally.
BREAKING CHANGE: pin.add
results now contain a cid
property (a CID instance) instead of a string hash
property.
BREAKING CHANGE: pin.ls
now returns an async iterable.
BREAKING CHANGE: pin.ls
results now contain a cid
property (a CID instance) instead of a string hash
property.
BREAKING CHANGE: pin.rm
results now contain a cid
property (a CID instance) instead of a string hash
property.
BREAKING CHANGE: add
now returns an async iterable.
BREAKING CHANGE: add
results now contain a cid
property (a CID instance) instead of a string hash
property.
BREAKING CHANGE: addReadableStream
, addPullStream
have been removed.
BREAKING CHANGE: ls
now returns an async iterable.
BREAKING CHANGE: ls
results now contain a cid
property (whose value is a CID instance) instead of a hash
property.
BREAKING CHANGE: files.ls
now returns an async iterable.
BREAKING CHANGE: files.readPullStream
and files.readReadableStream
have been removed.
BREAKING CHANGE: files.read
now returns an async iterable.
BREAKING CHANGE: files.lsPullStream
and files.lsReadableStream
have been removed.
BREAKING CHANGE: files.ls
now returns an async iterable.
BREAKING CHANGE: files.ls
results now contain a cid
property (whose value is a CID instance) instead of a hash
property.
BREAKING CHANGE: files.ls
no longer takes a long
option (in core) - you will receive all data by default.
BREAKING CHANGE: files.stat
result now contains a cid
property (whose value is a CID instance) instead of a hash
property.
BREAKING CHANGE: get
now returns an async iterable. The content
property value for objects yielded from the iterator is now an async iterable that yields BufferList
objects.
BREAKING CHANGE: stats.bw
now returns an async iterable.
BREAKING CHANGE: addFromStream
has been removed. Use add
instead.
BREAKING CHANGE: isIPFS
is no longer exported from the client, please npm i is-ipfs
or include the CDN script tag <script src="https://unpkg.com/is-ipfs/dist/index.min.js"></script>
to use this utility in your applications.
BREAKING CHANGE: addFromFs
has been removed. Please use the exported globSource
utility and pass the result to add
. See the glob source documentation for more details and an example.
BREAKING CHANGE: addFromURL
has been removed. Please use the exported urlSource
utility and pass the result to add
. See the URL source documentation for more details and an example.
BREAKING CHANGE: name.resolve
now returns an async iterable. It yields increasingly more accurate resolved values as they are discovered until the best value is selected from the quorum of 16. The "best" resolved value is the last item yielded from the iterator. If you are interested only in this best value you could use it-last
to extract it like so:
const last = require('it-last')
await last(ipfs.name.resolve('/ipns/QmHash'))
BREAKING CHANGE: block.rm
now returns an async iterable.
BREAKING CHANGE: block.rm
now yields objects of { cid: CID, error: Error }
.
BREAKING CHANGE: dht.findProvs
, dht.provide
, dht.put
and dht.query
now all return an async iterable.
BREAKING CHANGE: dht.findPeer
, dht.findProvs
, dht.provide
, dht.put
and dht.query
now yield/return an object { id: CID, addrs: Multiaddr[] }
instead of a PeerInfo
instance(s).
BREAKING CHANGE: refs
and refs.local
now return an async iterable.
BREAKING CHANGE: object.data
now returns an async iterable that yields Buffer
objects.
BREAKING CHANGE: ping
now returns an async iterable.
BREAKING CHANGE: repo.gc
now returns an async iterable.
BREAKING CHANGE: swarm.peers
now returns an array of objects with a peer
property that is a CID
, instead of a PeerId
instance.
BREAKING CHANGE: swarm.addrs
now returns an array of objects { id: CID, addrs: Multiaddr[] }
instead of PeerInfo
instances.
BREAKING CHANGE: block.stat
result now contains a cid
property (whose value is a CID instance) instead of a key
property.
BREAKING CHANGE: bitswap.wantlist
now returns an array of CID instances.
BREAKING CHANGE: bitswap.stat
result has changed - wantlist
and peers
values are now an array of CID instances.