Giter VIP home page Giter VIP logo

boco-cached-firebase's Introduction

boco-cached-firebase

Fully-offline cached objects that sync to firebase references.

Installation

npm install boco-cached-firebase

Usage

# Requires
Firebase = require 'firebase'
CachedFirebase = require 'boco-cached-firebase'

# Initialize your firebase application
Firebase.initializeApp
  apiKey: "<API_KEY>",
  authDomain: "<PROJECT_ID>.firebaseapp.com",
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com",

# Initialize the cache
LocalStorage = require 'node-localstorage'

cache = new CachedFirebase.DomCache
  localStorage: new LocalStorage('./storage')
  localStorageKey: 'cached-firebase'
  # - for browsers just use localstorage: window.localStorage

# Create an object factory
objectFactory = new CachedFirebase.CachedObjectFactory
  cache: cache
  firebaseDb: Firebase.database()

# Create a cached firebase object
myObject = objectFactory.create '/path/to/myObject'

# Watch the object for changes.
# Once watched, a cached object  will automatically sync changes
# and data will be available from the cache when fully offline
onValue = (newValue) ->
  console.log 'myObject value:', newValue

myObject.watch onValue

# All 'error' events are emitted by the watched object
myObject.on 'error', (error) ->
  console.error error

# If you lose rights to the data, a 'cancel' event is emitted
myObject.on 'cancel', (cancelError) ->
  console.error error

# When finished with this object you may call unwatch
# to remove all 'change' event listeners
myObject.unwatch()

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.