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

Quick Example

'use strict'

const Repo = require('ipfs-repo')
const repo = new Repo('/Users/awesome/.jsipfs')

repo.init({my: 'config'}, (err) => {
  if (err) {
    throw err
  }

  repo.open((err) => {
    if (err) {
      throw err
    }

    console.log('repo is ready')
  })
})

There are more available, so take a look at the docs below for a full list. This documentation aims to be comprehensive, so if you feel anything is missing please create a GitHub issue for it.

Download

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

$ npm install --save ipfs-repo

You can then require() ipfs-repo as normal:

const ipfsRepo = require('ipfs-repo')

In the Browser

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

Usage:

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

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

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

Get the current configuration from the repo.

Parameters

callback: function (Error, Object):  

Returns

Get a single block by CID.

Parameters

cid: CID:  
callback: function (Error, Block):  

Returns

Get the current version.

Parameters

callback: function (Error, number):  

Returns

Set the current configuration for this repo.

Parameters

value: Object:  
the api address to be written
callback: function (Error):  

Returns

Set the version of the repo, writing it to the underlying store.

Parameters

version: number:  
callback: function (Error):  

Returns

Deletes api file

Parameters

callback: function (Error, bool):  

Returns

Delete a block from the store

Parameters

cid: CID:  
callback: function (Error):  

Returns

Transform a raw buffer to a base32 encoded key.

Parameters

rawKey: Buffer:  

Returns

Transform a cid to the appropriate datastore key.

Parameters

cid: CID:  

Returns

Query the store.

Parameters

query: object:  
callback: function (Error, Array):  

Returns

Like put, but for more.

Parameters

blocks: Array<Block>:  
callback: function (Error):  

Returns

Does the store contain block with this cid?

Parameters

cid: CID:  
callback: function (Error, bool):  

Returns

Get the current configuration from the repo.

Parameters

key: String:  
the config key to get
callback: function (Error, Object):  

Returns

Set the current configuration for this repo.

Parameters

key: String:  
the config key to be written
value: Object:  
the config value to be written
callback: function (Error):  

Returns

Check if a config file exists.

Parameters

callback: function (Error, bool):  

Returns

IpfsRepo implements all required functionality to read and write to an ipfs repo.

Parameters

repoPath: any:  
options: any:  

instance

init(config: Object, callback: function (Error)): void

open(callback: function (Error)): void

close(callback: function (Error)): void

exists(callback: function (Error, bool)): void

stat(options: Object, callback: function (Error, Object)): void

Lock the repo in the given dir.

Parameters

dir: string:  
callback: function (Error, lock):  

Returns

Check if the repo in the given directory is locked.

Parameters

dir: string:  
callback: function (Error, bool):  

Returns

Check if a version file exists.

Parameters

callback: function (Error, bool):  

Returns

Check the current version, and return an error on missmatch

Parameters

expected: number:  
callback: function (Error):  

Returns