array-datastore

This library can generate a map of your REST API endpoints from your JsDoc and use that map to automatically hook up your endpoints to your ExpressJs app when starting your REST API web server.

• Install
• Usage
• Tests
• Contributing

Install

npm install --save array-datastore

Usage

1. constructor.instance(configObject) Create a new instance of the store with an optional configuration object.
2. addUniqueObject() Add an unique object to the store.
3. addUniqueObjects() Add an array unique objects to the store.
4. prependUniqueObject() Add an unique object to front of the store.
5. prependUniqueObjects() Add an array unique objects to front of the store.
6. replaceObject() Replace an existing object or add to the store.
7. getObjectById() Get an object from the store by its id.
8. deleteObjectById() Delete an object from the store by its id.
9. hasObjectById() Check if the store has an object by its id.

See the tests (tests/dataStore_test.js) to see how these methods are used.

Tests

We use mocha and chai. Run npm test to test the generators.

Contributing

Feel free to open a pull request.