gqonoff

                                      _____  _____ 
   ____    ______ ____   ____   _____/ ____\/ ____\
  / ___\  / ____//  _ \ /    \ /  _ \   __\\   __\ 
 / /_/  >< <_|  (  <_> )   |  (  <_> )  |   |  |   
 \___  /  \__   |\____/|___|  /\____/|__|   |__|   
/_____/      |__|           \/                     

Description

• This is a common scenario: when you have 100 commits in your code, some of these commits need to be taken out. But if you take out the code directly, it ended up crashing the whole code. But if you overwrite the code, it takes a longer time to patch the crash than the time it took to code in the first place.

• Introducing gqonoff. An utility for handling toggling a code logic in and out of execution on demand. It allows an offFunction to execute when code is choose to be off and make sure code to not crash.

Getting Started

Dependencies

• no dependency

Installing

• npm i --save gqonoff

Executing program

• how to use:

gqonoff=require("gqonoff")
gqonoff(onFunction, offFunction, choose, o, cb)

* put your normal function in onFunction
* put your non crashing off route in offFunction. This allows code to not crash even if the commit is off
* put your on/off choice in choose. Normally, you will need an ini file to configure each commit choose on or off. Then just reference the config in 'choose' argument
* o is options/data pass-in
* cb is a common callback called in both on and off route

onfn=(o,cb)->
  l "on function is ran"
  cb(null,true)

offfn=(o,cb)->
  l "off function is ran"
  cb(null,false)

f "should be able to choose on",(done)->
  gqonoff onfn,offfn,true,{},(e,r)->
    done(!r)

* gqonoff will run onfn, it will print "on function is ran", then cb(null,true). 
* Then (e,r) will be (null,true). done(!r) will be done(false) which will be a successful case in test

Authors

• glidev5

Version History

• 0.0.1
  • Initial Release

License

This project is licensed under the MIT License - see the LICENSE.md file for details