Yes.js

JavaScript clone of *nix's `yes` command.

Download as .zip Download as .tar.gz View on GitHub

yes.js NPM version

(c) 2013 Robert Bost

Author: Robert Bost

Overview: JavaScript port of *nix command Yes.

Yes.js is basically a wrapper around the setInterval and clearInterval JavaScript functions. Yes.js makes it a little easier to manage repeating interval calls.

See README.md for examples.

class Yes

Methods

Yes.yes(callback, arg, interval)

Calls the given callback on the given interval. The given arg passed into the callback on the given interval. If the callback returns false then the repeating interval will be canceled.

Parameters

callback: function, This will be called on the given interval.

arg: any, This argument will be passed into the callback.

interval: int, The interval in milliseconds to call the callback.

Returns

int, ID for this yes call. Use this ID when calling Yes.kill.

Yes.kill(id)

Kills a repeating interval with the given ID. If ID is false, null, undefined, or empty string then all repeating intervals that were started with calls to Yes.yes will be killed.

have kept this ID when calling Yes.yes.

Parameters

id: int, The ID of the interval you wish to cancel. You should