clay-driver-localstorage

2.0.4 • Public • Published

clay-driver-localstorage

Build Status npm Version JS Standard

LocalStorage driver for ClayDB

Installation

$ npm install clay-driver-localstorage --save

Usage

'use strict'
 
const LocalStorageDriver = require('clay-driver-localstorage')
 
{
  const clayLump = require('clay-lump')
  let lump01 = clayLump({
    driver: new LocalStorageDriver({})
  })
  /* ... */
}
 

API

clay-driver-localstorage@2.0.3

LocalStorage driver for ClayDB

Functions

create(args) -> LocalStorageDriver

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()

driver.one(resourceName, id) -> Promise.<ClayEntity>

Get single entity from resource

Param Type Description
resourceName string Name of resource
id ClayId Resource id

driver.list(resourceName, condition) -> Promise.<ClayCollection>

List entities from resource

Param Type Description
resourceName string Name of resource
condition ListCondition List condition query

driver.create(resourceName, attributes) -> Promise.<ClayEntity>

Create a new entity with resource

Param Type Description
resourceName string Name of resource
attributes Object Resource attributes to create

driver.update(resourceName, id, attributes) -> Promise.<ClayEntity>

Update an existing entity in resource

Param Type Description
resourceName string Name of resource
id ClayId Resource id
attributes Object Resource attributes to update

driver.destroy(resourceName, id) -> Promise.<number>

Delete a entity resource

Param Type Description
resourceName string Name of resource
id ClayId Resource id

driver.drop(resourceName) -> Promise.<boolean>

Drop resource

Param Type Description
resourceName string Name of resource

driver.resources() -> Promise.<Resource>

List resources

License

This software is released under the Apache-2.0 License.

Links

Readme

Keywords

Package Sidebar

Install

npm i clay-driver-localstorage

Weekly Downloads

2

Version

2.0.4

License

Apache-2.0

Unpacked Size

80 kB

Total Files

35

Last publish

Collaborators

  • realglobe