Puff Cheeks
Puff Cheeks is local Json database. Objects are stored in an array with a unique key and id.
const PuffCheeksStorage = require("@puff-cheeks/storage")
const chipmunks = new PuffCheeksStorage("chipmunk", "name")PuffCheeks
Kind: global class
-
PuffCheeks
- new PuffCheeks(fname, key, [folder])
-
.add(object) ⇒
Boolean -
.delete(object) ⇒
Boolean -
.deleteByKey(key) ⇒
Boolean -
.deleteById(id) ⇒
Boolean -
.update(object) ⇒
Boolean -
.findByKey(key) ⇒
Object|Boolean -
.findById(id) ⇒
Object -
.sortByKey(keys) ⇒
Boolean -
.sortById(ids) ⇒
Boolean
new PuffCheeks(fname, key, [folder])
Creates a new Json Database or opens an existing one
| Param | Type | Default | Description |
|---|---|---|---|
| fname | String |
File name to store - will append .json if needed | |
| key | String |
Unique key to identify object | |
| [folder] | String |
"puff_cheeks_storage" |
Storage folder |
puffCheeks.add(object) ⇒ Boolean
Adds a single Object to the front of the array
Kind: instance method of PuffCheeks
Returns: Boolean - True if object added, false if object has duplicate key/id
| Param | Type | Description |
|---|---|---|
| object | Object |
add an object, must have matching key parameter |
puffCheeks.delete(object) ⇒ Boolean
Deletes an oject from the array
Kind: instance method of PuffCheeks
Returns: Boolean - True if object deleted, false if object not in db
| Param | Type | Description |
|---|---|---|
| object | Object |
delete an object, must have matching id parameter |
puffCheeks.deleteByKey(key) ⇒ Boolean
Deletes an object by key
Kind: instance method of PuffCheeks
Returns: Boolean - True if object deleted, false if object not in db
| Param | Type | Description |
|---|---|---|
| key | String |
unique string |
puffCheeks.deleteById(id) ⇒ Boolean
Deletes an object by ID
Kind: instance method of PuffCheeks
Returns: Boolean - True if object deleted, false if object not in db
| Param | Type | Description |
|---|---|---|
| id | Number |
A unique number (UUID) |
puffCheeks.update(object) ⇒ Boolean
Updates objects
Kind: instance method of PuffCheeks
Returns: Boolean - True if object updated, false if object not in db
| Param | Type | Description |
|---|---|---|
| object | Object |
Must have matching key |
puffCheeks.findByKey(key) ⇒ Object | Boolean
Finds object by key
Kind: instance method of PuffCheeks
Returns: Object | Boolean - Object if found, false if object not in db
| Param | Type | Description |
|---|---|---|
| key | String |
unique string |
puffCheeks.findById(id) ⇒ Object
Finds object by Id
Kind: instance method of PuffCheeks
Returns: Object - Object if found, false if object not in db
| Param | Type | Description |
|---|---|---|
| id | String |
unique string |
puffCheeks.sortByKey(keys) ⇒ Boolean
Sorts the Data array using an ordered array of keys
Kind: instance method of PuffCheeks
Returns: Boolean - - true if sorted, false if failed
| Param | Type | Description |
|---|---|---|
| keys | Array |
Array of keys |
puffCheeks.sortById(ids) ⇒ Boolean
Sorts the Data array using an ordered array of ids
Kind: instance method of PuffCheeks
Returns: Boolean - - true if sorted, false if failed
| Param | Type | Description |
|---|---|---|
| ids | Array |
Array of ids |
© 2023 Nick Dolf