purr
Make your application purr. Add audio when functions and properties get called.
Install
npm install purr
Purpose
A module that allows you to make sounds when methods get called or error. Can be used with CLI's or any other modules you are working with.
This module is a scarlet plugin, and uses events on method calls to play sounds.
Examples
When a objects function is called, make a purr sound
var Scarlet = ;var scarlet = 'purr';var purr = scarletpluginspurr; purr; Math;//-> a purring sound will now be played on your speakers
When a objects function is called make a sound using the predefined sounds
var Scarlet = ;var scarlet = 'purr';var purr = scarletpluginspurr; purr; Math;//-> a bomb sound will now be played on your speakers
When a objects function is called call some sound file on your computer
var Scarlet = ;var scarlet = 'purr';var purr = scarletpluginspurr; purr; Math;//-> a sound will now be played on your speakers
When a function instance is called make a purr sound
var Scarlet = ;var scarlet = 'purr';var purr = scarletpluginspurr; { this{}; this{};};var instance = ;purr; instance;//-> a purring sound will now be played on your speakers instance;//-> a purring sound will now be played on your speakers
When a function instance errors make a sound
var Scarlet = ;var scarlet = 'purr';var purr = scarletpluginspurr; { this{throw "some error"};};var instance = ;purr; instance;//-> a bomb sound will now be played on your speakers//-> because the method threw an error
When a function is called make a purr sound
var Scarlet = ;var scarlet = 'purr';var purr = scarletpluginspurr; {};anyFunction = purr; ;//-> a purring sound will now be played on your speakers
Api
Available Sounds
purr provides a couple of sounds, but can be easily set to use any sound given a path
Sounds:
- moo
- purr
- beep
- bomb
- donkey
Getting Started with this plugin
This plugin requires Scarlet ~0.5.11
If you haven't used Scarlet before, be sure to check out the Documentation. To use this plugin perform the following:
Install scarlet
npm install scarlet --save
Install plugin
npm install purr --save
Once the plugin has been installed, you can use it in your application as follows:
//load scarletvar Scarlet = ; //Initialize scarlet with the pluginvar scarlet = 'purr';var purr = scarletpluginspurr;