Nitrogen Pumpkin Mulch

    fire-child

    0.1.1 • Public • Published

    FireChild

    Build Status NPM version

    A Node.js module which attaches listeners to grandchildren of a Firebase reference.

    Read more about Firebase listeners here: https://www.firebase.com/docs/web/api/query/on.html.

    Installation

    To install FireChild, run the following command:

    $ npm install fire-child

    API Reference

    FireChild

    A FireChild instance is used to add listeners to grandchild locations.

    var FireChild = require('fire-child');

    new FireChild(ref)

    Creates and returns a new FireChild instance to add listeners. Note that this ref can point to anywhere in your Firebase and can either be a string or an instance of the Firebase object.

    // Create a FireChild object
    var fireChild = new FireChild('https://<your-firebase>.firebaseio.com/');

    FireChild.on(depth, eventType, callback, [cancelCallback], [context])

    Adds a Firebase listener at the specified depth from the reference which created the FireChild.

    // Add child_added eventType to grandchildren of Firebase reference
    fireChild.on(1, 'child_added', function (childSnapshot, prevChildName) {});

    Contributing

    If you'd like to contribute to FireChild, you'll need to run the following commands to get your environment set up:

    $ git clone https://github.com/davidcaseria/FireChild.git
    cd FireChild           # go to the geofire directory 
    $ npm install -g mocha   # globally install mocha test framework 
    $ npm install            # locally install all dependencies 

    Install

    npm i fire-child

    DownloadsWeekly Downloads

    2

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • davidcaseria