crud-suit

CRUD-suit

This package gives you a simple CRUD service for any initial development, or prototyping for web applications.

Package Features:

• Saving to LocalStorage.
• Synchronous, or asynchronous operation.
• Total changes Array - the package will record any action done by the service,
  and will give access to that Array of changes. Each action will be timestamped.
• Timestamp and updatedStamp.

How to use

npm install crud-suit

import CRUD from './node_modules/crud-suit/index.js'
const crudService = new CRUD([data | Array], [save to LocalStorage | boolean], [name of key in LocalStorage | string], [asynchronous CRUD | boolean])

Methods

• query - will return the data Array
  When calling this function, a timestamp key will be generated on each object in the Array.

crudService.query()

• getById - will take an _id and will return the object matching that _id

crudService.getById(entityId)

• remove - will take _id and splice it from the data Array. will return a success message.

crudService.remove(entityId)

• getEmptyItem - will return an empty item based on the first object in your data Array

crudService.getEmptyItem()

• add - will take a new data object, add it to the data Array with an _id,
  and will return the new object that was created with the _id.
  When calling this function, a timestamp key will be generated on the added object.

crudService.add(entity)

• update - will find an object inside the data Array and replace it with the new object.
  Will return the _id of updated item.
  When calling this function, an updatedStamp key will be created on each object in the Array.

crudService.update(entity)

• undoAction - will enable you to undo last actions based on snapShot of your data before any crud action.
  It will return the last snapShot of your data before the changes. This method will not save the snapShot Array to localStorage.

crudService.undoAction()

• getActivities - will keep a record of all actions done by the service and timestamp it. It will return an activities Array with objects describing the action.

crudService.getActivities()

Parameters

new CRUD([data | Array], [save to LocalStorage | boolean], [name of key in LocalStorage | string], [asynchronous CRUD | boolean])

First parameter - data | Array

How to insert your data

The CRUD class instance would take a data Array, containing object items as its first parameter.

In order to ensure all methods are working properly, do not insert your data with id key.
_id key for every object will be generated by the CRUD instance.

Second & third parameter - LocalStorage | boolean, key | String

working with LocalStorage

LocalStorage will store a Key-Value pair. In order to save your data to local storage, you will need two parameters. The first parameter is a boolean in order to determine whether the information

will be kept or not, to LocalStorage. The third parameter is a string to determine the key for the localStorage collection.

Fourth parameter - asynchronous | boolean

Working synchronously and asynchronously

This parameter will take a boolean value to determine whether your CRUD instance will
return a simple data format or a Promise based format.