No description, website, or topics provided.
JavaScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
README.md
gulpfile.js
index.js
package.json

README.md

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 = require('scarlet');
var scarlet = new Scarlet('purr');
var purr = scarlet.plugins.purr;

purr.when(Math,'min').play();

Math.min(1,2,3);
//-> 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 = require('scarlet');
var scarlet = new Scarlet('purr');
var purr = scarlet.plugins.purr;

purr.when(Math,'min').play('bomb');

Math.min(1,2,3);
//-> 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 = require('scarlet');
var scarlet = new Scarlet('purr');
var purr = scarlet.plugins.purr;

purr.when(Math,'min').play('/home/user/myCustomSoundFile.wav');

Math.min(1,2,3);
//-> a sound will now be played on your speakers

When a function instance is called make a purr sound

var Scarlet = require('scarlet');
var scarlet = new Scarlet('purr');
var purr = scarlet.plugins.purr;

function FunctionObject(){
	this.anyFunction = function(){};
	this.anyFunction2 = function(){};
};
var instance = FunctionObject();
purr.when(instance).play();

instance.anyFunction();
//-> a purring sound will now be played on your speakers

instance.anyFunction2();
//-> a purring sound will now be played on your speakers

When a function instance errors make a sound

var Scarlet = require('scarlet');
var scarlet = new Scarlet('purr');
var purr = scarlet.plugins.purr;

function FunctionObject(){
	this.anyFunction = function(){throw new Error("some error")};
};
var instance = FunctionObject();
purr.whenError(instance).play('bomb');

instance.anyFunction();
//-> 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 = require('scarlet');
var scarlet = new Scarlet('purr');
var purr = scarlet.plugins.purr;

function anyFunction(){};
anyFunction = purr.when(anyFunction).play();

anyFunction();
//-> 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 ~2.0.x

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 scarlet
var Scarlet = require('scarlet');

//Initialize scarlet with the plugin
var scarlet = new Scarlet('purr');
var purr = scarlet.plugins.purr;