js-data-http Class: Adapter

<abstract> new Adapter(opts)

Abstract class meant to be extended by adapters.

Parameters:

Name Type Argument Description

opts

Object

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.

Source:

node_modules/js-data-adapter/src/index.js, line 69

Members

debug :boolean

Whether to log debugging information.

Type:

boolean

Default Value:

false

Source:

node_modules/js-data-adapter/src/index.js, line 50

raw :boolean

Whether to return a more detailed response object.

Type:

boolean

Default Value:

false

Source:

node_modules/js-data-adapter/src/index.js, line 59

Methods

<static> extend(instanceProps, classProps)

Alternative to ES6 class syntax for extending Adapter.

Parameters:

Name	Type	Argument	Description
`instanceProps`	Object	<optional>	Properties that will be added to the prototype of the subclass.
`classProps`	Object	<optional>	Properties that will be added as static properties to the subclass itself.

Source:

node_modules/js-data-adapter/src/index.js, line 113

Returns:

Subclass of Adapter.

Type: Object

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterCreate`

Source:

node_modules/js-data-adapter/src/index.js, line 127

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterCreateMany`

Source:

node_modules/js-data-adapter/src/index.js, line 150

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterDestroy`

Source:

node_modules/js-data-adapter/src/index.js, line 173

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterDestroyAll`

Source:

node_modules/js-data-adapter/src/index.js, line 196

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterFind`

Source:

node_modules/js-data-adapter/src/index.js, line 219

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterFindAll`

Source:

node_modules/js-data-adapter/src/index.js, line 242

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterUpdate`

Source:

node_modules/js-data-adapter/src/index.js, line 265

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterUpdateAll`

Source:

node_modules/js-data-adapter/src/index.js, line 289

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.

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`.

Properties:

Name	Type	Description
`opts.op`	string	`afterUpdateMany`

Source:

node_modules/js-data-adapter/src/index.js, line 313

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeCreate`

Source:

node_modules/js-data-adapter/src/index.js, line 336

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeCreateMany`

Source:

node_modules/js-data-adapter/src/index.js, line 356

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeDestroy`

Source:

node_modules/js-data-adapter/src/index.js, line 376

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeDestroyAll`

Source:

node_modules/js-data-adapter/src/index.js, line 394

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeFind`

Source:

node_modules/js-data-adapter/src/index.js, line 412

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeFindAll`

Source:

node_modules/js-data-adapter/src/index.js, line 430

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeUpdate`

Source:

node_modules/js-data-adapter/src/index.js, line 448

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeUpdateAll`

Source:

node_modules/js-data-adapter/src/index.js, line 469

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.

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.

Properties:

Name	Type	Description
`opts.op`	string	`beforeUpdateMany`

Source:

node_modules/js-data-adapter/src/index.js, line 490

create(mapper, props, opts)

Create a new record. Called by Mapper#create.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

props

Object

The record to be created.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

node_modules/js-data-adapter/src/index.js, line 520

Returns:

Type: Promise

createMany(mapper, props, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

props

Object

The records to be created.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

node_modules/js-data-adapter/src/index.js, line 563

Returns:

Type: Promise

dbg()

Shortcut for #log('debug'[, arg1[, arg2[, argn]]]).

Source:

node_modules/js-data-adapter/src/index.js, line 510

destroy(mapper, id, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

id

string | number

Primary key of the record to destroy.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

node_modules/js-data-adapter/src/index.js, line 609

Returns:

Type: Promise

destroyAll(mapper, query, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

the mapper.

query

Object

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

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

node_modules/js-data-adapter/src/index.js, line 648

Returns:

Type: Promise

find(mapper, id, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

id

string | number

Primary key of the record to retrieve.

opts

Object

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.

Source:

node_modules/js-data-adapter/src/index.js, line 961

Returns:

Type: Promise

findAll(mapper, query, opts)

Retrieve the records that match the selection query.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

query

Object

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

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.

Source:

node_modules/js-data-adapter/src/index.js, line 1029

Returns:

Type: Promise

getOpt(opt, opts)

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

Parameters:

Name	Type	Argument	Description
`opt`	string		The name of the option.
`opts`	Object	<optional>	Configuration options.

Source:

node_modules/js-data-adapter/src/index.js, line 1111

Returns:

The value of the specified option.

Type: *

loadBelongsTo()

Load a belongsTo relationship.

Override with care.

Source:

node_modules/js-data-adapter/src/index.js, line 919

Returns:

Type: Promise

loadHasMany()

Load a hasMany relationship.

Override with care.

Source:

node_modules/js-data-adapter/src/index.js, line 740

Returns:

Type: Promise

loadHasOne()

Load a hasOne relationship.

Override with care.

Source:

node_modules/js-data-adapter/src/index.js, line 883

Returns:

Type: Promise

log(level, values)

Logging utility method. Override this method if you want to send log messages to something other than the console.

Parameters:

Name	Type	Argument	Description
`level`	string		Log level.
`values`	*	<repeatable>	Values to log.

Source:

node_modules/js-data-adapter/src/index.js, line 1126

makeBelongsToForeignKey()

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

Override with care.

Source:

node_modules/js-data-adapter/src/index.js, line 906

Returns:

Type: *

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.

Source:

node_modules/js-data-adapter/src/index.js, line 694

Returns:

Type: *

makeHasManyForeignKeys()

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

Override with care.

Source:

node_modules/js-data-adapter/src/index.js, line 727

Returns:

Type: *

makeHasManyLocalKeys()

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

Override with care.

Source:

node_modules/js-data-adapter/src/index.js, line 710

Returns:

Type: *

respond(response, opts)

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`.

Source:

node_modules/js-data-adapter/src/index.js, line 1151

update(mapper, id, props, opts)

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

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

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

node_modules/js-data-adapter/src/index.js, line 1163

Returns:

Type: Promise

updateAll(mapper, props, query, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

props

Object

The update to apply to the selected records.

query

Object

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

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

node_modules/js-data-adapter/src/index.js, line 1207

Returns:

Type: Promise

updateMany(mapper, records, opts)

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

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

records

Array.<Object>

The records to update.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	Whether to return a more detailed response object.

Source:

node_modules/js-data-adapter/src/index.js, line 1259

Returns:

Type: Promise