Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create cljs-ipfs-api library #2

Open
madvas opened this issue Feb 21, 2018 · 0 comments
Open

Create cljs-ipfs-api library #2

madvas opened this issue Feb 21, 2018 · 0 comments
Assignees

Comments

@madvas
Copy link
Contributor

madvas commented Feb 21, 2018

Create wrapper library for easier working with js-ipfs-api, similar to cljs-web3.
Let's call it cljs-ipfs-api.

This lib should mainly do:

  • Split library into namespaces: For example ipfs.files.add function, will be in the lib as cljs-ipfs.files/add
  • Do clj->js on arguments passed into a functions
  • Do js->clj on objects returned from functions callbacks. Same as cljs-web3 does it.

In order to this lib to work, you'll likely need to create cljsjs/js-ipfs library. Alternative option would be to try to use new :npm-deps. It would be better, because of dead code elimination, but not sure if it's gonna work. You can give it a try.

Library should be usable in both, nodejs and browser.

As for documentation, you don't need to document every single function, since it's just a wrapper, just write something similar to cljs-web3 readme.

As for tests, no need to test every single function, just a few random, so we know cljs<->js conversions work.

@madvas madvas changed the title Create cljs-ipfs library Create cljs-ipfs-api library Feb 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants