Fork me on GitHub

Class request.Request


Defined in: request.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
request.Request(options)

Abstract base request class.

Method Summary
Method Attributes Method Name and Description
 
end()

End the request.

Event Summary
Event Attributes Event Name and Description
 
end(data, meta)

Completion event ('end').

 
error(err)

Error event ('error').

Class Detail
request.Request(options)

Abstract base request class.

Parameters:
{Object} options
Options object.
Method Detail
end()

End the request.

Typically starts the async code execution.

Note: This function can be called multiple times without bad effect. Calling code has the option to call end() once the request is set up, or leave it to the end user.

Event Detail
end(data, meta)

Completion event ('end').

Parameters:
{Object} data
Results data.
{Object} meta
Headers, meta object.
{Object} meta.headers Optional
HTTP headers.
{Object} meta.cloudHeaders Optional
Cloud provider headers.
{Object} meta.metadata Optional
Cloud metadata.

error(err)

Error event ('error').

Parameters:
{Error|errors.CloudError} err
Error object.