https://github.com/efraespada/firebase-sync-node

Firebase synchronization without blocking the main thread (Node.js)
https://github.com/efraespada/firebase-sync-node

Last synced: 5 days ago
JSON representation

Firebase synchronization without blocking the main thread (Node.js)

• Host: GitHub
• URL: https://github.com/efraespada/firebase-sync-node
• Owner: efraespada
• Created: 2016-12-29T09:34:11.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-29T12:40:39.000Z (almost 8 years ago)
• Last Synced: 2024-10-30T04:55:37.714Z (16 days ago)
• Language: JavaScript
• Size: 11.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# firebase-sync-node

This node module works with [sync-node](https://github.com/VoidCanvas/sync-node) and allows you to instance your Firebase database as an associative array (synchronously).

```

$ npm install firebase-sync-node

```

### Information

Quick setup:

```javascript

var path      = "some/path/to/reference"                // path to reference

var database  = admin.database()                        // firebase database instance

var fireSync = new FirebaseSyncNode(database, path)     // firebase-sync-node

var queue = fireSync.getQueue()                         // database's queue 

fireSync.syncFromDatabase()                             // initial synchronization to create the reference

```

Once you have set it up, your database reference will be stored on `ref` var:

```javascript

// print database reference

queue.pushJob(function() {

    console.log(JSON.stringify(fireSync.ref))

})

```

Of course you can modify that reference:

```javascript

queue.pushJob(function() {

    fireSync.ref["some_random_prop"] = "2b or not 2b"

})

```

Call `syncToDatabase` method every time you want to sync data on Firebase.

```javascript

queue.pushJob(function() {

    fireSync.ref.name = "Draco"

})

// sync fireSync.ref variable

fireSync.syncToDatabase()     

```

Maybe you'll need some fresh data from database, so call the initial method `syncFromDatabase` to stay up to date from Firebase db:

```javascript

queue.pushJob(function() {

    fireSync.ref.name = "Draco"

})

fireSync.syncFromDatabase()

queue.pushJob(function() {

    console.log("name: " + fireSync.ref.name)   // name: John

})

```

## Example

```javascript

var admin             = require("firebase-admin")

var FirebaseSyncNode  = require('firebase-sync-node')

// firebase (SDK 3.x)

var serviceAccount = require("./some_firebase_credentials.json");

var credentials = {

    credential: admin.credential.cert(serviceAccount),

    databaseURL: "https://some_random_db.firebaseio.com/",

    databaseAuthVariableOverride: {

        uid: "lalilulelo"

    }

}

admin.initializeApp(credentials)

// let's instance a puppy from database

var path        = "puppies/draco"                         // path to reference

var database    = admin.database()                        // firebase database instance

var fireSync    = new FirebaseSyncNode(database, path)     // firebase-sync-node

var queue       = fireSync.getQueue()                      // database's queue

fireSync.syncFromDatabase()                                // initial synchronization to create the puppy reference

// add some properties to database

queue.pushJob(function() {

    fireSync.ref.color = "chocolate"

})

// let's save new data

fireSync.syncToDatabase()                               // draco is chocolate

queue.pushJob(function() {

    fireSync.ref.color = "white"

})

// let's save data again

fireSync.syncToDatabase()                               // now draco is white!

```

For more documentation about `queue` check out the original node module by [@metalshan](https://github.com/metalshan): [sync-node](https://github.com/VoidCanvas/sync-node)

(mmmm choooocolate :drooling_face:)