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

bryku-jsonbase

v1.0.6

Published

Interact with .json files like a database.

Downloads

9

Readme

Summary

Jsonbase allows you to interact with .json files like a database. This can be a great solution for logs, news, and admin messages. I would say the target range is for databases smaller than 200 rows, otherwise a traditional database is recommended.

.target(directory) (STRING)

Defines the directory location for the database files.

  • /index.js
  • /database
  • /database/employees.json
jsonbase.target('/database')
   .then(()=>{
       // do something
   })
   .catch((e)=>{
       // handle errors
   })

.create(table) (STRING)

Creates a new tables.

jsonbase.create('employees')
    .then(()=>{
        // do something
    })
    .catch((e)=>{
        // handle errors
    })

.backup(table) (STRING)

Creates a backup of table. The backup will be stored in the specificed directory with the same name, but it will be converted into a text file.

jsonbase.backup('employees')
	.then(()=>{
		// do something
	})
	.catch((e)=>{
	    // handle errors
	})
  

.revert(table) (STRING)

Overrides the current table with the backup.

jsonbase.revert('employees')  
	.then(()=>{
		// do something
	})
	.catch((e)=>{
	    // handle errors
	})

.delete(table) (STRING)

Deletes and existing table.

jsonbase.delete('employees')  
	.then(()=>{
		// do something
	})
	.catch((e)=>{
	    // handle errors
	})

.report()

Returns an ARRAY with table information.

jsonbase.report()
    .then((output)=>{
        // do something    
	})
	.catch((e)=>{
	    // handle errors
	})

The output will look like this:

[
    { name: 'employees', bytes: 147, size: '147b', rows: 2 }
]  

.insert(table, data) (STRING, ARRAY/OBJECT)

Inserts a new row into the table. This will return the number of rows added.

let employee = {
    name: 'john doe',
    age: 57,
};
jsonbase.insert('employees', employee)
    .then((count)=>{
        // do something
    })
    .catch((e)=>{
        // handle errors
    })

You can also add multiple rows at one time using an Array.

let employees = [
	{name: 'jane doe', age: 54,}
	{name: 'joe doe', age: 31,}	
};
jsonbase.insert('employees', employees)
    .then((count)=>{
        // do something
    })
    .catch((e)=>{
        // handle errors
    })

.update(table, query, data) (STRING, FUNCTION, OBJECT)

Updates all matching rows within the table.

jsonbase.update('employees', (r)=>{r.name == 'John Doe'}, {position: 'manager'})
    .then((count)=>{
        // do something
    })
    .catch((e)=>{
        // handle errors
    })

.single(table, query) (STRING, FUNCTION)

Returns the first matching result.

jsonbase.single('employee', (r)=>{return r.name == 'john doe'})
    .then((row)=>{
        // do something
    })  
    .catch((e)=>{
        // handle errors
    })

.select(table, query) (STRING, FUNCTION)

jsonbase.select('employee', (r)=>{return r.age > 40})
    .then((rows)=>{
        // do something
    })  
    .catch((e)=>{
        // handle errors
    })

.remove(table, query) (STRING, FUNCTION)

Removes all matching rows.

jsonbase.remove('employees',(r)=>{return r.name = 'joe doe'})
    .then(()=>{
        // do something
    })
    .catch((e)=>{
        // handle errors
    })