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/memorydb

v0.0.2

Published

An in-memory database that's designed for high-performance data storage and retrieval.

Downloads

39

Readme

MemoryDB

npm pipeline license downloads

Gitlab Github Twitter Discord

An in-memory database that's designed for high-performance data storage and retrieval. Support for sorted data structures and batch operations that enable sorted and efficient data handling operations. You can perform CRUD operations, iterate through sorted data, and much more.

Features

  • In-memory sorted data storage
  • Event Emitters
  • Built-in batch operations
  • Supports key and value encoding
  • Event-driven architecture
  • Streaming support

Installation

Install the package with:

npm install @plaindb/memorydb

Usage

Import the Package

import MemoryDB from '@plaindb/memorydb'

or

const MemoryDB = require('@plaindb/memorydb')

Create a New MemoryDB Instance

const db = new MemoryDB()

Insert a Key-Value Pair

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

Retrieve a Value by Key

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

Delete a Key

await db.del('key')

Batch Operations

const batch = db.batch()
batch.put('key1', 'value1')
batch.put('key2', 'value2')
batch.del('key3')
await batch.build()

Sub Databases

You can also create sub-databases.

const subDb = db.sub('subDbPath')

Example

const db = new MemoryDB()
// put, get and del operations will wait for the instance to be ready but you can call it explicitly
await db.isReady()

// put key-value pair
await db.put('key1', 'value1')

// get value by key
console.log(await db.get('key1'))  // Output: value1

// delete key
await db.del('key1')

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

Documentation

Class MemoryDB

async put(key, value)

Inserts a new key-value pair or updates the value if the key already exists.

async get(key)

Retrieves the value for the given key. Returns null if the key does not exist.

async del(key)

Deletes a key and its corresponding value from the database.

sub(path, opts)

Returns a subtree.

iterator(opts)

Iterates through all the key-value pairs.

listAll(opts)

Prints all key-value pairs.

batch(ops)

Batch execute multiple operations.

isReady()

Returns a promise that resolves when the database is ready.

collect(type, opts)

Collects keys or values based on the given options.

Tests

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

git clone https://gitlab.com/frenware/framework/plaindb/memorydb.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/memorydb is MIT licensed.