https://github.com/rootslab/cucu
Cucu, a tiny module to schedule repeated execution of ( single process ) methods/tasks.
https://github.com/rootslab/cucu
nodejs process-scheduler
Last synced: 7 days ago
JSON representation
Cucu, a tiny module to schedule repeated execution of ( single process ) methods/tasks.
- Host: GitHub
- URL: https://github.com/rootslab/cucu
- Owner: rootslab
- License: mit
- Created: 2014-07-28T04:29:55.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-02-10T14:40:34.000Z (over 7 years ago)
- Last Synced: 2025-05-12T23:44:37.061Z (7 days ago)
- Topics: nodejs, process-scheduler
- Language: JavaScript
- Size: 35.2 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
### Cucu
[](https://www.npmjs.org/package/cucu)
[](https://www.codacy.com/public/44gatti/cucu)
[](https://codeclimate.com/github/rootslab/cucu)
[](https://github.com/rootslab/cucu#mit-license)
[](http://travis-ci.org/rootslab/cucu)
[](https://david-dm.org/rootslab/cucu)
[](https://david-dm.org/rootslab/cucu#info=devDependencies)
[](http://npm-stat.com/charts.html?package=cucu)
[](https://nodei.co/npm/cucu/)
> **_Cucu_**, a tiny module to schedule repeated execution of ( single process ) methods/tasks.
### Install
```bash
$ npm install cucu [-g]
```
> __require__:
```javascript
var Cucu = require( 'cucu' );
```
### Run Tests
```bash
$ cd cucu/
$ npm test
```
### Constructor
```javascript
Cucu()
// or
new Cucu()
```
### Properties
```javascript
/*
* The current number of running tasks.
*/
Cucu.running : Number
/*
* Task table, an obj/hash containing tasks by id/key/name.
*
* A table entry for a task named 'id' is an obj/hash like:
*
* ttable[ 'id' ] = {
* id : 'id'
* , fn : fn
* , interval : Number
* , args : Array
* , scope : Object
* , status : Number | Object
* , repeat : Number
* // timestamps for task start, current iteration and task stop/halt/end.
* , stime : Number
* , itime : Number
* , etime : Number
* // get task time infos
* , timetable : Function
* // Cucu method shortcuts
* , run : Function
* , stop : Function
* , del : Function
* };
*
* NOTE: Every entry contains shortcuts to Cucu#run, #stop and #del methods, already
* curried with their own ids. For example, if exists a task named 'dumb' in the task
* table, you could also use the methods below, for running, stopping or deleting an
* existing task:
*
* Cucu.ttable.dumb.run( [ Number interval [, Array args [, Number times ] ] ] ) : Number
*
* Cucu.ttable.dumb.stop() : Array
*
* Cucu.ttable.dumb.del() : Array
*
*
*/
Cucu.ttable : Object
```
### Methods
> Arguments within [ ] are optional.
```javascript
/*
* Add a task; a task will be added only if there is no other task already running
* with this name/id.
* It returns 1 if task is added, 0 if the same task id is already running, -1 if
* an error occurs.
*/
Cucu#add( String id, Function fn [, Array args [, Object scope [, Number interval ] ] ] ) : Number
/*
* Run a task by name/id. Optionally you can specify interval, function arguments and
* the max number executions for a task.
* It returns 1 if task is started, 0 if the task is already running, -1 if no task
* exists.
*
* NOTE: if 'times' option is specified, the scheduled function 'fn' will get, as the
* first argument, a function to execute when task will be done.
*/
Cucu#run( String id [, Number interval [, Array args [, Number times ] ] ] ) : Number
/*
* Remove tasks by id/name; a task will be removed only if it is not currently running.
* It returns a list of ids/names for all the removed tasks.
*/
Cucu#del( String id | Array ids ) : Array
/*
* Stop a running method/task by name/id.
* It returns a list of ids/names for all the stopped tasks.
*/
Cucu#stop( String id | Array ids ) : Number
/*
* Start all non-running tasks.
* It returns the total number of non-running tasks started.
*/
Cucu#awake() : Number
/*
* Halt all running tasks.
* It returns a list of ids/names for all the stopped tasks.
*/
Cucu#halt() : Array
/*
* Stop and delete all tasks.
* It returns the list of ids/names for all the removed tasks.
*/
Cucu#flush() : Array
/*
* Get a list of names/ids for all the currently active/running tasks.
*/
Cucu#active() : Array
/*
* It returns the total number of tasks.
*/
Cucu#size() : Number
```
### MIT License
> Copyright (c) 2014-present < Guglielmo Ferri : [email protected] >
> Permission is hereby granted, free of charge, to any person obtaining
> a copy of this software and associated documentation files (the
> 'Software'), to deal in the Software without restriction, including
> without limitation the rights to use, copy, modify, merge, publish,
> distribute, sublicense, and/or sell copies of the Software, and to
> permit persons to whom the Software is furnished to do so, subject to
> the following conditions:
> __The above copyright notice and this permission notice shall be
> included in all copies or substantial portions of the Software.__
> THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
> IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
> CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
> TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.