geoff
/
record.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
minimalistic, dead-simple object collection library
10 Commits 2 Branches 5 Tags 232 KiB
JavaScript 100%
Go to file
Geoff Doty d44346d7be constructor no longer has the option to initialize with a collection of records, use add() 2018-04-07 00:17:56 -04:00
dist fix linting errors 2018-04-02 07:22:23 -04:00
docs updated readme 2018-04-07 00:11:28 -04:00
src constructor no longer has the option to initialize with a collection of records, use add() 2018-04-07 00:17:56 -04:00
test initial commit 2018-04-02 00:35:22 -04:00
.gitignore initial commit 2018-04-02 00:35:22 -04:00
.jshintrc added jshint 2018-04-02 07:21:54 -04:00
CONTRIBUTING.md updated docs 2018-04-02 07:21:19 -04:00
LICENSE updated docs 2018-04-02 07:21:19 -04:00
README.md updated readme 2018-04-07 00:11:28 -04:00
gulpfile.js added build task (gulp) 2018-04-07 00:12:28 -04:00
package-lock.json added build task (gulp) 2018-04-07 00:12:28 -04:00
package.json added build task (gulp) 2018-04-07 00:12:28 -04:00

README.md

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