This repository has been archived by the owner on Mar 10, 2020. It is now read-only.
refactor: async iterables #1174
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
BREAKING CHANGE: The `log.tail` method now returns an async iterator that yields log messages. Use it like:
```js
for await (const message of ipfs.log.tail()) {
console.log(message)
}
```
Secondly, 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`.
License: MIT
Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
Depends on: * [ ] ipfs-inactive/interface-js-ipfs-core#561 License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
BREAKING CHANGE: Dropped support for go-ipfs <= 0.4.4 in swarm.peers response License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
BREAKING CHANGE: 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. License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
BREAKING CHANGE: 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()`. License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
Other endpoints are not supported by go-ipfs or js-ipfs and so have been removed. License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
resolves #1103 BREAKING CHANGE: 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: * String, formatted as one of: * Multiaddr e.g. /ip4/127.0.0.1/tcp/5001 * URL e.g. http://127.0.0.1:5001 * [Multiaddr](https://www.npmjs.com/package/multiaddr) instance * Object, in format of either: * 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) * Node.js style address e.g. `{ host: '127.0.0.1', port: 5001, protocol: 'http' }` License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
|
History cleaned up in #1183 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TLDR;
peer-infoandpeer-idNow that internals are all async/await/iterables and
fetchthe next step is to bubble up that goodness to the core API, removing the multiple stream APIs and removing callback support.I'm also proposing removing
peer-infoandpeer-id, since these drastically increase the bundle size by pulling inlibp2p-crypto, for which 99% of it's capability is unused. In place ofpeer-idwe return aCID, which can easily be converted to aPeerIdinstance via:In place of
peer-infowe return an object{ id: CID, addrs: Multiaddr[] }, which can easily be converted to aPeerInfolike:refs ipfs/js-ipfs#1670
TODO:
interface-ipfs-coretestsinterface-ipfs-core