Class: Record

import {Record} from 'js-data'

Extends

• Component

Methods

---

afterLoadRelations(relations, opts)

TODO

Parameters:

Name	Type	Description
relations	Array.<string>	TODO
opts	Object	TODO

Source:

• Record.js, line 72

---

afterSave(opts)

TODO

Parameters:

Name	Type	Description
opts	Object	TODO

Source:

• Record.js, line 82

---

beforeLoadRelations(relations, opts)

TODO

Parameters:

Name	Type	Description
relations	Array.<string>	TODO
opts	Object	TODO

Source:

• Record.js, line 91

---

beforeSave(opts)

TODO

Parameters:

Name	Type	Description
opts	Object	TODO

Source:

• Record.js, line 101

---

changes(opts)

Return changes to this record since it was instantiated or Record#commit was called.

Parameters:

Name	Type	Argument	Description
opts		<optional>	Configuration options. Properties Name Type Argument Description equalsFn function <optional> Equality function. Default uses ===. ignore Array <optional> Array of strings or RegExp of fields to ignore.

Source:

• Record.js, line 110

---

commit()

TODO

Source:

• Record.js, line 126

---

create(opts)

TODO

Parameters:

Name	Type	Argument	Description
opts	Object	<optional>	Configuration options. See Mapper#create.

Source:

• Record.js, line 139

---

dbg()

Inherited From:

• Component#dbg

Source:

• Component.js, line 27

---

destroy(opts)

TODO

Parameters:

Name	Type	Argument	Description
opts	Object	<optional>	Configuration options. @see Model.destroy.

Source:

• Record.js, line 150

---

get(key)

Return the value at the given path for this instance.

Parameters:

Name	Type	Description
key	string	Path of value to retrieve.

Source:

• Record.js, line 163

Returns:

Value at path.

Type

*

---

hasChanges(opts)

Return whether this record has changed since it was instantiated or Record#commit was called.

Parameters:

Name	Type	Argument	Description
opts		<optional>	Configuration options. Properties Name Type Argument Description equalsFn function <optional> Equality function. Default uses ===. ignore Array <optional> Array of strings or RegExp of fields to ignore.

Source:

• Record.js, line 175

---

hashCode()

TODO

Source:

• Record.js, line 191

---

loadRelations(relations, opts)

TODO

Parameters:

Name	Type	Argument	Description
relations	Array.<string>	<optional>	TODO
opts	Object	<optional>	TODO

Source:

• Record.js, line 207

---

log()

Inherited From:

• Component#log

Source:

• Component.js, line 31

---

previous(key)

TODO

Parameters:

Name	Type	Argument	Description
key	string	<optional>	TODO

Source:

• Record.js, line 288

---

revert(opts)

TODO

Parameters:

Name	Type	Argument	Description
opts	Object	<optional>	Configuration options.

Source:

• Record.js, line 303

---

save(opts)

Delegates to Mapper#update.

Parameters:

Name	Type	Argument	Description
opts	Object	<optional>	Configuration options. See Mapper#create.

Source:

• Record.js, line 329

---

set(key, value, opts)

Set the value for a given key, or the values for the given keys if "key" is an object.

Parameters:

Name	Type	Argument	Description
key	string | Object		Key to set or hash of key-value pairs to set.
value	*	<optional>	Value to set for the given key.
opts	Object	<optional>	Optional configuration. Properties Name Type Argument Default Description silent boolean <optional> false Whether to trigger change events.

Source:

• Record.js, line 342

---

toJSON(opts)

Return a plain object representation of this record. If the class from which this record was created has a mapper, then Mapper#toJSON will be called instead.

Parameters:

Name	Type	Argument	Description
opts	Object	<optional>	Configuration options. Properties Name Type Argument Description with Array.<string> <optional> Array of relation names or relation fields to include in the representation. Only available as an option if the class from which this record was created has a mapper.

Source:

• Record.js, line 370

Returns:

Plain object representation of this record.

Type

Object

---

unset(key, opts)

Unset the value for a given key.

Parameters:

Name	Type	Argument	Description
key	string		Key to unset.
opts	Object	<optional>	Optional configuration. Properties Name Type Argument Default Description silent boolean <optional> false Whether to trigger change events.

Source:

• Record.js, line 396