Model

a list of snapshots that have been taken since the record was either last persisted or since it was instantiated

Getter find the attribute definition for the model type.

Getter to just get the names of a records attributes.

current attributes of record

getter method to get the default attributes

A list of any attribute paths which have been changed since the previous snapshot

const todo = new Todo({ title: 'Buy Milk' }) todo.dirtyAttributes => Set() todo.title = 'Buy Cheese' todo.dirtyAttributes => Set('title') todo.options = { variety: 'Cheddar' } todo.dirtyAttributes => Set('title', 'options.variety')

A list of any relationship paths which have been changed since the previous snapshot We check changes to both ids and types in case there are polymorphic relationships

const todo = new Todo({ title: 'Buy Milk' }) todo.dirtyRelationships => Set() todo.note = note1 todo.dirtyRelationships => Set('note')

The canonical path to the resource on the server. Defined on the class. Defaults to the underscored version of the class name

A hash of errors from the server

todo = store.find('todos', 5)
todo.errors
=> { authorization: "You do not have access to this resource" }

Getter to check if the record has errors.

Have any changes been made since this record was last persisted?

The unique document identifier. Should not change except when persisted.

True if model attributes and relationships have been initialized

True if the instance has been modified from its persisted state

NOTE that isDirty does NOT track changes to the related objects but it does track changes to the relationships themselves.

For example, adding or removing a related object will mark this record as dirty, but changing a related object's properties will not mark this record as dirty.

The caller is reponsible for asking related objects about their own dirty state.

todo = store.add('todos', { name: 'A good thing to measure' })
todo.isDirty
=> true
todo.name
=> "A good thing to measure"
await todo.save()
todo.isDirty
=> false
todo.name = "Another good thing to measure"
todo.isDirty
=> true
await todo.save()
todo.isDirty
=> false

True if the instance is coming from / going to the server

todo = store.find('todos', 5)
// fetch started
todo.isInFlight
=> true
// fetch finished
todo.isInFlight
=> false

True if the model has not been sent to the store

the latest persisted snapshot or the first snapshot if the model was never persisted

the latest snapshot

Getter find the relationship definitions for the model type.

Getter to just get the names of a records relationships.

The reference to relationships. Is observed and used to provide references to the objects themselves

todo.relationships => { tag: { data: { type: 'tags', id: '1' } } } todo.tag => Tag with id: '1'

The current state of defined attributes and relationships of the instance Really just an alias for attributes

todo = store.find('todos', 5)
todo.title
=> "Buy the eggs"
snapshot = todo.snapshot
todo.title = "Buy the eggs and bacon"
snapshot.title
=> "Buy the eggs and bacon"

The type of the model. Defined on the class. Defaults to the underscored version of the class name (eg 'calendar_events').

shortcut to get the static

set the current attributes and relationships to the attributes and relationships of the snapshot to be applied. also reset errors

Sets _snapshots to an empty array

deletes a record from the store and server

Getter to check if the record has errors.

Initializes observable attributes and relationships

Sets initial attribute properties

Initializes relationships based on the relationships hash.

Comparison by identity returns true if this object has the same type and id as the "other" object, ignores differences in attrs and relationships

getter method to get data in api compliance format TODO: Figure out how to handle unpersisted ids

Replaces the record with the canonical version from the server.

restores data to its last persisted state or the oldest snapshot state if the model was never persisted

todo = store.find('todos', 5)
todo.name
=> "A good thing to measure"
todo.name = "Another good thing to measure"
todo.rollback()
todo.name
=> "A good thing to measure"

creates or updates a record.

take a snapshot of the current model state. if persisted, clear the stack and push this snapshot to the top if not persisted, push this snapshot to the top of the stack

restores data to its last state state if the model was never persisted

Updates attributes of this record via a key / value hash

Checks all validations, adding errors where necessary and returning false if any are not valid Default is to check all validations, but they can be selectively run via options:

• attributes - an array of names of attributes to validate
• relationships - an array of names of relationships to validate