Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

doc: You can't ipfs.add a path #245

Merged
merged 2 commits into from
Mar 26, 2018
Merged

Conversation

olizilla
Copy link
Contributor

The tests in js-ipfs-api explicitly assert that passing a file path string to ipfs.add should fail.

https://github.com/ipfs/interface-ipfs-core/blob/b862a12bc655954143b995887983f96201abcf31/js/src/files.js#L144-L151

This PR removes "a Path" from the list of possible parameter types to ipfs.add

Fixes ipfs-inactive/js-ipfs-http-client#722

@ghost ghost assigned olizilla Mar 23, 2018
@ghost ghost added the in progress label Mar 23, 2018
@olizilla olizilla changed the title You can't ipfs.add a path doc: You can't ipfs.add a path Mar 23, 2018
@vmx vmx requested a review from daviddias March 26, 2018 12:55
SPEC/FILES.md Outdated
@@ -16,7 +16,6 @@ Where `data` may be:
- a [`Buffer instance`][b]
- a [`Readable Stream`][rs]
- a [`Pull Stream`][ps]
- a Path (caveat: will only work in Node.js)
- a URL
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the URL as well given that neither are supported at the moment.

@olizilla
Copy link
Contributor Author

@diasdavid done!

@daviddias daviddias merged commit 4536160 into master Mar 26, 2018
@daviddias daviddias deleted the fix/remove-path-from-ipfs-add branch March 26, 2018 17:36
@ghost ghost removed the in progress label Mar 26, 2018
anthony-mills added a commit to anthony-mills/interface-ipfs-core that referenced this pull request May 20, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants