Namespace: request

just.request(urlnon-null, fnopt, optionsopt) → {*}

Make a request using XMLHttpRequest.

Since:: 1.0.0-rc.23
Source:: core.js, line 1831

Parameters:

Name Type Description

url url Some url.

fn
_[optional] just.request~fn Hook for onreadystatechange listener.

options
_[optional]

object

Properties

Name	Type	Default	Description
`method` _[optional]	string	"GET"	An HTTP Request Method: GET, POST, HEAD, ...
`json` _[optional]	boolean	/.json$/.test(url)	If `true`, `"Content-Type"` will be set to `"application/json"`, #responseType to `"json"`, and the #response/#responseText will be parsed to a JSON.
`data` _[optional]	Any	null	Data to send.
`send` _[optional]	function	just.request~send	A custom function to intercept and send the request.
`async` _[optional]	boolean	true	"async" param for XMLHttpRequest#open().
`user` _[optional]	string	null	User name to use for authentication purposes.
`pwd` _[optional]	string	null	Password to use for authentication purposes.
`props` _[optional]	object	just.request~defaultProps	Properties for the xhr instance.
`headers` _[optional]	object	just.request~defaultHeaders	Custom headers for the request.

Returns:

The retuned value of just.request~send.

Type: Any

Methods

appendData(url, datanullable) → {string}

Append data to the search params of the given url.

Source:: core.js, line 1917

Parameters:

Name	Type	Description
`url`	string	Some url.
`data` _[nullable]	object	An object to be appended.

Returns:

Type: string

Example

appendData('/some', {'data': 1}); // > '/some?data=1'
appendData('/some?url', {'data': 1}); // > '/some?url&data=1'

dataToUrl(datanullable) → {string}

Convert data into search params.

Source:: core.js, line 1945

Parameters:

Name	Type	Description
`data` _[nullable]	object	Expects an object literal.

Throws:

If data is not an object.

Type: TypeError

Returns:

Type: string

Example

dataToUrl({'a': '&a', 'b': 2}); // > 'a=%26&b=2'

Type Definitions

defaultHeaders

Default request headers.

Source:: core.js, line 1795

Properties:

Name	Type	Default	Description
`X-Requested-With` _[optional]	string	"XMLHttpRequest"
`Content-Type` _[optional]	string	"application/json"	Only on JSON requests.

Type:

object

defaultProps

Default request properties.

Source:: core.js, line 1802

Properties:

Name	Type	Default	Description
`responseType` _[optional]	string	"json"	Only on JSON requests.

Type:

object

fn(errornullable, response)

A function to call on "load"/"error" event.

Source:: core.js, line 1786

This:

{XMLHttpRequest}

Parameters:

Name	Type	Description
`error` _[nullable]	Error	Bad status error or `null`.
`response`	Any	Either #response or #responseText property. On JSON request, the property parsed as a JSON.

send(data, optionsnon-null)

A function to intercept and send the request.

Source:: core.js, line 1778

This:

{XMLHttpRequest}

Parameters:

Name	Type	Description
`data`	Any	The data ready to be sent.
`options`	object	The options for the request.