nncl / node-queue

Node Queue

Working with queues on Node JS.

Getting Started

First of all, duplicate the file env.example.js and rename it to env.js. Next, add your own information.

Development

npm run dev
PORT=<PORT-NUMBER> npm run dev

Then access http://localhost:3000 on your browser.

Production

npm start
PORT=<PORT-NUMBER> npm start

Routes

API endpoint: /api/v1

To execute this API's methods, check the following routes:

• Create job:

  • Route: POST /queue

  • Body:

    {
        "title" : "Hello World",
        "to" : "[e-mail]"
    }
    

• Retrieve failed jobs:

  • Route: GET /failed
  • Responses:

    • 200:

      {
          "err": null,
          "jobs": [
              131,
              132
          ],
          "total": 2
      }
      

• Retrieve active jobs:

  • Route: GET /active
  • Responses:

    • 200:

      {
          "err": null,
          "jobs": [
              131,
              132
          ],
          "total": 2
      }