fshdb/README.md

A lightweight & fast json database with the essentials and more

# FshDB
A lightweight & fast json database with the essentials and more

```js
// Require the base db
const DB = require('fshdb');

// Creating the db
let fsh = new DB();

// Setting data
fsh.set('key', 'value');
```

## Constructor
DB(file, options)
- `file` - Optional, File where the db will be, relative, Default: `DB.json`
- `options` - Optional
  - `compact` - Compact db files
  - `warm` - Does not store to file, good for cache

## Base Functions
- `set(key, value)` - Sets a value to a key (can be any standard type)
- `get(key)` - Gets the value of a key
- `has(key)` - Checks for a key in the db return true or false
- `remove(key)` - Removes a key from the db
- `find(function)` - Returns a list of keys which values follow the function
- `keys()` - List of all the keys on the db
- `values()` - List of all the values on the db
- `all()` - Gets the whole database as object
- `backup(file)` - Backups the db file to another file (big dbs will take some time)

### Number values
Functions for values that are of type number (Values will be converted)
- `add(key, number)` - Adds the number to the current
- `sub(key, number)` - Subtracts the number to the current

### Array values
Functions for values that are of type array
- `push(key, value)` - Pushes value into the list element
- `pull(key, index)` - Removes element at index
- `pop(key)` - Removes last element (return removed value)
- `flat(key)` - Flattens array at key
- `concat(key, value)` - Concats a array to the current one

### Object values
Functions for values that are of type object/json
You can add `.` inside the keys to denote access of a further object
Example of `.`: `key.key2` for { key: { key2: 'Hello', key1: 'Bye' } } is 'Hello'
So far this can be used for get and set