Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KittyGiraudel/CRUD.js
A CRUD JavaScript class.
https://github.com/KittyGiraudel/CRUD.js
Last synced: 6 days ago
JSON representation
A CRUD JavaScript class.
- Host: GitHub
- URL: https://github.com/KittyGiraudel/CRUD.js
- Owner: KittyGiraudel
- License: unlicense
- Archived: true
- Created: 2013-12-31T08:28:29.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2021-03-06T09:43:20.000Z (over 3 years ago)
- Last Synced: 2024-08-01T13:31:59.612Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 76.2 KB
- Stars: 140
- Watchers: 8
- Forks: 25
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A CRUD JavaScript Class
> Read [introduction article](http://davidwalsh.name/crud-javascript-class) on David Walsh's blog.
Here is a [CRUD](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete) JavaScript class mapping to the storage driver of your choice ([localStorage](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage) in this demo). Before going any further, a couple of things you should note:
**Each record has to be an object**. You can't store an array, a primitive or whatever; only objects. If you want to store — let's say — numbers you should wrap them into objects first; e.g. `{ value: 42 }`.
**You shouldn't try to store different entities in the same database**. The API being quite simple, it aims at solving simple issues. For a more robust JS Database, I suggest you try [Taffy](http://www.taffydb.com/).
## What is the driver?
The driver (the thing that actually does the storage) has been externalized from the main class in order to allow you to use the driver you want: `sessionStorage`, `localStorage`, `Redis`... Anything you want as long as it relies on `key/value` pairs and supports 3 methods: `setItem(..)`, `getItem(..)`, `removeItem(..)`.
The one used per default is a `StorageDriver`, relying on either `localStorage` or `sessionStorage` (in the client or a dummy replication of itself when used on Node), depending on what you pass to the constructor, but you could definitely build your own.
## How does it work?
### Instanciating a database
The `indexedKeys` property aims at speeding up the search. By setting some keys to be indexed, searching for those keys will be way faster. In any case, you can search for any key, even those which are not indexed.
``` js
var db = new Database({
name: 'MyDatabase',
indexedKeys: ['job', 'age']
})
```
### Inserting a new entry
``` js
var obj = {
name: 'Kitty',
age: 23,
job: 'dev'
}
var id = db.insert(obj)
```
*Note: you can pass an array to the `insert(..)` method to add several entries at once.*
### Updating an entry
If you want to update a specific entry, the easiest way is to pass its ID as the first argument. The ID is being added to the entry when inserted as the `id` property. You can change the name of this property by setting the `uniqueKey` option when instanciating the database.
``` js
obj['mood'] = 'happy'
db.update(id, obj)
```
To update a collection of entry based on a search, here is how you would do it:
``` js
var dev, i, len,
devs = this.find({ job: 'dev' })
for(i = 0, len = devs.length; i < len; i++) {
dev = devs[i]
dev['mood'] = 'happy'
dev.job = 'clown'
db.update(dev.id, dev)
}
```
### Retrieving entries
The `find(..)` method requires an object to parse and search with.
``` js
db.find({ mood: 'happy' })
db.find({ job: 'dev', age: 22 })
```
### Retrieving all entries
To return all existing entries, you can call the `find(..)` method with no arguments:
``` js
db.find()
```
### Deleting an entry
If you want to delete a specific entry, the easiest way is to pass its ID to the function. The ID is being added to the entry when inserted as the `id` property. You can change the name of this property by setting the `uniqueKey` option when instanciating the database.
``` js
db.delete(id)
```
If you want to delete a collection of entries based on asearch, you can pass an object to the function. The function will first perform a find, then delete all the returned entries.
``` js
db.delete({ job: dev })
```
### Dropping all entries
To remove all existing entries, you can drop the database which basically resets everything to its initial state:
```js
db.drop()
```
### Counting existing entries
You can use the `count(..)` method to count the number of existing entries:
```js
db.count()
```
## Development
```
# Installing dependencies
npm install
# Linting the code
npm run lint
# Running the tests
npm run test --silent
# Building the dist file
npm run build
```