docs: review the readme #181
Merged
Conversation
This file contains hidden or 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
ghost
assigned
daviddias
commented
Jan 6, 2018
|
|
||
| - `options` - an optional object with the following properties | ||
| - `remote` bool - indicates if the factory should spawn local or remote nodes. By default, local nodes are spawned in Node.js and remote nodes are spawned in Browser environments. | ||
| - `port` number - the port number to use for the remote factory. It should match the port on which `DaemonFactory.server` was started. Defaults to 9999. | ||
| - type - the daemon type to create with this factory. See the section bellow for the supported types | ||
| - `type` - the daemon type to create with this factory. See the section bellow for the supported types | ||
| - `exec` - path to the desired IPFS executable to spawn, otherwise `ipfsd-ctl` will try to locate the correct one based on the `type`. In the case of `proc` type, exec is required and expects an IPFS coderef. |
There was a problem hiding this comment.
@dryajov seems that you never got to update the README based on the new reviewed API. I've updated it for you, please confirm that these options are correct.
daviddias
commented
Jan 6, 2018
README.md
Outdated
|
|
||
| > Delete the repo that was being used. If the node was marked as `disposable` this will be called automatically when the process is exited. | ||
|
|
||
| `callback` is a function with the signature `function (Error, Node)` where `err` is an Error in case something goes wrong and `Node` is a ???. |
There was a problem hiding this comment.
@dryajov what is this Node that is returned with init?
6 tasks
Codecov Report
@@ Coverage Diff @@
## feat/remote-daemon #181 +/- ##
======================================================
- Coverage 89.87% 89.81% -0.06%
======================================================
Files 11 11
Lines 553 550 -3
======================================================
- Hits 497 494 -3
Misses 56 56
Continue to review full report at Codecov.
|
dryajov
reviewed
Jan 8, 2018
README.md
Outdated
|
|
||
| > Delete the repo that was being used. If the node was marked as `disposable` this will be called automatically when the process is exited. | ||
|
|
||
| `callback` is a function with the signature `function (Error, Node)` where `err` is an Error in case something goes wrong and `Node` is a ???. |
There was a problem hiding this comment.
It returns an ipfsd controller (ipfsd). I'll update this branch with the change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.