rks-db

rks-db is a lightweight, file-based database system for Node.js, designed to simulate database-like functionality using the file system. It provides simple methods for creating, reading, updating, and deleting data in JSON format, making it ideal for practice or small projects without the need for a full-fledged database.

Table of Contents

• Features
• Installation
• Usage
  • Importing the Module
  • Creating a New Entry (make)
  • Finding All Entries (findAll)
  • Finding an Entry by ID (findById)
  • Updating an Entry (update)
  • Deleting an Entry by ID (deleteById)
  • Deleting All Entries (deleteAll)
• API Reference
  • make(dir, databaseName, schema)
  • findAll(dir)
  • findById(dir, id)
  • update(dir, id, updateData)
  • deleteById(dir, id)
  • deleteAll(dir)
• Error Handling
• Examples
• Contributing
• License

Features

• Create new entries (saved as JSON files in a directory).
• Find all data in a directory.
• Find by ID from the directory.
• Update data by ID.
• Delete by ID or Delete all files in a directory.
• Simple and easy-to-use API based on Node.js's native fs module.
• No external dependencies beyond Node.js.

Installation

Install rks-db using npm:

npm install rks-db