jsldb

JavaScript Local Database - create and manipulate a type safe JavaScript object database. Lives in memory, saves to JSON.

---

Project maintained by jechasteen Hosted on GitHub Pages — Theme by mattgraham

Table Object Definition (Schema)

When creating a new database, you must pass an object to the create function that sets the expectations for each table. A schema can contain multiple tables, or you could create a separate instance of jsldb for each table.

const tables = {
    firstTable: {
        firstField: {
            type: 'type',
            required: true
        },
        secondField: {
            type: 'type',
        },
        ...
    },
    secondTable: {
        ...
    }
}

You can use this format to create an arbitrary number of tables, each with an arbitrary number of fields. Each field has 2 members: type and required. Ironically, the parameter required is optional, it defaults to false if not included. If a field is marked required: true and no value is passed upon insertion, an error will be thrown and the entry will be rejected.

The basic types are ‘number’, ‘string’, ‘date’ which are used to check values when inserting a new entry.

Each type can also be declared an array as: 'array *number*'

An entry’s id be can be use as a reference to an entry in a neighboring table. To do so, use the form 'id *tablename*'. You can also make an array of ids by using 'array id *tablename*'. Doing so will check that the referenced table actually exists.

const tables = {
    people: {
        name: {
            type: 'string',
            required: true
        },
        height: {
            type: 'number'
        },
        birthdate: {
            type: 'date',
            required: true
        },
        favcolors: {
            type: 'array id colors'
        }
    },
    colors: {
        name: {
            type: 'string',
            required: true
        },
        hex: {
            type: 'string',
            required: true
        }
    }
}