Skip to content

aeroxmotion/realtime-storage

Repository files navigation

Realtime Storage

Persist your JS objects in the Web Storage.

Usage

import rs from 'realtime-storage'

const person = rs('person', {
  name: 'John',
  age: 30,
  sports: ['soccer']
})

/**
 * LocalStorage:
 *
 * KEY     |  VALUE (stringified version)
 * person  | '{ "name": "John", "age": 30, "sports": ["soccer"] }'
 */

person.name = 'Joe' // Updated storage: { "name": "John", ... }
person.sports.push('basketball') // Updated storage: { "sports": ["soccer", "basketball"], ... }

delete person.age

// Remove entry from LocalStorage
rs.remove(person)

API Reference

rs(name | options[, entry])

Creates a new realtime entry to deal with

Arguments: TODO Returns: TODO

rs.session(name[, entry])

TODO

Arguments: TODO Returns: TODO

rs.remove(entry)

Remove realtime entry from WebStorage

Arguments: TODO Returns: TODO

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published