@alienfast/sidekiq-client

@alienfast/sidekiq-client

A Sidekiq client for node, intended to mimic the default behaviors of the Sidekiq client itself.

Use case

A Google Cloud Functions microservice that processes and queues data back for persistence via a ruby Sidekiq job.

Features

• flow type checked standard Sidekiq job format
• enqueue
• your feature here

Installation

yarn add @alienfast/sidekiq-client redis

Usage

import SidekiqClient from '@alienfast/sidekiq-client'

// provide your own promisified redis client, or use the helper
const redisClient = SidekiqClient.redisCreateClient({ url: 'redis://foo:6379' })
const sidekiq = new SidekiqClient(redisClient);

// Enqueue a job to the 'default' queue with retry
sidekiq.enqueue({ 
  class: 'MyJob',
  args: ['foo']
})

// Enqueue a job to the 'critical' queue without retry
sidekiq.enqueue({ 
  class: 'MyJob',
  args: ['foo'],
  retry: false,
  queue: 'critical'  
})

// Schedule a job
sidekiq.enqueue({ 
  class: 'MyJob',
  args: ['foo']
}, new Date(2017, 10, 1))

Reporting Bugs or Feature Requests

• Issues: please log issues in the issue tracker and submit a PR with a fix.
• Feature Requests: please log an issue with the outline of your proposal for discussion, followed by the PR.

How you can help

• Add mocha test with assertions!
• Add any feature you like (with tests)

License

This is free software released under the MIT License. See LICENSE for details.