js-data-localstorage Class: LocalStorageAdapter

new LocalStorageAdapter(opts)

LocalStorageAdapter class.

Parameters:

Name Type Argument Description

opts

Object

Configuration opts.

Properties

Name	Type	Argument	Default	Description
`basePath`	string	<optional>	''	TODO
`debug`	boolean	<optional>	false	TODO
`storeage`	Object	<optional>	localStorage	TODO

Source:

index.js, line 138

Example

import {DataStore} from 'js-data'
import LocalStorageAdapter from 'js-data-localstorage'
const store = new DataStore()
const adapter = new LocalStorageAdapter()
store.registerAdapter('ls', adapter, { 'default': true })

Members

<static> version :Object

Details of the current version of the js-data-localstorage module.

Type:

Object

Properties:

Name	Type	Description
`version.full`	string	The full semver value.
`version.major`	number	The major version number.
`version.minor`	number	The minor version number.
`version.patch`	number	The patch version number.
`version.alpha`	string \| boolean	The alpha version value, otherwise `false` if the current version is not alpha.
`version.beta`	string \| boolean	The beta version value, otherwise `false` if the current version is not beta.

Source:

index.js, line 1056

basePath :string

TODO

Type:

string

Source:

index.js, line 102

debug :boolean

TODO

Type:

boolean

Default Value:

false

Source:

index.js, line 110

returnDeletedIds :boolean

TODO

Type:

boolean

Default Value:

false

Source:

index.js, line 119

storage :Object

TODO

Type:

Object

Default Value:

localStorage

Source:

index.js, line 128

Methods

<static> extend(instanceProps, classProps)

Alternative to ES6 class syntax for extending LocalStorageAdapter.

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:

index.js, line 159

Returns:

Subclass of LocalStorageAdapter.

Type: Object

afterCreate()

Source:

index.js, line 173

afterCreateMany()

Source:

index.js, line 179

afterDestroy()

Source:

index.js, line 185

afterDestroyAll()

Source:

index.js, line 191

afterFind()

Source:

index.js, line 197

afterFindAll()

Source:

index.js, line 203

afterUpdate()

Source:

index.js, line 209

afterUpdateAll()

Source:

index.js, line 215

afterUpdateMany()

Source:

index.js, line 221

beforeCreate()

Source:

index.js, line 227

beforeCreateMany()

Source:

index.js, line 233

beforeDestroy()

Source:

index.js, line 239

beforeDestroyAll()

Source:

index.js, line 245

beforeFind()

Source:

index.js, line 251

beforeFindAll()

Source:

index.js, line 257

beforeUpdate()

Source:

index.js, line 263

beforeUpdateAll()

Source:

index.js, line 269

beforeUpdateMany()

Source:

index.js, line 275

create(mapper, props, opts)

Create a new record.

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	TODO

Source:

index.js, line 301

Returns:

Type: Promise

createMany(mapper, props, opts)

Create multiple records in a single batch.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

props

Array

Array of records to be created.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	TODO

Source:

index.js, line 341

Returns:

Type: Promise

dbg()

Source:

index.js, line 383

destroy(mapper, id, opts)

Destroy the record with the given primary key.

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	TODO

Source:

index.js, line 391

Returns:

Type: Promise

destroyAll(mapper, query, opts)

Destroy the records that match the selection query.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

query

Object

Selection query.

opts

Object

Configuration opts.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	TODO

Source:

index.js, line 442

Returns:

Type: Promise

ensureId()

TODO

Source:

index.js, line 498

find(mapper, id, opts)

Retrieve the record with the given primary key.

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	TODO
`with`	Array.<string>	<optional>	[]	TODO

Source:

index.js, line 519

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.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	TODO
`with`	Array.<string>	<optional>	[]	TODO

Source:

index.js, line 619

Returns:

Type: Promise

getIdPath()

TODO

Source:

index.js, line 772

getIds()

TODO

Source:

index.js, line 783

getPath()

TODO

Source:

index.js, line 761

getRaw()

TODO

Source:

index.js, line 801

log()

TODO

Source:

index.js, line 812

removeId()

TODO

Source:

index.js, line 834

saveKeys()

TODO

Source:

index.js, line 855

update(mapper, id, props, opts)

Update the records that match the selection query. If a record with the specified primary key cannot be found then no update is performed and the promise is resolved with undefined.

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	TODO

Source:

index.js, line 871

Returns:

Type: Promise

updateAll(mapper, props, query, opts)

Update the records that match the selection query.

Parameters:

Name	Type	Argument	Description
`mapper`	Object		The mapper.
`props`	Object		The update to apply to the selected records.
`query`	Object		Selection query.
`opts`	Object	<optional>	Configuration options.

Source:

index.js, line 929

Returns:

Type: Promise

updateMany(mapper, records, opts)

Update the given records in a single batch.

Parameters:

Name Type Argument Description

mapper

Object

The mapper.

records

Object

The records to update.

opts

Object

Configuration options.

Properties

Name	Type	Argument	Default	Description
`raw`	boolean	<optional>	false	TODO

Source:

index.js, line 989

Returns:

Type: Promise