1.0.3 • Published 10 months ago

wizef-db v1.0.3

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
10 months ago

A lightweight, JSON-based database package for easy data management in JavaScript applications.

Wizef-DB: The simple JSON-based solution for your data storage needs!


🚀 What is Wizef-DB?

Wizef-DB is a minimal, easy-to-use, JSON-based database solution for JavaScript and Node.js applications. It provides lightweight data storage that saves and retrieves data in the form of key-value pairs using objects, offering both flexibility and simplicity without the overhead of complex databases.


📦 Installation

To use Wizef-DB in your project, you can install it via npm:

npm install wizef-db

Or if you prefer yarn:

yarn add wizef-db

🛠️ How to Use

Here's an example of how to use Wizef-DB to manage your data efficiently:

const db = require('wizef-db');

// Set a key-value pair

db.set('key', 'value'); // Store data in the database.

// Get a value by key

db.fetch('key'); // Retrieve data by key.

// Delete a key from the database

db.delete('key'); // Remove a key from the database.

// Check if a key exists

db.has('key'); // Returns true if the key exists, otherwise false.

// Add a number to a key's value

db.add('key', 10); // Increment a key's value by 10.

// Subtract a number from a key's value

db.subtract('key', 5); // Decrement a key's value by 5.

// Push a value to an array stored at a key

db.push('key', 10); // Append 10 to the array.

// Perform mathematical operations

db.math('key', '+', 5); // Perform addition on the value of the key.

// Fetch all data

db.fetchAll(); // Retrieve all data from the database.

// Backup the database

db.backup('backup-file'); // Create a backup of the database.

// Reset the database

db.reset(); // Clear the entire database.

✨ Features

  • Effortless Data Storage: Use key-value pairs to store and manage data easily.

  • Full Backup & Reset: Backup the entire database or reset it to start fresh.

  • Math Functions: Perform basic arithmetic operations on stored data directly.

  • Existence Checks: Quickly verify if a key exists in the database.

  • Human-readable JSON: Data is stored in a readable JSON format for easy external management.


🎯 Why Use Wizef-DB?

  • Simplicity: Perfect for small to medium-sized projects where a full-fledged database is overkill.

  • No Setup Required: Start storing data immediately without complex configurations.

  • Quick Backup & Restore: Easily create backups and restore your database when needed.


💬 Get in Touch

Need help or want to share your thoughts? Join our community on Discord:


1.0.3

10 months ago

1.0.2

10 months ago

1.0.1

10 months ago

1.0.0

10 months ago