superagent-d2l-queue

#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 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

$3

`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
}
`

$3

`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.

$3

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