Syncano

Class: Request

Request

new Request()

Base request object not meant to be used directly, more like mixin in other stamps.

Properties:
Name Type Description
_request Object
Properties
Name Type Argument Default Description
handler function <optional>
 superagent
allowedMethods Array <optional>
 ['GET', 'POST', 'DELETE', 'HEAD', 'PUT', 'PATCH']
Source:
Example
var MyStamp = stampit().compose(Request);

Methods

<static> getRequestHandler()

Sets request handler from stampit definition.

Source:
Returns:
Type
function

<static> setRequestHandler()

Sets request handler and returns new stampit object, used for mocking.

Source:
Returns:
Type
stampit

buildUrl(path)

Builds full URL based on path.

Parameters:
Name Type Description
path String

path part of URL e.g: /v1.1/instances/
Source:
Returns:
Type
String

getRequestHandler()

Gets request handler.

Source:
Returns:
Type
function

makeRequest(methodName, path, requestOptions)

Wrapper around superagent which validates and calls requests.

Parameters:
Name Type Description
methodName String

e.g GET, POST
path String

e.g /v1.1/instances/
requestOptions Object

All options required to build request

Properties
Name Type Argument Default Description
type String <optional>
 'json'

request type e.g form, json, png
accept String <optional>
 'json'

request accept e.g form, json, png
timeout Number <optional>
 15000

request timeout
headers Object <optional>
 {}

request headers
query Object <optional>
 {}

request query
payload Object <optional>
 {}

request payload
Source:
Returns:
Type
Promise

setRequestHandler(handler)

Sets request handler, used for mocking.

Parameters:
Name Type Description
handler function
Source:
Returns:
Type
Request