presentation-forage-models

Augmented.js Presentation LocalForage Models

API

Table of Contents

• LocalForageCollection
  • Parameters
  • key
    • Properties
  • initialize
    • Parameters
  • init
    • Parameters
  • fetch
    • Parameters
  • save
    • Parameters
  • update
    • Parameters
  • destroy
    • Parameters
  • sync
    • Parameters
• LocalForageModel
  • Parameters
  • sync
    • Parameters
  • fetch
    • Parameters
  • save
    • Parameters
  • update
    • Parameters
  • destroy
    • Parameters
• LocalForage
  • Parameters
  • isSupported
  • getItem
    • Parameters
  • setItem
    • Parameters
  • removeItem
    • Parameters
  • clear
  • key
    • Parameters
  • keys
  • length

LocalForageCollection

Extends AbstractCollection

LocalForageCollection

Parameters

• models
• options (optional, default {})

key

Base key name for the collection (simular to url for rest-based)

Properties

• key string The key

initialize

Initialize the model with needed wireing

Parameters

• options object Any options to pass

init

Custom init method for the model (called at inititlize)

Parameters

• options object Any options to pass

fetch

Fetch the collection

Parameters

• options object Any options to pass

save

Save the collection

Parameters

• options object Any options to pass

update

Update the collection

Parameters

• options object Any options to pass

destroy

Destroy the collection

Parameters

• options object Any options to pass

sync

Sync method for Collection

Parameters

• method
• model
• options

LocalForageModel

Extends AbstractModel

Model

Parameters

• attributes
• options (optional, default {})
• args ...any

sync

sync - Sync model data to bound localforage

Parameters

• method

fetch

Fetch the model

Parameters

• options object Any options to pass

save

Save the model

Parameters

• options object Any options to pass

update

Update the model

Parameters

• options object Any options to pass

destroy

Destroy the model

Parameters

• options object Any options to pass

LocalForage

• **See: LocalForage Config **

LocalForage API

Parameters

• config Object Config the base storage library

isSupported

Is storage supported

Returns boolean Returns true if supported

getItem

Gets an item from storage

Parameters

• itemKey
• key string The key in storage

Returns object Returns object from storage

setItem

Sets an item to storage

Parameters

• itemKey
• object object The data to set
• key string The key in storage

removeItem

Removes an item from storage

Parameters

• itemKey
• key string The key in storage

clear

Clears storage

key

Gets the key from storage for index

Parameters

• i number The index in storage

Returns string Returns the key from storage

keys

Gets the keya from storage

Returns array Returns the keys from storage

length

The length of storage by keys

Returns number Returns the length of storage by keys