record.js/README.md

1.1 KiB

Record.js

A minimalistic dead-simple object collection library

Go kick the tires in dist/

WIP

Not done yet!

API

The public API is very simple, only really need 3 methods: add, remove, and find.

Method Description
.add(object) Adds entry to collection and return entry added
`.remove(id object)`
`.find(id object)`
.count() returns number of records in collection

SEE: API Documentation

Options

- store: localStorage KEY to use. 

Tests

npm test

Support

Please open an issue for support.

Contributing

Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines, there minimalistic;)

License

MIT