Skip to content

JavaScript job worker client for the Vulpes platform

License

Notifications You must be signed in to change notification settings

Kiosked/vulpes-client

Repository files navigation

Vulpes Client

JavaScript job worker client for the Vulpes platform

About

Vulpes is a job management platform that requires workers to check for and receive work, and then for them to submit a result after attempting to do the work. Vulpes Client provides a simple API with which to perform these worker operations.

Usage

Usage is quite simple - create a Worker instance, connect it to a Vulpes API endpoint and start listening:

const { RemoteConnector, Worker } = require("vulpes-client");

const worker = new Worker(new RemoteConnector(API_URI));
worker.on("job", payload => startJob(payload.job));

Worker is an EventEmitter, and it emits job events when a job is ready to start. It will not emit more job events if a job is currently running on the worker. You can stop/complete a job by calling Job#stop with a result type and result payload.

Check out the API documentation for more information on class usage.

About

JavaScript job worker client for the Vulpes platform

Resources

License

Stars

Watchers

Forks

Packages

No packages published