rocket-store

library0.0.11jsnpmunverified

Rocket-Store is a lightweight, high-performance flat-file database solution for Node.js, currently at version `0.10.20`. It distinguishes itself by directly leveraging the host operating system's file system caching mechanisms for exceptionally fast data storage and retrieval. Designed for scenarios requiring minimal footprint and high throughput, it stores data in JSON format within collections and records, accessible via unique keys. The package requires no complex configuration or setup, defaulting to the OS temporary directory for data storage, and supports both CommonJS and ES Modules. While specific release cadence isn't explicitly defined, frequent updates indicate active maintenance. Its key differentiators include simplicity, asynchronous mutation safety, and a single-file core with few external dependencies, making it an efficient alternative to more complex database systems for specific use cases.

database serialization

npm install rocket-store

github ↗package ↗

INSTALL

IMPORT

SIG · ROCKET-STORE

rocket-store

databasejavascriptv0.0.11

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

✓ const rs = require('rocket-store').default;

✗ const rs = require('rocket-store');

For CommonJS, the Rocket-Store instance is accessed via the `.default` property of the module export.

Rocketstore

✓ import * as store from 'rocket-store'; const rs = await store.Rocketstore();

✗ import { Rocketstore } from 'rocket-store'; const rs = await Rocketstore();

In ES Modules, the `Rocketstore` factory function is a named export on the namespace object and must be awaited to get the instance.

default

✓ import defaultStore from 'rocket-store'; const rs = await defaultStore();

✗ import rs from 'rocket-store';

Alternatively in ES Modules, the default export is also a factory function that returns a Promise and must be awaited to get the instance.

RocketStoreInstance

✓ import type { RocketStoreInstance, RocketStoreOptions, RocketStoreResult } from 'rocket-store';

The package ships TypeScript types for the core instance, configuration options, and method results.

Demonstrates basic setup, configuring the storage area, and performing CRUD operations (post, get, delete) with specific keys and wildcard searches.

import * as rsModule from 'rocket-store'; import type { RocketStoreInstance } from 'rocket-store'; import { join } from 'path'; import { tmpdir } from 'os'; const main = async () => { const rs: RocketStoreInstance = await rsModule.Rocketstore(); // Set a custom storage directory (optional, defaults to OS temp dir) await rs.setOption({ data_storage_area: join(tmpdir(), 'my-rocket-data') }); // 1. Post a record const postResult = await rs.post("cars", "Mercedes-C200", { owner: "Lisa Simpson", reg: "N3RD" }); console.log('Posted Mercedes:', postResult); // 2. Post another record with an auto-incremented key const postResult2 = await rs.post("cars", null, { owner: "Homer Simpson", reg: "DUFF" }, rs._ADD_AUTO_INC); console.log('Posted Homer (auto-inc key):', postResult2); // 3. Get all records from the 'cars' collection, ordered descending const allCars = await rs.get("cars", "*", rs._ORDER_DESC); console.log('All cars (descending):', allCars); // 4. Get a specific record by key const mercedes = await rs.get("cars", "Mercedes-C200"); console.log('Mercedes record:', mercedes); // 5. Delete records matching a wildcard pattern (e.g., all with 'Cede' in key) const deleteResult = await rs.delete("cars", "*cede*"); console.log('Deleted records matching *cede*:', deleteResult); // 6. Get remaining records const remainingCars = await rs.get("cars", "*"); console.log('Remaining cars:', remainingCars); }; main().catch(console.error);

Debug

Known issues

gotchaCollection names and keys in Rocket-Store do not support path separators, wildcards, or other illegal characters. Such characters are silently stripped, which can lead to unexpected behavior, data not being found, or silent data corruption.

fix

Ensure collection and key names adhere to basic file naming conventions, avoiding special characters like `/`, `\`, `*`, `?`, or other OS-specific forbidden characters. Implement client-side validation for user-provided keys to prevent silent stripping.

affects: >=0.1.0

gotchaWhen using Rocket-Store in an ES Module environment, the instance creation function (`store.Rocketstore()` or `store.default()`) returns a Promise and *must* be awaited. Failing to `await` will result in an uninitialized object and subsequent method calls failing with 'is not a function' errors.

fix

Always use `const rs = await store.Rocketstore();` or `const rs = await store.default();` for ESM imports and initialization.

affects: >=0.10.0

gotchaWhen importing Rocket-Store in a CommonJS environment, the main instance is exposed via the `.default` property of the module export. Direct `require('rocket-store')` will return the module object, not the callable instance, leading to errors when attempting to use methods like `rs.post`.

fix

Use `const rs = require('rocket-store').default;` to correctly import the Rocket-Store instance in CommonJS.

affects: >=0.1.0

Errors

Common errors & fixes

TypeError: rs.post is not a function

The Rocket-Store instance was not correctly initialized or obtained. This usually happens in ESM if `await` was omitted during instance creation, or in CJS if `.default` was not accessed on the `require()` result.

fix

For ES Modules: ensure `const rs = await store.Rocketstore();`. For CommonJS: ensure `const rs = require('rocket-store').default;`.

[] (or unexpected empty result) when fetching data that should exist.

The key or collection name used for storing or retrieving data contained illegal characters which were silently stripped by Rocket-Store, resulting in a mismatch between the expected and actual stored key/collection name.

fix

Verify that collection names and keys do not contain any path separators, wildcards, or other special characters that could be silently removed. Inspect the `key` property in the `post` method's return value to confirm the actual key used for storage.

Upgrade

Version history

0.0.11latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

16 hits · last 30 days

node

Resources

githubhttps://github.com/paragi/rocket-store-node ↗

packagehttps://www.npmjs.com/package/rocket-store ↗