api.md

[email protected]

Lump of clay-db

• Functions
  • create()
  • isLump(instance)
• ClayLump Class
  • new ClayLump(name, options)
  • lump.sync(lump)
  • lump.assert()
  • lump.dump(dirname, options)
  • lump.restore(dirname, options)
  • lump.close()
  • lump.registerPolicies(policies)
  • lump.registerPolicy(name, policy)
  • lump.getPolicy(name)
  • lump.registerDriver(driver)
  • lump.merge(lump, options)
  • lump.mergeResource(resource)
  • lump.resource(resourceName, options)
  • lump.setResource(resourceName, resource)
  • lump.getResource(resourceName)
  • lump.resourceNames()
• DriverMixed Class
  • new DriverMixed()
  • mixed.registerDriver(driver)
• MergeMixed Class
  • new MergeMixed()
  • mixed.merge(lump, options)
  • mixed.mergeResource(resource)
• PolicyMixed Class
  • new PolicyMixed()
  • mixed.registerPolicies(policies)
  • mixed.registerPolicy(name, policy)
  • mixed.getPolicy(name)
• RefMixed Class
  • new RefMixed()
  • mixed.resolveEntityRef(ref)
• ResourceMixed Class
  • new ResourceMixed()
  • mixed.resource(resourceName, options)
  • mixed.setResource(resourceName, resource)
  • mixed.getResource(resourceName)
  • mixed.resourceNames()

Functions

create() -> ClayLump

Create a lump instance. Just an alias of new ClayLump(config) Example:

async function tryClayLump () {
   let lump = clayLump({
     // Options here
   })
   const Product = lump.resource('Product')
   // ... //
 }
 tryClayLump()

isLump(instance) -> Boolean

Check if an instance is a lump

Param	Type	Description
instance	*	Instance to check

ClayLump Class

Local storage of Clay DB.

Extends:

• PolicyMixed
• DriverMixed
• MergeMixed
• ResourceMixed

new ClayLump(name, options)

Constructor of ClayLump class

Param	Type	Description
name	string	Lump name
options	Object	Optional settings
options.driver	Driver	Clay driver instance

lump.sync(lump) -> Promise

Two-way merge

Param	Type	Description
lump	ClayLump	Lump to sync

lump.assert()

Asset lump state and throw error if something is wrong

lump.dump(dirname, options) -> Promise

Dump database

Param	Type	Description
dirname	string	Directory name to dump
options	Object	Optional settings
options.force	boolean	Override if already exists

lump.restore(dirname, options) -> Promise

Restore database

Param	Type	Description
dirname	string	Directory name of the dump
options	Object	Optional settings
options.force	boolean	Override existing data

lump.close() -> Promise

Close database

lump.registerPolicies(policies)

Register policies

Param	Type	Description
policies	Object	Policies to register

lump.registerPolicy(name, policy)

Register a policy

Param	Type	Description
name	string	Resource name to apply policy
policy	ClayPolicy	Policies to register

lump.getPolicy(name) -> ClayPolicy

Get a policy

Param	Type	Description
name	string	Name of policy

lump.registerDriver(driver)

Register a driver

Param	Type	Description
driver	Driver	Driver to register

lump.merge(lump, options) -> Promise

Merge another lump

Param	Type	Description
lump	ClayLump	Lump to merge
options	Object	Optional settings

lump.mergeResource(resource) -> Promise

Merge a resource

Param	Type	Description
resource	ClayResource	Resource to merge

lump.resource(resourceName, options) -> ClayResource

Get a resource with name

Param	Type	Description
resourceName	string,Object	Name of resource
options	Object	Optional settings
options.renew	boolean	Use no cache

lump.setResource(resourceName, resource) -> ResourceMixed

Set resource with name

Param	Type	Description
resourceName	string	Name of resource
resource	ClayResource	Resource to set

lump.getResource(resourceName) -> ClayResource

Get resource by name

Param	Type	Description
resourceName	string	Name of resource

lump.resourceNames() -> Promise.<Array.<string>>

Get all resource names Return all resources

DriverMixed Class

new DriverMixed()

Constructor of DriverMixed class

mixed.registerDriver(driver)

Register a driver

Param	Type	Description
driver	Driver	Driver to register

MergeMixed Class

new MergeMixed()

Constructor of MergeMixed class

mixed.merge(lump, options) -> Promise

Merge another lump

Param	Type	Description
lump	ClayLump	Lump to merge
options	Object	Optional settings

mixed.mergeResource(resource) -> Promise

Merge a resource

Param	Type	Description
resource	ClayResource	Resource to merge

PolicyMixed Class

new PolicyMixed()

Constructor of PolicyMixed class

mixed.registerPolicies(policies)

Register policies

Param	Type	Description
policies	Object	Policies to register

mixed.registerPolicy(name, policy)

Register a policy

Param	Type	Description
name	string	Resource name to apply policy
policy	ClayPolicy	Policies to register

mixed.getPolicy(name) -> ClayPolicy

Get a policy

Param	Type	Description
name	string	Name of policy

RefMixed Class

new RefMixed()

Constructor of RefMixed class

mixed.resolveEntityRef(ref) -> Promise.<Entity>

Resolve ref string

Param	Type	Description
ref	string	Ref string (eg. "User#1")

ResourceMixed Class

new ResourceMixed()

Constructor of ResourceMixed class

mixed.resource(resourceName, options) -> ClayResource

Get a resource with name

Param	Type	Description
resourceName	string,Object	Name of resource
options	Object	Optional settings
options.renew	boolean	Use no cache

mixed.setResource(resourceName, resource) -> ResourceMixed

Set resource with name

Param	Type	Description
resourceName	string	Name of resource
resource	ClayResource	Resource to set

mixed.getResource(resourceName) -> ClayResource

Get resource by name

Param	Type	Description
resourceName	string	Name of resource

mixed.resourceNames() -> Promise.<Array.<string>>

Get all resource names Return all resources