Package Exports
- ipfs-js
- ipfs-js/ipfs.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ipfs-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ipfs.js
Wrapper for node-ipfs-api
Browser friendly
Run npm install ipfs-js
Or reference dist/ipfs.min.js inside a <script /> to expose the global ipfs
Example
1) Set IPFS CORS access
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["*"]'
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]'
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials '["true"]'2) Start IPFS
ipfs daemon3) Upload example directory
git clone https://github.com/ConsenSys/ipfs.js && cd ipfs.js
For non-default ipfs configurations, you can run ./example.url to ipfs add -r example and print the local gateway's url
4) Open IPFS gateway
Navigate to the url echoed from ./example.url in the browser, or run ./example.url | xargs open to open it on OSX
Methods
ipfs.setProvider({host: 'localhost', port: '5001'})
- localhost and 5001 are the defaults when calling without arguments
- is also equivalent to
ipfs.setProvider({host: '/ip4/127.0.0.1/tcp/5001'})
ipfs.setProvider(require('ipfs-api')('localhost', '5001'))
node.js compatibility for ipfs.js
ipfs.add(textOrBuffer, callback)
ipfs.add("Testing...", function(err, hash) {
if (err) throw err; // If connection is closed
console.log(hash); // "Qmc7CrwGJvRyCYZZU64aPawPj7CJ56vyBxdhxa38Dh1aKt"
});ipfs.cat(hash, callback)
ipfs.cat("Qmc7CrwGJvRyCYZZU64aPawPj7CJ56vyBxdhxa38Dh1aKt", function(err, buffer) {
if (err) throw err;
console.log(buffer.toString()); // "Testing..."
});ipfs.catText(hash, callback)
ipfs.cat("Qmc7CrwGJvRyCYZZU64aPawPj7CJ56vyBxdhxa38Dh1aKt", function(err, text) {
if (err) throw err;
console.log(text); // "Testing..."
});