clay-driver-localstorage
LocalStorage driver for ClayDB
Installation
$ npm install clay-driver-localstorage --save
Usage
'use strict' const LocalStorageDriver = const clayLump = let lump01 = /* ... */
API
clay-driver-localstorage@2.0.3
LocalStorage driver for ClayDB
- Functions
LocalStorageDriver
Class- new LocalStorageDriver(dirname, options)
- driver.getStorage()
- driver.delStorage()
- driver.drop()
- driver.one(resourceName, id)
- driver.list(resourceName, condition)
- driver.create(resourceName, attributes)
- driver.update(resourceName, id, attributes)
- driver.destroy(resourceName, id)
- driver.drop(resourceName)
- driver.resources()
Functions
LocalStorageDriver
create(args) -> Create a driver instance
Param | Type | Description |
---|---|---|
args | * |
LocalStorageDriver
Class
Driver to store data into local storages
Extends:
Driver
new LocalStorageDriver(dirname, options)
Constructor of LocalStorageDriver class
Param | Type | Description |
---|---|---|
dirname | string | Directory name to save data |
options | Object | Optional settings |
options.prefix | string | Prefix of key in local storage |
driver.getStorage()
driver.delStorage()
driver.drop()
Promise.<ClayEntity>
driver.one(resourceName, id) -> Get single entity from resource
Param | Type | Description |
---|---|---|
resourceName | string | Name of resource |
id | ClayId | Resource id |
Promise.<ClayCollection>
driver.list(resourceName, condition) -> List entities from resource
Param | Type | Description |
---|---|---|
resourceName | string | Name of resource |
condition | ListCondition | List condition query |
Promise.<ClayEntity>
driver.create(resourceName, attributes) -> Create a new entity with resource
Param | Type | Description |
---|---|---|
resourceName | string | Name of resource |
attributes | Object | Resource attributes to create |
Promise.<ClayEntity>
driver.update(resourceName, id, attributes) -> Update an existing entity in resource
Param | Type | Description |
---|---|---|
resourceName | string | Name of resource |
id | ClayId | Resource id |
attributes | Object | Resource attributes to update |
Promise.<number>
driver.destroy(resourceName, id) -> Delete a entity resource
Param | Type | Description |
---|---|---|
resourceName | string | Name of resource |
id | ClayId | Resource id |
Promise.<boolean>
driver.drop(resourceName) -> Drop resource
Param | Type | Description |
---|---|---|
resourceName | string | Name of resource |
Promise.<Resource>
driver.resources() -> List resources
License
This software is released under the Apache-2.0 License.