npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@plaindb/leveldb

v0.0.1

Published

A wrapper around LevelDB for both server-side and client-side JS

Downloads

4

Readme

LevelDB

npm pipeline license downloads

Gitlab Github Twitter Discord

Provides a convenient wrapper around LevelDB for both server-side and client-side JavaScript. Extending basic LevelDB functionality, integrating seamlessly with emitted events and enabling a more straightforward and modular approach for database operations.

Features

  • Singleton pattern for database instances
  • Easy-to-use asynchronous APIs
  • Stream support for read and write operations
  • Sub-levels for better data organization
  • Custom encoding/decoding options
  • Event emission and handling
  • Batch operations

Installation

Install the package with:

npm install @plaindb/leveldb

Usage

First, import the LevelDB library.

import LevelDB from '@plaindb/leveldb'

or

const LevelDB = require('@plaindb/leveldb')

Initialization

You can initialize a LevelDB instance as follows:

const db = new LevelDB({
  dbName: 'myDatabase',
  dbPrefix: 'prefix',
  reset: true,
  separator: '!',
  keyEncoding: 'utf8',
  valueEncoding: 'msgpack'
})

Constructor Options

When instantiating a LevelDB object, you can pass an options object as follows:

  • dbName: (string) The name of the LevelDB database. Default is '.db'.
  • dbPrefix: (string) A prefix to be used before the dbName. Default is '' (empty string).
  • client: (object) Custom Level client. If not provided, a new Level client will be created.
  • reset: (boolean) If true, clears the database on instantiation. Default is false.
  • separator: (string) The separator used for key names. Default is '!'.
  • keyEncoding: (string | object) Encoding for keys. Default is 'utf8'.
  • valueEncoding: (string | object) Encoding for values. Default is 'msgpack'.

Putting Data

To insert data into the LevelDB database:

await db.put('key', 'value')

Getting Data

To retrieve data from the database:

const value = await db.get('key')

Deleting Data

To delete data:

await db.del('key')

Stream Operations

For large datasets, you can use streaming:

const readStream = db.createReadStream()
readStream.on('data', data => {
  console.log(data)
})

Sub-levels

You can create sub-levels for better data organization:

const subDB = db.sub('subPath')

Batch Operations

For performing multiple operations atomically:

await db.batch([
  { type: 'put', key: 'key1', value: 'value1' },
  { type: 'del', key: 'key2' }
])

Event Handling

You can also attach event listeners:

db.on('put', (key, value) => {
  // Do something
})

Documentation

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://gitlab.com/frenware/framework/plaindb/leveldb.git
cd basd
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@plaindb/leveldb is MIT licensed.