OmgImAlexis / jsonbox-node

A node wrapper for jsonbox.io

JsonBox for Node

A Node Wrapper for https://jsonbox.io/

Install

npm install --save jsonbox-node or yarn add jsonbox-node

Usage

Typescript

import { JsonBox } from './src';

interface Worker {
    name: string
    level: number
}

interface User {
    name: string
    age: number
}

const BOX_ID = 'abc123';
const recordId = 'abc123';
const recordIds = [recordId];

const main = async () => {
    // By default this will use jsonbox.io as the host
    // you can use your own custom instance by providing
    // the url as the first parameter.
    const jbn = new JsonBox();

    // Create a record
    await jbn.create<User>({
        name: 'Test',
        age: 42
    }, BOX_ID);

    // Create a record in a collection
    await jbn.create<Worker>({
        name: 'Foobar',
        level: 1337
    }, BOX_ID, 'workers');

    // Read records
    await jbn.read<Worker>(BOX_ID);

    // Read records in collection with filters
    await jbn.read<User>(BOX_ID, 'users', { sort: 'age', query: 'age:>23', limit: 1, skip: 2 });

    // Update a record
    await jbn.update<User>({ age: 43 }, BOX_ID, recordId);

    // Delete a record
    await jbn.delete(BOX_ID, recordId);

    // Delete a record set
    await jbn.deleteMany(BOX_ID, recordIds);
};

main().catch(console.error);

Javascript

const { JsonBox } = require('jsonbox-node');

const BOX_ID = 'abc123';
const recordId = 'abc123';
const recordIds = [recordId];

const main = async () => {
    // By default this will use jsonbox.io as the host
    // you can use your own custom instance by providing
    // the url as the first parameter.
    const jbn = new JsonBox();

    // Create a record
    await jbn.create({
        name: 'Test',
        age: 42
    }, BOX_ID);

    // Create a record in a collection
    await jbn.create({
        name: 'Foobar',
        level: 1337
    }, BOX_ID, 'workers');

    // Read records
    await jbn.read(BOX_ID);

    // read records in collection with filters
    await jbn.read(BOX_ID, 'users', { sort: 'age', query: 'age:>23', limit: 1, skip: 2 });

    // Update a record
    await jbn.update({ age: 43 }, BOX_ID, recordId);

    // Delete a record
    await jbn.delete(BOX_ID, recordId)

    // Delete a record set
    await jbn.deleteMany(BOX_ID, recordIds);
};

main().catch(console.error);