clay-driver-base

Base driver for clay

Installation

$ npm install clay-driver-base --save

Usage

'use strict'

const {Driver} = require('clay-driver-base')

// Define custom driver
class MyDriver extends Driver {
  one (namespace, id) { /* ... */ }

  list (namespace, condition) { /* ... */ }

  create (namespace, attributes) { /* ... */ }

  update (namespace, id, attributes) { /* ... */ }

  destroy (namespace, id) { /* ... */ }

}

{
  const clayLump = require('clay-lump')
  const lump01 = clayLump({
    driver: new MyDriver({/* ... */})
  })
  /* ... */
}

For more detail, see API Guide

API

[email protected]

Base driver for clay

• Functions
  • create(args)
• Driver Class
  • new Driver()
  • driver.one(resourceName, id, options)
  • driver.list(resourceName, condition, options)
  • driver.create(resourceName, attributes)
  • driver.update(resourceName, id, attributes)
  • driver.destroy(resourceName, id)
  • driver.drop(resourceName)
  • driver.resources()

Functions

create(args) -> Driver

Create driver instance

| Param | Type | Description | | ----- | --- | -------- | | args | * | |

Driver Class

Abstract driver

new Driver()

Constructor of Driver class

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

Get single entity from resource

| Param | Type | Description | | ----- | --- | -------- | | resourceName | string | Name of resource | | id | ClayId | Resource id | | options | Object | Options settings |

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

List entities from resource

| Param | Type | Description | | ----- | --- | -------- | | resourceName | string | Name of resource | | condition | ListCondition | List condition query | | options | Object | Options settings |

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

• ClayDB
• Realglobe, Inc.