API Docs for: 1.0.1
Show:

Store Class

Defined in: src/client/store.js:233
Module: Client

Store consumer

Constructor

Store

()

Defined in src/client/store.js:233

Methods

__configure

(
  • options
)
Boolean

Defined in src/client/store.js:557

Apply general options - default / fallback

Parameters:

  • options Object

    A configure object

Returns:

Boolean:

Returns true on success

all

() Boolean

Defined in src/client/store.js:370

Retrieves all items

Returns:

Boolean:

Returns true on success

configure

() Boolean

Defined in src/client/store.js:496

Instance configuration

Returns:

Boolean:

Returns true on success

create

() Boolean

Defined in src/client/store.js:519

Create instance / new item (bound to datastore)

Returns:

Boolean:

Returns true on success

extend

() Boolean

Defined in src/client/store.js:569

one-dimensional object merge *

Returns:

Boolean:

Returns true on success

filter

() Boolean

Defined in src/client/store.js:486

Filter list - TODO: implement

Returns:

Boolean:

Returns true on success

get

(
  • |
)
Boolean

Defined in src/client/store.js:465

Retrieve item

Parameters:

  • | Object

    {String} item object reference or string uuid

Returns:

Boolean:

Returns true on success

get

(
  • property
)
Boolean

Defined in src/client/store.js:335

Get item property

Parameters:

  • property String

    key

Returns:

Boolean:

Returns true on success

guid

(
  • separator
)
String

Defined in src/client/store.js:598

Generate GUID

Parameters:

  • separator Object

    (defaults to dash)

Returns:

String:

GUID

item

() Boolean

Defined in src/client/store.js:509

Item accessor *

Returns:

Boolean:

Returns true on success

list

() Boolean

Defined in src/client/store.js:476

Retrieves all items

Returns:

Boolean:

Returns true on success

remove

() Boolean

Defined in src/client/store.js:455

Remove item

Returns:

Boolean:

Returns true on success

remove

(
  • callback
)
Boolean

Defined in src/client/store.js:357

Remove item

Parameters:

  • callback Function

    *

Returns:

Boolean:

Returns true on success

schema

() Object

Defined in src/client/store.js:542

JSON schema getter/setter

Returns:

Object:

object

serialize

(
  • params
)
String

Defined in src/client/store.js:640

Stringify object structure (deep!) into url

Parameters:

  • params Object

Returns:

String:

Example:

(borrowed from: http://stackoverflow.com/a/9472534)

// helpers var serialized, data = {a: 1, b: 2, c: {d: 4, e: [6, 7, 8], f: {asdf: 10}}};

// transform serialized = Store.serialize(data);

// verify console.log(serialized, serialized === "a=1&b=2&c[d]=4&c[e][0]=6&c[e][1]=7&c[e][2]=8&c[f][asdf]=10");

set

(
  • property
  • property
)
Boolean

Defined in src/client/store.js:319

Set item property

Parameters:

  • property String

    key

  • property String

    value

Returns:

Boolean:

Returns true on success

times

(
  • times
)
String

Defined in src/client/store.js:616

Convenience iteration helper

Parameters:

  • times Integer

Returns:

String:

GUID

times

(
  • callback
)
Promise

Defined in src/client/store.js:629

Convenience deferred wrapper

Parameters:

  • callback Function

Returns:

Promise:

update

() Boolean

Defined in src/client/store.js:443

Insert/update item

Returns:

Boolean:

Returns true on success

update

(
  • callback
)
Boolean

Defined in src/client/store.js:346

Persist item

Parameters:

  • callback Function

    *

Returns:

Boolean:

Returns true on success

wrap

(
  • {String}
)
Object

Defined in src/client/store.js:582

Passthrough if item is object. If type is string ยป wrapped into Item instance with id set to item

Parameters:

  • {String} Object

    item Instance or UUID

Returns:

Object:

Returns item object

Properties

api

Object private

Defined in src/client/store.js:384

Interface *

cache

Object

Defined in src/client/store.js:416

LRU cache * - TODO: implement

Default: {}

data

Object private

Defined in src/client/store.js:310

Object's Datastore

datastore

Object private

Defined in src/client/store.js:301

Store-Reference

Item

Function private

Defined in src/client/store.js:278

Repository Item

Item.constructor

Object private

Defined in src/client/store.js:292

Item.constructor

items

Array

Defined in src/client/store.js:425

Items collection

Default: []

options

Object public

Defined in src/client/store.js:258

Configuration options

Default: {}

options

Object

Defined in src/client/store.js:249

Store configuration

Default: {}

prototype

Object

Defined in src/client/store.js:408

Store prototype definition

repository

Repository private

Defined in src/client/store.js:268

Repository

Default: new Remote()

schema

Object

Defined in src/client/store.js:434

JSON Schema *

Default: null

self

Object private

Defined in src/client/store.js:240

Self-Reference