0.0.3 • Published 9 years ago

superagent-d2l-promise-queue v0.0.3

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
9 years ago

NPM version Build status Coverage Status

#Request Queue

Uses the superagent library to perform ajax requests. Returns a deferred promises using the Q library.

Usage

send( Object )

The send function returns a deferred promise which can be resolved or rejected. The promise will be rejected if the request returns a error code such as 400, 404, 500, etc. The queue will attempt to retry the requst every 2 seconds if the request did not recieve a response from the endpoint provided. Before a retry the deferred object will send a .notify which can be subscribed to using .progress on the client side to preform any action prior to retry such as notifying the user that a connection loss occured.

import Request from 'superagent-d2l-promise-queue';

Request.send( 
	{
		url: someUrl,
		method: 'POST',
		payload: { text: 'Creating some entity' },
		useQueue: true,
		auth: sessionAuth
	}
);

payload, useQueue and auth are optional parameters.

Request.send(
	{
		url: someUrl,
		method: 'GET'
	}
);