qyu 3.0.0 | Documentation

qyu

3.0.0

Qyu ▸
- Instance members
- #push
- #pause
- #start
- Events
- ⓔ stats
- ⓔ error
- ⓔ done
- ⓔ drain
RateLimiter ▸
- Instance members
- #jobStarted
- #jobEnded
- #canRunMore
- #waitForDrain
- Events
- ⓔ stats
- ⓔ drain

Need help reading this?

Qyu

Holds, controls and reports on execution of a queue of asynchronous jobs.

new Qyu(opts: any)

Extends EventEmitter

Parameters

opts (any)

Instance Members

▸ push(job, opts)

Add a job to this queue, and runs it if queue was started.

push(job: Function, opts: Object): Promise

Parameters

job (Function) is a function returning a promise to indicate when the job is done

opts (Object)

Name	Description
opts.priority `number`	from 1 to 10, 1 being the highest priority

Returns

Promise: A promise that resolves with {jobId, jobResult}

▸ pause()

Pause all running jobs of this queue.

pause(): Promise

Returns

Promise: A promise that resolves when the queue has paused (no jobs being processed)

▸ start()

Start running jobs of this queue.

start(): Promise

Returns

Promise: A promise that resolves when the queue has started (first time) or unpaused

Events

▸ stats

Fired every opts.statsInterval milliseconds, to tell how many jobs are processed per second.

stats

Properties

nbJobsPerSecond (number) : number of jobs that are processed per second

▸ error

Fired every time a job fails by throwing an error.

error

Properties

jobId (number) : identifier of the job that throwed the error

error (Error) : error object throwed by the job

▸ done

Fired every time a job's execution has ended succesfully.

done

Properties

jobId (number) : identifier of the job which execution ended

jobResult (any) : return value of the job function

res (any) : TBD

▸ drain

Fired when no more jobs are to be run.

drain

RateLimiter

Counts jobs per second to provide stats and commit to rating limit.

new RateLimiter(opts: any)

Extends EventEmitter

Parameters

opts (any)

Instance Members

▸ jobStarted()

Informs the RateLimiter that a job has just started

jobStarted()

▸ jobEnded()

Informs the RateLimiter that a job has just ended

jobEnded()

▸ canRunMore()

determines whether or not it's possible to start another job now, according to rate limits.

canRunMore(): any

Returns

any: true if it's possible to start another job now

▸ waitForDrain()

waitForDrain(): any

Returns

any: a promise that resolves when all jobs ended running.

Events

▸ stats

Fired every opts.statsInterval milliseconds, to tell how many jobs are processed per second.

stats

Properties

nbJobsPerSecond (number) : number of jobs that are processed per second

▸ drain

Fired every when RateLimiter is not running any jobs.

drain