Skip to content
This repository was archived by the owner on Dec 2, 2024. It is now read-only.

Document constructor #119

Merged
ralphtheninja merged 4 commits into from
May 27, 2018
Merged

Document constructor #119

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
120b0df
Document constructor
May 27, 2018
405b4ca
tweak location docs
May 27, 2018
8123589
update options.prefix docs
May 27, 2018
c1437d3
update location docs once more
May 27, 2018
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,20 @@ Not to be confused with [leveljs](https://www.npmjs.com/package/leveljs).

This library is best used with [browserify](http://browserify.org).

## API

### `db = leveljs(location[, options])`
Returns a new `leveljs` instance. `location` is the string name of the [`IDBDatabase`](https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase) to be opened, as well as the object store within that database. The database name will be prefixed with `options.prefix`.

#### `options`

The optional `options` argument may contain:

* `prefix` *(string, default: `'level-js-'`)*: Prefix for `IDBDatabase` name.
* `version` *(string | number, default: `1`)*: The version to open the database with.

See [`IDBFactory#open`](https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory/open) for more details.

## Running Tests

```sh
Expand Down