fireaction

Easy copy and move actions within a firebase database

I simply got tired of rewriting the same copy (and remove) code for every firebase project.

Installation

npm install --save fireaction yarn add fireaction

For browsers, use the build in dist/fireaction.js

Usage

In nodejs:

var Fireaction = require ( ' fireaction ' ) const ref = firebase . database ( ) . ref ( ) const fireaction = new Fireaction ( ref ) fireaction . copy ( src , dest , function ( err , data ) { } ) fireaction . copy ( src , dest ) . then ( function ( sourceData ) { } )

Options

Fireaction copy and move methods can take in a third object argument instead of a callback:

const options = { withKey : true } fireaction ( src , dest , options , callback )

Option Type (default) Description withKey boolean (true) Copies parent key with value into destination path override boolean (false) Overrides existing data in destination path

Running Tests

npm run lint : runs the linter (standard)

: runs the linter (standard) npm run unit : runs the unit tests

: runs the unit tests npm test : runs both the linter and the tests

Creating a build for browser

Build is run by webpack, so install dependencies:

npm install yarn

Then run build:

npm run build

NB: It is better to build using npm start which will lint and test before building.

Contributing

To contribute:

Take a look at existing issues.

Create fixes/updates.

Write tests.

Lint, run tests and build.

Send detailed PR.

License

Licensed under MIT

Copyright (c) 2017 ghostffcode