fastnukleon
Version:
simple - json based database module
174 lines (93 loc) • 4.04 kB
Markdown
# Copied and updated from [Nukleon](https://www.npmjs.com/package/nukleon) package !
# Nukleon's own readme
# **✨ nukleon 0.0.2**
nukleon 0.0.2 is out and with it comes brand new features
## **🛠 What does it do?**
nukleon helps organize your database with the json filebase, simple usage & maximum performance as intended.
## 🔌 Getting Started
* we will start by installing the package
```
npm i nukleon
```
- We will define our file as;
```javascript
const { Database } = require('nukleon')
const db = new Database(/* file.json */)
```
nukleon will create a custom database.json file if the file isn't specified.
## 🔋 Example Usage
- We've listed some examples for you to check up on
```javascript
const { Database } = require('nukleon');
const db = new Database(/* file.json */)
// Set / Push Functions Examples
var object1 = {key: true, key2: "true"}
db.set('Object', object1); /* Object: {key: "value1", key2: "value2"} */
var array1 = ['element', 'element2']
db.set('Array', array1); /* Array: ['element', 'element2'] */
db.push('Array', 'element3'); /* Array: ['element', 'element2', 'element3'] */
// Object & Array Fetch
db.objectFetch('Object', 'key'); /* key: "value1" */
db.arrayFetch('Array', 1); /* element2 */
// Fetch / Get Functions
db.fetch('data'); // Fetches the value of the data
db.get('data'); // Get the value of the data
db.fetchAll(); // Fetches all the data in the database
db.all(); // Fetches everything in the database
// Remove / Delete Functions
db.remove('data'); // Removes the data from the database
db.delete('Array', 'element3'); // Removing something from an array using value/index
db.deleteKey('object', 'key'); // Deletes the provided key from the given object
db.deleteEach('data'); // Deletes each data that starts with the given parameter
// Clear / Destroy Functions
db.clear(); // Clears everything from the database
db.destroy(); // Delete the database file (And Clear All Data)
// Boolean Functions
db.has('data'); // Returns "true" or "false" if the database has the data or not.
// Maths Functions
db.add('data', 1); // Adds one to the data
db.subtract('data', 1); // Subtracts one from the data
db.math("eco", "+", 10); // Adds 10 to the data (without set it), You Can Use [+,-,*,/]
```
## 💯 Math Function
We gave you some math examples using nukleon
```javascript
const { Database } = require('nukleon');
const db = new Database(/* file.json */)
// Set Function
db.set(`eco`, 15)
// Math Function (its simple :])
var newEco = db.math("eco", "-", 10); // output = 5, "eco": 15
db.set(`eco`, newEco) // set "eco": 5
```
## 📚 Multiple Files
- nukleon offers multiple files, heres an example;
```javascript
const { Database } = require('nukleon');
const bot = new Database('bot-config.json');
const servers = new Database('servers-config.json');
const users = new Database('users.json');
servers.push('servers', '800060636041314375'); // servers-config.json file
bot.set('prefix', '#'); // bot-config.json file
users.set('whitelist_747430301654974546', true); // users.json file
```
## 🥶 Data Backup
- You can backup your data and it will help you for atleast one thing
- example:
```javascript
const { Database } = require('nukleon');
const db = new Database();
db.setBackup('backup.json') // Set "backup.json" as the backup file
```
- how to load your backup:
```javascript
const { Database } = require('nukleon');
const db = new Database();
db.loadBackup(); // Loads the backup from the backup file (setBackup) function
```
## 💖 Any Bug Or Suggestion !!
- Contact With Me Discord: **skybow#9999**
- Or use the Plasmic [Discord Server](https://discord.gg/javascript)
## 💌 Plasmic
[Discord Server](https://discord.gg/javascript)
[Plasmic Website](https://plasmic.team)