V8 Javascript API

http Class Reference

[Http Requests]

Description

Http request functions. This module is a wrapper around the native IHttp_client interface.

Inner Classes

class 
More...
class 
More...
class 
More...
class 
Asynchronous variants of the http api. More...

Static Functions

http.​Response delete( http.​Request request)
Sends a synchronous http request with the method set to DELETE by default. More...
http.​Response get( http.​Request request)
Sends a synchronous http request with the method set to GET by default. More...
http.​Response head( http.​Request request)
Sends a synchronous http request with the method set to HEAD by default. More...
http.​Response options( http.​Request request)
Sends a synchronous http request with the method set to OPTIONS by default. More...
http.​Response patch( http.​Request request)
Sends a synchronous http request with the method set to PATCH by default. More...
http.​Response post( http.​Request request)
Sends a synchronous http request with the method set to POST by default. More...
http.​Response put( http.​Request request)
Sends a synchronous http request with the method set to PUT by default. More...
http.​Response send( http.​Request request)
Sends a synchronous http request and returns the response. More...

Functions

http.​Response http.delete( http.​Request request) [static]

Sends a synchronous http request with the method set to DELETE by default.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.

http.​Response http.get( http.​Request request) [static]

Sends a synchronous http request with the method set to GET by default.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.

http.​Response http.head( http.​Request request) [static]

Sends a synchronous http request with the method set to HEAD by default.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.

http.​Response http.options( http.​Request request) [static]

Sends a synchronous http request with the method set to OPTIONS by default.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.

http.​Response http.patch( http.​Request request) [static]

Sends a synchronous http request with the method set to PATCH by default.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.

http.​Response http.post( http.​Request request) [static]

Sends a synchronous http request with the method set to POST by default.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.

http.​Response http.put( http.​Request request) [static]

Sends a synchronous http request with the method set to PUT by default.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.

http.​Response http.send( http.​Request request) [static]

Sends a synchronous http request and returns the response.

Note:

Http codes that could be considered errors such as those in the 4xx or 5xx range are considered valid responses and will return http.Response objects instead of http.Error objects.

Parameters

request
Http request object to send. May be one of the following:
  • http.Request : Request options object.
  • String : Request url to retrieve.
  • Array : Mixed array of String urls and http.Request objects.

Returns

In the case that request is a String or http.Request , a single http.Response or http.Error object is returned. In the case that an Array was provided, an Array of http.Request and http.Error objects are returned.