A bare bones JSON database.
I wanted a simple way to store my Electron app's data. The obvious solution was just to use the FS module to write JSON to disk. So that's what Catacomb does. Only, it includes some slightly more "databasey" methods in case you want to search your JSON instead of referencing a specific key-value pair.
Also, I found most other databases recommend for Electron projects:
If you find yourself asking, "Why does this even exist? It's barely worth a module!", well I did say it was "bare bones." Also, on a personal level, I wanted to try writing an open source module and publishing it on NPM, just for the thrill. So there's that.
You can install Catacomb NPM style and require() it (preferred), or use HTML script tags.
Nothing special here, install it like any other module:
npm install catacomb --save
After installing, simply require it in your code:
const Catacomb = require("catacomb");
In the near future, it will be possible to download compiled and minified versions to include in HTML <script> tags. After downloading and unzipping the release, move to to your project and in your HTML file, include it thusly:
<html>
<head>
...
<script src="js/catacomb.min.js"></script>
...
</head>
<body> ... </body>
</html>
Full documentation can be found on the Github Wiki.
Here's a little example of how straight forward it is to use Catacomb:
// Create a catacomb and specify some options:
let library = new Catacomb({
index: "id" // This is the key used as an index.
});
// Save to Electron's user data folder:
library.save( app.getPath("userData") + "/library.json");
// Stick a new record in. In this case, we provide the UUID because it's linked to something specific in our app. If it was not provided, Catacomb will generate a UUID itself, and return it.
library.insert({
id: "0399afa4-219f-45ea-aae0-6968d59a9028",
name: "Dooper"
});
// Out of curiosity, how many records does our library have?
console.log( library.getSize() );
// Persist our library to disk:
library.save();
FAQs
A bare bones database. (Haha, get it?)
The npm package catacomb receives a total of 0 weekly downloads. As such, catacomb popularity was classified as not popular.
We found that catacomb demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Four npm packages disguised as cryptographic tools steal developer credentials and send them to attacker-controlled Telegram infrastructure.
Security News
Ruby maintainers from Bundler and rbenv teams are building rv to bring Python uv's speed and unified tooling approach to Ruby development.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.