Installable via npm install --save ipfs, it can also be used directly in the browser.

Download

The source is available for download from GitHub. Alternatively, you can install using npm:

$ npm install --save ipfs

You can then require() ipfs as normal:

const ipfs = require('ipfs')

In the Browser

Ipfs should work in any ES2015 environment out of the box.

Usage:

<script type="text/javascript" src="index.js"></script>

The portable versions of ipfs, including index.js and index.min.js, are included in the /dist folder. Ipfs can also be found on unkpkg.com under

• https://unpkg.com/ipfs/dist/index.min.js
• https://unpkg.com/ipfs/dist/index.js

Given a key, query the DHT for its best value.

Parameters

key: Buffer:  
callback: function (Error)?:  

Returns

Write a key/value pair to the DHT.

Given a key of the form /foo/bar and a value of any form, this will write that value to the DHT with that key.

Parameters

key: Buffer:  
value: Buffer:  
callback: function (Error)?:  

Returns

Find peers in the DHT that can provide a specific value, given a key.

Parameters

key: CID:  
They key to find providers for.
callback: function (Error, Array<PeerInfo>)?:  

Returns

Query the DHT for all multiaddresses associated with a PeerId.

Parameters

peer: PeerId:  
The id of the peer to search for.
callback: function (Error, Array<Multiaddr>)?:  

Returns

Announce to the network that we are providing given values.

Parameters

keys: (CID | Array<CID>):  
The keys that should be announced.
options: Object (={}):  
options.recursive: bool (=false):  
Provide not only the given object but also all objects linked from it.
callback: function (Error)?:  

Returns

Find the closest peers to a given PeerId, by querying the DHT.

Parameters

peer: PeerId:  
The PeerId to run the query agains.
callback: function (Error, Array<PeerId>)?:  

Returns