Provider

Providers are special pieces that give you easy access to various data storage systems using a consistent and predictable set of methods
Example

The following structure is needed for SettingGateway compatibility. 

exports.hasTable = (table) => { // code here };
exports.createTable = (table) => { // code here };
exports.getAll = (table) => { // code here };
exports.get = (table, id) => { // code here };
exports.create = (table, id, document) => { // code here };
exports.delete = (table, id) => { // code here };
exports.update = (table, id, document) => { // code here };
exports.replace = (table, id, document) => { // code here };
exports.conf = {};

Members

static conf :Conf
documentation/ProviderStructure.js, line 91

An object that configures the provider.
Example
exports.conf = {
  enabled: true,
  moduleName: "json",
  priority: 0
};

Methods

static create(table, id, document) → {Promise.<*>}
documentation/ProviderStructure.js, line 53

Create a new entry into a table.
Parameters:
Name Type Description
table string The name of the table to update.
id string The ID for the new entry.
document Object A JSON object.
Returns:
Promise.<*>

static createTable(table) → {Promise.<*>}
documentation/ProviderStructure.js, line 29

Create a new table.
Parameters:
Name Type Description
table string The name for the new table.
Returns:
Promise.<*>

static delete(table, id) → {Promise.<Array.<{}>>}
documentation/ProviderStructure.js, line 61

Delete an entry from a table.
Parameters:
Name Type Description
table string The name of the table to update.
id string The ID of the entry to delete.
Returns:
Promise.<Array.<{}>>

static get(table, id) → {Promise.<Array.<{}>>}
documentation/ProviderStructure.js, line 44

Get an entry from a table.
Parameters:
Name Type Description
table string The name of the table to fetch from.
id string The ID of the entry to get.
Returns:
Promise.<Array.<{}>>

static getAll(table) → {Promise.<Array.<{}>>}
documentation/ProviderStructure.js, line 36

Get all entries from a table.
Parameters:
Name Type Description
table string The name of the table to fetch from.
Returns:
Promise.<Array.<{}>>

static hasTable(table) → {Promise.<boolean>}
documentation/ProviderStructure.js, line 22

Checks if a table exists.
Parameters:
Name Type Description
table string The name of the table you want to check.
Returns:
Promise.<boolean>

static replace(table, id, document) → {Promise.<*>}
documentation/ProviderStructure.js, line 79

Replace an entry from a table.
Parameters:
Name Type Description
table string The name of the table to update.
id string The ID of the entry to update.
document Object The new JSON object for the document.
Returns:
Promise.<*>

static update(table, id, document) → {Promise.<*>}
documentation/ProviderStructure.js, line 70

Update an entry from a table.
Parameters:
Name Type Description
table string The name of the table to update.
id string The ID of the entry to update.
document Object A JSON object.
Returns:
Promise.<*>