https://github.com/brightspace/superagent-d2l-queue

Request queue using superagent and Q promise library
https://github.com/brightspace/superagent-d2l-queue

Last synced: 5 days ago
JSON representation

Request queue using superagent and Q promise library

• Host: GitHub
• URL: https://github.com/brightspace/superagent-d2l-queue
• Owner: Brightspace
• Created: 2015-09-28T13:40:59.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-07-07T17:54:00.000Z (over 4 years ago)
• Last Synced: 2024-11-05T02:17:53.619Z (10 days ago)
• Language: JavaScript
• Size: 1.34 MB
• Stars: 2
• Watchers: 14
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#Request Queue

[![NPM version][npm-image]][npm-url]

[![Build status][ci-image]][ci-url]

[![Coverage Status][coverage-image]][coverage-url]

[![Dependency Status][dependencies-image]][dependencies-url]

Extends [Superagent](https://github.com/visionmedia/superagent) by adding the ability to queue up requests and retry failed requests due to timeouts.

## Installation

Install from NPM:

```shell

npm install superagent-d2l-queue --save

```

## Usage

### `superagentQueue(options)`

```js

const request = require( 'superagent' );

const superagentQueue = require('superagent-d2l-queue');

// ...

request

    .get( ... )

    .use( superagentQueue( ... ) )

    .end( function( err, res ) {

        // ...

    });

```

__Options (defaults):__

All parameters are optional. The backoff parameter does need to include all parameters. Custom parameters will

be merged with default parameters.

```js

{

    queue: undefined, // use `superagentQueue.makeQueue()``

    backoff: {

        initialTimeout: 2000, // Initial retry timeout

        maxTimeout: undefined, // Max retry timeout

        expFactor: 1.4 // Exponental backoff factor  (1.4 ^ retryCount)

        retries: 5, // Number of retries, can be null to have infinite retries

        override: function( retryCount ) { // Compute the time between each retry interval.

            return Math.round( initialTimeout *

                Math.pow( backoff.exp.factor, retryCount ) );

        }

    },

    // Enable request retry when a request has timed out.

    retryEnabled: false,

    // Callback function that will be called when a request has timedout and will be retried. This function

    // will not be called if retry is disabled

    retryNotifier: undefined

}

```

### `superagentQueue( { queue: superagentQueue.makeQueue() } )`

Specify an Array that will be used as a queue to chain multiple Superagent requests. Only one request will execute at a time. This is similar to what can be done with libraries such as [Q](https://github.com/kriskowal/q).

```js

const request = require( 'superagent' );

const superagentQueue = require('superagent-d2l-queue');

// ...

const queue = superagentQueue.makeQueue();

const first = request

    .get( ... )

    .use( superagentQueue( { queue } ) )

    .end( function( err, res ) {

        // ...

    });

const second = request

    .get( ... )

    .use( superagentQueue( { queue } ) )

    .end( function( err, res ) {

        // ...

    });

const third = request

    .get( ... )

    .use( superagentQueue( { queue } ) )

    .end( function( err, res ) {

        // ...

    });

// etc...

```

## Contributing

1. **Fork** the repository. Committing directly against this repository is

   highly discouraged.

   2. Make your modifications in a branch, updating and writing new unit tests

      as necessary in the `spec` directory.

      3. Ensure that all tests pass with `npm test`

      4. Submit a pull request to this repository. Wait for tests to run and someone

         to chime in.

### Code Style

This repository is configured with [EditorConfig][EditorConfig] and [ESLint][ESLint] rules.

[npm-url]: https://npmjs.org/package/superagent-d2l-queue

[npm-image]: https://img.shields.io/npm/v/superagent-d2l-queue.png

[ci-url]: https://travis-ci.org/Brightspace/superagent-d2l-queue

[ci-image]: https://img.shields.io/travis-ci/Brightspace/superagent-d2l-queue.svg

[coverage-url]: https://coveralls.io/r/Brightspace/superagent-d2l-queue?branch=master

[coverage-image]: https://img.shields.io/coveralls/Brightspace/superagent-d2l-queue.svg

[dependencies-url]: https://david-dm.org/brightspace/superagent-d2l-queue

[dependencies-image]: https://img.shields.io/david/Brightspace/superagent-d2l-queue.svg

[EditorConfig]: http://editorconfig.org/

[ESLint]: https://github.com/eslint/eslint