js-data-http

Class: Adapter

Adapter

<abstract> new Adapter(opts)

Abstract class meant to be extended by adapters.

Method parameters:
Name Type Argument Description
opts Object <optional>

Configuration opts.

Properties
Name Type Argument Default Description
debug Boolean <optional>
 false

Whether to log debugging information.
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Details
Source
node_modules/js-data-adapter/src/index.js, line 93

Extends

This class extends the Component class.

Members

debug

Whether to log debugging information.

Details
Type Default value Source Overrides
Boolean 
false
 node_modules/js-data-adapter/src/index.js, line 74 Component#debug

raw

Whether to return a more detailed response object.

Details
Type Default value Source
Boolean 
false
 node_modules/js-data-adapter/src/index.js, line 83

Methods

<static> extend(props, classProps)

Create a subclass of this Adapter:

Method parameters:
Name Type Argument Default Description
props Object <optional>
 {}

Properties to add to the prototype of the subclass.

Properties
Name Type Argument Description
constructor Object <optional>

Provide a custom constructor function to be used as the subclass itself.
classProps Object <optional>
 {}

Static properties to add to the subclass.
Return value:
Type Description
Constructor

Subclass of this Adapter class.
Details
Source
node_modules/js-data-adapter/src/index.js, line 1396
Example 

// Normally you would do: import {Adapter} from 'js-data'
const JSData = require('js-data@3.0.0-beta.10')
const {Adapter} = JSData
console.log('Using JSData v' + JSData.version.full)

// Extend the class using ES2015 class syntax.
class CustomAdapterClass extends Adapter {
  foo () { return 'bar' }
  static beep () { return 'boop' }
}
const customAdapter = new CustomAdapterClass()
console.log(customAdapter.foo())
console.log(CustomAdapterClass.beep())

// Extend the class using alternate method.
const OtherAdapterClass = Adapter.extend({
  foo () { return 'bar' }
}, {
  beep () { return 'boop' }
})
const otherAdapter = new OtherAdapterClass()
console.log(otherAdapter.foo())
console.log(OtherAdapterClass.beep())

// Extend the class, providing a custom constructor.
function AnotherAdapterClass () {
  Adapter.call(this)
  this.created_at = new Date().getTime()
}
Adapter.extend({
  constructor: AnotherAdapterClass,
  foo () { return 'bar' }
}, {
  beep () { return 'boop' }
})
const anotherAdapter = new AnotherAdapterClass()
console.log(anotherAdapter.created_at)
console.log(anotherAdapter.foo())
console.log(AnotherAdapterClass.beep())

afterCount(mapper, props, opts, response)

Lifecycle method method called by count.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes count to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the count.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by count.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to count.
props Object

The props argument passed to count.
opts Object

The opts argument passed to count.
response Object | Response

Count or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 115
Properties:
Name Type Description
opts.op String

afterCount

afterCreate(mapper, props, opts, response)

Lifecycle method method called by create.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes create to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the created record.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by create.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to create.
props Object

The props argument passed to create.
opts Object

The opts argument passed to create.
response Object | Response

Created record or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 138
Properties:
Name Type Description
opts.op String

afterCreate

afterCreate(mapper, props, opts, response)

Lifecycle method method called by createMany.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes createMany to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the created records.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by createMany.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to createMany.
props Array.<Object>

The props argument passed to createMany.
opts Object

The opts argument passed to createMany.
response Array.<Object> | Response

Created records or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 161
Properties:
Name Type Description
opts.op String

afterCreateMany

afterDestroy(mapper, id, opts, response)

Lifecycle method method called by destroy.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroy to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be undefined.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroy.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroy.
id String | Number

The id argument passed to destroy.
opts Object

The opts argument passed to destroy.
response undefined | Response

undefined or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 184
Properties:
Name Type Description
opts.op String

afterDestroy

afterDestroyAll(mapper, query, opts, response)

Lifecycle method method called by destroyAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroyAll to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be undefined.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroyAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroyAll.
query Object

The query argument passed to destroyAll.
opts Object

The opts argument passed to destroyAll.
response undefined | Response

undefined or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 207
Properties:
Name Type Description
opts.op String

afterDestroyAll

afterFind(mapper, id, opts, response)

Lifecycle method method called by find.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes find to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the found record, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by find.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to find.
id String | Number

The id argument passed to find.
opts Object

The opts argument passed to find.
response Object | Response

The found record or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 230
Properties:
Name Type Description
opts.op String

afterFind

afterFindAll(mapper, query, opts, response)

Lifecycle method method called by findAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes findAll to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the found records, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by findAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to findAll.
query Object

The query argument passed to findAll.
opts Object

The opts argument passed to findAll.
response Array.<Object> | Response

The found records or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 253
Properties:
Name Type Description
opts.op String

afterFindAll

afterSum(mapper, field, query, opts, response)

Lifecycle method method called by sum.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes sum to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the sum.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by sum.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to sum.
field String

The field argument passed to sum.
query Object

The query argument passed to sum.
opts Object

The opts argument passed to sum.
response Object | Response

Count or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 276
Properties:
Name Type Description
opts.op String

afterSum

afterUpdate(mapper, id, props, opts, response)

Lifecycle method method called by update.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes update to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the updated record.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by update.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to update.
id String | Number

The id argument passed to update.
props Object

The props argument passed to update.
opts Object

The opts argument passed to update.
response Object | Response

The updated record or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 300
Properties:
Name Type Description
opts.op String

afterUpdate

afterUpdateAll(mapper, props, query, opts, response)

Lifecycle method method called by updateAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateAll to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the updated records, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateAll.
props Object

The props argument passed to updateAll.
query Object

The query argument passed to updateAll.
opts Object

The opts argument passed to updateAll.
response Array.<Object> | Response

The updated records or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 324
Properties:
Name Type Description
opts.op String

afterUpdateAll

afterUpdateMany(mapper, records, opts, response)

Lifecycle method method called by updateMany.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateMany to wait for the Promise to resolve before continuing.

If opts.raw is true then response will be a detailed response object, otherwise response will be the updated records, if any.

response may be modified. You can also re-assign response to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateMany.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateMany.
records Array.<Object>

The records argument passed to updateMany.
opts Object

The opts argument passed to updateMany.
response Array.<Object> | Response

The updated records or Response, depending on the value of opts.raw.
Details
Source
node_modules/js-data-adapter/src/index.js, line 348
Properties:
Name Type Description
opts.op String

afterUpdateMany

beforeCount(mapper, query, opts)

Lifecycle method method called by count.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes count to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by count.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to count.
query Object

The query argument passed to count.
opts Object

The opts argument passed to count.
Details
Source
node_modules/js-data-adapter/src/index.js, line 371
Properties:
Name Type Description
opts.op String

beforeCount

beforeCreate(mapper, props, opts)

Lifecycle method method called by create.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes create to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by create.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to create.
props Object

The props argument passed to create.
opts Object

The opts argument passed to create.
Details
Source
node_modules/js-data-adapter/src/index.js, line 389
Properties:
Name Type Description
opts.op String

beforeCreate

beforeCreateMany(mapper, props, opts)

Lifecycle method method called by createMany.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes createMany to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by createMany.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to createMany.
props Array.<Object>

The props argument passed to createMany.
opts Object

The opts argument passed to createMany.
Details
Source
node_modules/js-data-adapter/src/index.js, line 409
Properties:
Name Type Description
opts.op String

beforeCreateMany

beforeDestroy(mapper, id, opts)

Lifecycle method method called by destroy.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroy to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroy.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroy.
id String | Number

The id argument passed to destroy.
opts Object

The opts argument passed to destroy.
Details
Source
node_modules/js-data-adapter/src/index.js, line 429
Properties:
Name Type Description
opts.op String

beforeDestroy

beforeDestroyAll(mapper, query, opts)

Lifecycle method method called by destroyAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes destroyAll to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by destroyAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to destroyAll.
query Object

The query argument passed to destroyAll.
opts Object

The opts argument passed to destroyAll.
Details
Source
node_modules/js-data-adapter/src/index.js, line 447
Properties:
Name Type Description
opts.op String

beforeDestroyAll

beforeFind(mapper, id, opts)

Lifecycle method method called by find.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes find to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by find.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to find.
id String | Number

The id argument passed to find.
opts Object

The opts argument passed to find.
Details
Source
node_modules/js-data-adapter/src/index.js, line 465
Properties:
Name Type Description
opts.op String

beforeFind

beforeFindAll(mapper, query, opts)

Lifecycle method method called by findAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes findAll to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by findAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to findAll.
query Object

The query argument passed to findAll.
opts Object

The opts argument passed to findAll.
Details
Source
node_modules/js-data-adapter/src/index.js, line 483
Properties:
Name Type Description
opts.op String

beforeFindAll

beforeSum(mapper, query, opts)

Lifecycle method method called by sum.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes sum to wait for the Promise to resolve before continuing.

A thrown error or rejected Promise will bubble up and reject the Promise returned by sum.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to sum.
query Object

The query argument passed to sum.
opts Object

The opts argument passed to sum.
Details
Source
node_modules/js-data-adapter/src/index.js, line 501
Properties:
Name Type Description
opts.op String

beforeSum

beforeUpdate(mapper, id, props, opts)

Lifecycle method method called by update.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes update to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by update.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to update.
id String | Number

The id argument passed to update.
props Object

The props argument passed to update.
opts Object

The opts argument passed to update.
Details
Source
node_modules/js-data-adapter/src/index.js, line 519
Properties:
Name Type Description
opts.op String

beforeUpdate

beforeUpdateAll(mapper, props, query, opts)

Lifecycle method method called by updateAll.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateAll to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateAll.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateAll.
props Object

The props argument passed to updateAll.
query Object

The query argument passed to updateAll.
opts Object

The opts argument passed to updateAll.
Details
Source
node_modules/js-data-adapter/src/index.js, line 540
Properties:
Name Type Description
opts.op String

beforeUpdateAll

beforeUpdateMany(mapper, props, opts)

Lifecycle method method called by updateMany.

Override this method to add custom behavior for this lifecycle hook.

Returning a Promise causes updateMany to wait for the Promise to resolve before continuing.

props may be modified. You can also re-assign props to another value by returning a different value or a Promise that resolves to a different value.

A thrown error or rejected Promise will bubble up and reject the Promise returned by updateMany.

Method parameters:
Name Type Description
mapper Object

The mapper argument passed to updateMany.
props Array.<Object>

The props argument passed to updateMany.
opts Object

The opts argument passed to updateMany.
Details
Source
node_modules/js-data-adapter/src/index.js, line 561
Properties:
Name Type Description
opts.op String

beforeUpdateMany

count(mapper, query, opts)

Retrieve the number of records that match the selection query. Called by Mapper#count.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 581

create(mapper, props, opts)

Create a new record. Called by Mapper#create.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
props Object

The record to be created.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 627

createMany(mapper, props, opts)

Create multiple records in a single batch. Called by Mapper#createMany.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
props Object

The records to be created.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 669

dbg(args)

Log the provided values at the "debug" level. Debug-level logs are only logged if Component#debug is true.

.dbg(...) is shorthand for .log('debug', ...).

Method parameters:
Name Type Argument Description
args * <optional>
<repeatable>

Values to log.
Details
Since Source
3.0.0 node_modules/js-data/src/Component.js, line 124
Inherited From:

destroy(mapper, id, opts)

Destroy the record with the given primary key. Called by Mapper#destroy.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
id String | Number

Primary key of the record to destroy.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 712

destroyAll(mapper, query, opts)

Destroy the records that match the selection query. Called by Mapper#destroyAll.

Method parameters:
Name Type Argument Description
mapper Object

the mapper.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 750

emit(event, args)

Trigger an event on this Component.

Method parameters:
Name Type Argument Description
event String

Name of event to emit.
args * <optional>
<repeatable>

Arguments to pass to any listeners.
Details
Since Source
3.0.0 node_modules/js-data/src/Component.js, line 202
Inherited From:
Example 

// import {Collection, DataStore} from 'js-data'
const JSData = require('js-data@3.0.0-rc.4')
const {Collection, DataStore} = JSData

const collection = new Collection()
collection.on('foo', function (msg) {
  console.log(msg)
})
collection.emit('foo', 'bar')

const store = new DataStore()
store.on('beep', function (msg) {
  console.log(msg)
})
store.emit('beep', 'boop')

find(mapper, id, opts)

Retrieve the record with the given primary key. Called by Mapper#find.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
id String | Number

Primary key of the record to retrieve.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
with Array.<String> <optional>
 []

Relations to eager load.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 835

findAll(mapper, query, opts)

Retrieve the records that match the selection query.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
with Array.<String> <optional>
 []

Relations to eager load.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 874

getOpt(opt, opts)

Resolve the value of the specified option based on the given options and this adapter's settings. Override with care.

Method parameters:
Name Type Argument Description
opt String

The name of the option.
opts Object <optional>

Configuration options.
Return value:
Type Description
*

The value of the specified option.
Details
Source
node_modules/js-data-adapter/src/index.js, line 960

loadBelongsTo()

Load a belongsTo relationship.

Override with care.

Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 795

loadHasMany()

Load a hasMany relationship.

Override with care.

Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 975

loadHasOne()

Load a hasOne relationship.

Override with care.

Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1109

log(level, args)

Log the provided values. By default sends values to console[level]. Debug-level logs are only logged if Component#debug is true.

Will attempt to use appropriate console methods if they are available.

Method parameters:
Name Type Argument Description
level String

Log level.
args * <optional>
<repeatable>

Values to log.
Details
Since Source
3.0.0 node_modules/js-data/src/Component.js, line 134
Inherited From:

makeBelongsToForeignKey()

Return the foreignKey from the given record for the provided relationship.

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1178

makeHasManyForeignKey()

Return the foreignKey from the given record for the provided relationship.

There may be reasons why you may want to override this method, like when the id of the parent doesn't exactly match up to the key on the child.

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1132

makeHasManyForeignKeys()

Return the foreignKeys from the given record for the provided relationship.

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1165

makeHasManyLocalKeys()

Return the localKeys from the given record for the provided relationship.

Override with care.

Return value:
Type Description
* Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1148

off(event, listener)

Remove an event listener from this Component. If no listener is provided, then all listeners for the specified event will be removed. If no event is specified then all listeners for all events will be removed.

Method parameters:
Name Type Argument Description
event String <optional>

Name of event to unsubsribe to.
listener Function <optional>

Listener to remove.
Details
Since Source
3.0.0 node_modules/js-data/src/Component.js, line 180
Inherited From:
Examples 
// Remove a particular listener for a particular event
collection.off('add', handler)
// Remove all listeners for a particular event
record.off('change')
// Remove all listeners to all events
store.off()

on(event, listener, ctx)

Register a new event listener on this Component.

Method parameters:
Name Type Argument Description
event String

Name of event to subsribe to.
listener Function

Listener function to handle the event.
ctx * <optional>

Optional content in which to invoke the listener.
Details
Since Source
3.0.0 node_modules/js-data/src/Component.js, line 147
Inherited From:
Examples 
// Listen for all "afterCreate" events in a DataStore
store.on('afterCreate', (mapperName, props, opts, result) => {
  console.log(mapperName) // "post"
  console.log(props.id) // undefined
  console.log(result.id) // 1234
})
store.create('post', { title: 'Modeling your data' }).then((post) => {
  console.log(post.id) // 1234
})
// Listen for the "add" event on a collection
collection.on('add', (records) => {
  console.log(records) // [...]
})
// Listen for "change" events on a record
post.on('change', (record, changes) => {
  console.log(changes) // { changed: { title: 'Modeling your data' } }
})
post.title = 'Modeling your data'

respond(response, opts)

Method parameters:
Name Type Description
response Object

Response object.
opts Object

Configuration options. return {Object} If opts.raw == true then return response, else return response.data.
Details
Source
node_modules/js-data-adapter/src/index.js, line 1241

sum(mapper, field, query, opts)

Retrieve sum of the specified field of the records that match the selection query. Called by Mapper#sum.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
field String

By to sum.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1191

update(mapper, id, props, opts)

Apply the given update to the record with the specified primary key. Called by Mapper#update.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
id String | Number

The primary key of the record to be updated.
props Object

The update to apply to the record.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1253

updateAll(mapper, props, query, opts)

Apply the given update to all records that match the selection query. Called by Mapper#updateAll.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
props Object

The update to apply to the selected records.
query Object <optional>

Selection query.

Properties
Name Type Argument Description
where Object <optional>

Filtering criteria.
orderBy String | Array <optional>

Sorting criteria.
sort String | Array <optional>

Same as query.sort.
limit Number <optional>

Limit results.
skip Number <optional>

Offset results.
offset Number <optional>

Same as query.skip.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1297

updateMany(mapper, records, opts)

Update the given records in a single batch. Called by Mapper#updateMany.

Method parameters:
Name Type Argument Description
mapper Object

The mapper.
records Array.<Object>

The records to update.
opts Object <optional>

Configuration options.

Properties
Name Type Argument Default Description
raw Boolean <optional>
 false

Whether to return a more detailed response object.
Return value:
Type Description
Promise Unspecified
Details
Source
node_modules/js-data-adapter/src/index.js, line 1349