Skip to content

Queue Constructor

Grant Carthew edited this page Sep 14, 2016 · 7 revisions

Description

The primary JavaScript object you use with rethinkdb-job-queue is the Queue object. The Queue object connects to the RethinkDB database. If the database does not exist it will be created. Within the database there will be a table with the same name as the Queue name. Again, if the table does not exist it will be created.

The constructor for the Queue object takes two arguments being the Connection Options object and the Queue Options object. The Connection and Queue options are not required and if not supplied the default values will apply.

See the Connection Options and Queue Options documents for more detail about what the options are. This document is to show you how to create the Queue object with these options.

Constructor Options
Default Options
Connection Options
Queue Options Only
Connection and Queue Options

Default Options

To use all the default options when creating the Queue object use the following instantiation code.

See the Connection Options and Queue Options documents for more detail.

const q = new Queue()

Main

How It Works

Contributing

API

Queue Methods

Queue Properties

Queue Events

Job Methods

Job Properties

Documentation

Clone this wiki locally