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

feat: add isInitialized method #219

Merged
merged 2 commits into from
Feb 10, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,10 @@ Get a value at the root of the repo.

[Blocks](https://github.com/ipfs/js-ipfs-block#readme):

#### `Promise<Boolean> repo.isInitialized ()`

The returned promise resolves to `false` if the repo has not been initialized and `true` if it has.

#### `Promise repo.blocks.put (block:Block)`

* `block` should be of type [Block](https://github.com/ipfs/js-ipfs-block#readme).
Expand Down
16 changes: 16 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@ class IpfsRepo {
await this.version.set(constants.repoVersion)
}

/**
* Check if the repo is already initialized.
* @returns {Promise<Boolean>}
*/
async isInitialized () {
try {
await this._openRoot()
await this._checkInitialized()
// necessary? await this.root.close()
Copy link
Member

Choose a reason for hiding this comment

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

Is there a way to detect initialization without opening the root store?

Copy link
Member Author

Choose a reason for hiding this comment

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

Only in node, in the browser you have to open the store first.


return true
} catch (err) {
return false
}
}

/**
* Open the repo. If the repo is already open an error will be thrown.
* If the repo is not initialized it will throw an error.
Expand Down
1 change: 1 addition & 0 deletions test/browser.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ describe('IPFS Repo Tests on the Browser', () => {
require('./config-test')(repo)
require('./api-addr-test')(repo)
require('./lock-test')(repo)
require('./is-initialized')
})
28 changes: 28 additions & 0 deletions test/is-initialized.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* eslint max-nested-callbacks: ["error", 8] */
/* eslint-env mocha */
'use strict'

const chai = require('chai')
chai.use(require('dirty-chai'))
const expect = chai.expect
const os = require('os')
const path = require('path')
const IPFSRepo = require('../src')

describe('isInitialized', () => {
let repo

beforeEach(() => {
const repoPath = path.join(os.tmpdir(), 'test-repo-for-' + Math.random())
repo = new IPFSRepo(repoPath)
})

it('should be false before initialization', async () => {
expect(await repo.isInitialized()).to.be.false()
})

it('should be true after initialization', async () => {
await repo.init({})
expect(await repo.isInitialized()).to.be.true()
})
})
1 change: 1 addition & 0 deletions test/node.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ describe('IPFS Repo Tests onNode.js', () => {
if (!r.init) {
require('./interop-test')(repo)
}
require('./is-initialized')
}))

require('./blockstore-utils-test')()
Expand Down