Universal abstract-level database for Node.js and browsers. This is a convenience package that exports classic-level in Node.js and browser-level in browsers, making it an ideal entry point to start creating lexicographically sorted key-value databases.
:pushpin: Which module should I use? What is abstract-level? Head over to the FAQ.
const { Level } = require('level')// Create a databaseconst db = new Level('example', { valueEncoding: 'json' })// Add an entry with key 'a' and value 1await db.put('a', 1)// Add multiple entriesawait db.batch([{ type: 'put', key: 'b', value: 2 }])// Get value of key 'a': 1const value = await db.get('a')// Iterate entries with keys that are greater than 'a'for await (const [key, value]
TypeScript type declarations are included and cover the methods that are common between classic-level and browser-level. Usage from TypeScript requires generic type parameters.
TypeScript example
// Specify types of keys and values (any, in the case of json).// The generic type parameters default to Level<string, string>.const db = new Level<string, any>('./db', { valueEncoding: 'json' })// All relevant methods then use those typesawait db.put('a', { x: 123 })// Specify different types when overriding encoding per operationawait db.get<string, string>('a', { valueEncoding: 'utf8' })// Though in some cases TypeScript can infer themawait db.get('a', { valueEncoding: db.valueEncoding('utf8') })// It works the same for sublevels
At the time of writing, level works in Node.js 18+ and Electron 30+ on Linux, Mac OS and Windows, including any future Node.js and Electron release thanks to Node-API, including ARM platforms like Raspberry Pi and Android, as well as in Chromium, Firefox and Safari. For details, see Supported Platforms of classic-level and Browser Support of browser-level.
Binary keys and values are supported across the board.
API
The API of level follows that of abstract-level. For additional options and methods specific to classic-level or browser-level, please see their respective READMEs. The documentation below only covers the common constructor.
db = new Level(location[, options])
Create a new database or open an existing database. The location argument must be a directory path (relative or absolute) where LevelDB will store its files, or in browsers, the name of the IDBDatabase to be opened.
Contributing
Level/level is an OPEN Open Source Project. This means that:
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.