Function Queue

lib/queue.js:85–287

(name, url, opts)

// Queue(name: string, url?, opts?)
const Queue = function Queue(name, url, opts) {
  if (!(this instanceof Queue)) {
    return new Queue(name, url, opts);
  }

  if (_.isString(url)) {
    const clonedOpts = _.cloneDeep(opts || {});
    opts = {
      ...clonedOpts,
      redis: {
        ...redisOptsFromUrl(url),
        ...clonedOpts.redis
      }
    };
  } else {
    opts = _.cloneDeep(url || {});
  }

  if (!_.isObject(opts)) {
    throw TypeError('Options must be a valid object');
  }

  if (opts.limiter) {
    if (opts.limiter.max && opts.limiter.duration) {
      this.limiter = opts.limiter;
    } else {
      throw new TypeError('Limiter requires `max` and `duration` options');
    }
  }

  if (opts.defaultJobOptions) {
    this.defaultJobOptions = opts.defaultJobOptions;
  }

  this.name = name;
  this.token = uuid.v4();

  opts.redis = {
    enableReadyCheck: false,
    ...(_.isString(opts.redis)
      ? { ...redisOptsFromUrl(opts.redis) }
      : opts.redis)
  };

  _.defaults(opts.redis, {
    port: 6379,
    host: '127.0.0.1',
    db: opts.redis.db || opts.redis.DB,
    retryStrategy: function(times) {
      return Math.min(Math.exp(times), 20000);
    }
  });

  this.keyPrefix = opts.redis.keyPrefix || opts.prefix || 'bull';

  //
  // We cannot use ioredis keyPrefix feature since we
  // create keys dynamically in lua scripts.