array-datastore

A datastore to easily and consistently store unique objects in an array.

You can also specify placeholders for displaying shimmers while awaiting data from an API call.

• Install
• Usage
• Example
• 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.
10. hasPlaceholders() Checks if the store has placeholder objects.
11. clearPlaceholders() Remove the placeholder objects from the store.

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

config object

When creating the store, you can specify an optional configuration object.

placeholders: number|Array<Object>

You can specify a number of placeholders or an array of placeholder objects that will populate the store until you add your first actual object or you call the #clearPlaceholders() method.

Example

Tests

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

Contributing

Feel free to open a pull request!