Arcath/sodb

Single Object Database

SODB

Single Object Data Base

Install

npm install sodb --save

Usage

import db from 'sodb'

interface Record{
  name: string
  gender: string
}

const {add, findOne} = db<Record>()

add({name: 'bob', gender: 'm'})

const bob = findOne({name: 'bob'})
bob.gender // m

• Creating a Database
• Finding Data
• Working with Results
• Updating and Removing Data
• Indexing
• Caching

Contributing

Feel free to fork this repo and submit changes!

Run npm install to install all the modules. Once that finishes run grunt test to run the tests and grunt testDocs to test that the code examples in the docs work.

Please add/amend the documentation to reflect your changes and add any code you put into the documentation to src/db.docs.spec.ts

When you fork sodb please:

1. Create your feature branch (git checkout -b my-new-feature)
2. Commit your changes (git commit -am 'Add some feature')
3. Push to the branch (git push origin my-new-feature)
4. Create new Pull Request