Class: LocalStorageAdapter

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:

• js-data-localstorage/src/index.js, line 1097

---

basePath :string

TODO

Type:

• string

Source:

• js-data-localstorage/src/index.js, line 102

---

debug :boolean

TODO

Type:

• boolean

Default Value:

• false

Source:

• js-data-localstorage/src/index.js, line 110

---

storage :Object

TODO

Type:

• Object

Default Value:

• localStorage

Source:

• js-data-localstorage/src/index.js, line 119

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:

• js-data-localstorage/src/index.js, line 150

Returns:

Subclass of LocalStorageAdapter.

Type

Object

---

afterCreate()

Source:

• js-data-localstorage/src/index.js, line 164

---

afterCreateMany()

Source:

• js-data-localstorage/src/index.js, line 170

---

afterDEL()

Source:

• js-data-localstorage/src/index.js, line 176

---

afterDestroy()

Source:

• js-data-localstorage/src/index.js, line 182

---

afterDestroyAll()

Source:

• js-data-localstorage/src/index.js, line 188

---

afterFind()

Source:

• js-data-localstorage/src/index.js, line 194

---

afterFindAll()

Source:

• js-data-localstorage/src/index.js, line 200

---

afterGET()

Source:

• js-data-localstorage/src/index.js, line 206

---

afterPUT()

Source:

• js-data-localstorage/src/index.js, line 212

---

afterUpdate()

Source:

• js-data-localstorage/src/index.js, line 218

---

afterUpdateAll()

Source:

• js-data-localstorage/src/index.js, line 224

---

afterUpdateMany()

Source:

• js-data-localstorage/src/index.js, line 230

---

beforeCreate()

Source:

• js-data-localstorage/src/index.js, line 236

---

beforeCreateMany()

Source:

• js-data-localstorage/src/index.js, line 242

---

beforeDEL()

Source:

• js-data-localstorage/src/index.js, line 248

---

beforeDestroy()

Source:

• js-data-localstorage/src/index.js, line 254

---

beforeDestroyAll()

Source:

• js-data-localstorage/src/index.js, line 260

---

beforeFind()

Source:

• js-data-localstorage/src/index.js, line 266

---

beforeFindAll()

Source:

• js-data-localstorage/src/index.js, line 272

---

beforeGET()

Source:

• js-data-localstorage/src/index.js, line 278

---

beforePUT()

Source:

• js-data-localstorage/src/index.js, line 284

---

beforeUpdate()

Source:

• js-data-localstorage/src/index.js, line 290

---

beforeUpdateAll()

Source:

• js-data-localstorage/src/index.js, line 296

---

beforeUpdateMany()

Source:

• js-data-localstorage/src/index.js, line 302

---

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false TODO

Source:

• js-data-localstorage/src/index.js, line 308

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false TODO

Source:

• js-data-localstorage/src/index.js, line 356

Returns:

Type

Promise

---

dbg()

Source:

• js-data-localstorage/src/index.js, line 407

---

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false TODO

Source:

• js-data-localstorage/src/index.js, line 415

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	<optional>	Configuration opts. Properties Name Type Argument Default Description raw boolean <optional> false TODO

Source:

• js-data-localstorage/src/index.js, line 458

Returns:

Type

Promise

---

ensureId()

TODO

Source:

• js-data-localstorage/src/index.js, line 512

---

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false TODO with Array.<string> <optional> [] TODO

Source:

• js-data-localstorage/src/index.js, line 533

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false TODO with Array.<string> <optional> [] TODO

Source:

• js-data-localstorage/src/index.js, line 648

Returns:

Type

Promise

---

getIdPath()

TODO

Source:

• js-data-localstorage/src/index.js, line 827

---

getIds()

TODO

Source:

• js-data-localstorage/src/index.js, line 838

---

getPath()

TODO

Source:

• js-data-localstorage/src/index.js, line 816

---

log()

TODO

Source:

• js-data-localstorage/src/index.js, line 856

---

removeId()

TODO

Source:

• js-data-localstorage/src/index.js, line 878

---

saveKeys()

TODO

Source:

• js-data-localstorage/src/index.js, line 899

---

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false TODO

Source:

• js-data-localstorage/src/index.js, line 915

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:

• js-data-localstorage/src/index.js, line 970

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	<optional>	Configuration options. Properties Name Type Argument Default Description raw boolean <optional> false TODO

Source:

• js-data-localstorage/src/index.js, line 1030

Returns:

Type

Promise