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

filebaser

v1.0.3

Published

Database engine based on MongoDB but using system files

Downloads

54

Readme

Filebaser

TravisCI CodeCov NPM Version NPM Downloads Licence Filebaser is an engine for managing database documents like MongoDB.

Installation

All dependencies of Filebaser are easily installed by npm.

    npm install -g istanbul codecov
    npm install

Declaration

How to declare:

    const FileBaser = require('filebase');

    let fb = new FileBaser('databasefile.db');

Querying

You can apply any filter like in MongoDB

    let collection = fb.getColletion('users');

    let users = collection.find({
        limit: 10,
        where: {
            age: { gte: 18 },
            active: true
        }
    });

There's an alternative way for filtering data, shown in the example below:

    let collection = fb.getCollection('users');

    let users = collection
        .find()
        .where('age', 'gte', 18)
        .where('active', true)
        .limit(10)
        .fetchAll();

Or you can even use your own custom filter:

    let users = collection()
        .find()
        .where((element) => {
            return element.active || element.name.indexOf('base');
        })
        .limit(5)
        .fetchAll();

Saving

For inserting and updating data we use a pattern similar to an ORM

    let collection = fb.getCollection('users');

    let obj = {
        name: 'filebase',
        login: 'file.baser',
        pass: 'file@123baser#',
        age: 24,
        active: true
    };

    collection.save(obj);

After that this object received an unique ID for identification and was saved to memory.

In case object already has an ID (is not a new object), than the data is saved and ID is not regenerated.

Why saved on memory ?

Because we are talking about writing data into a file. Even NodeJS works asynchronously it should sometime overload the app. So, to solve this problem we created a function called "flush()". It's reponsible for sending saved data directly to the database file. E.g.: continuing from last example about inserting data.

    collection.flush();

What about async ?

Recently implemented, there're some calls that can be made asynchronously.

    let fb = new FileBaser('databasefile.db');

    let collection = fb
        .getCollectionAsync('users')
        .then((collection) => {
           let users = collection
                .find()
                .where((element) => element.active)
                .limit(10)
                .fetchAll();
        });

Testing

For automated tests we're using Mocha. And, integrated with npm custom scripts, you can run that easily using the following command.

    npm run test

Project also relies on codecov and istanbul for measuring codecoverage.