npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nukleon

v0.0.2

Published

simple - json based database module

Downloads

486

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;

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
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

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;

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:

const { Database } =  require('nukleon');
const  db  =  new  Database();

db.setBackup('backup.json') // Set "backup.json" as the backup file
  • how to load your backup:

const { Database } =  require('nukleon');
const  db  =  new  Database();

db.loadBackup(); // Loads the backup from the backup file (setBackup) function

💖 Any Bug Or Suggestion !!

💌 Plasmic

Discord Server Plasmic Website