JSDoc: Global

Methods

connect(link, optionsopt) → {any}

Sends a request for the connect.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 113

Returns:

Shows the result of the send request.

Type: any

delete(link, optionsopt) → {any}

Sends a request for the delete.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 81

Returns:

Shows the result of the send request.

Type: any

get(link, optionsopt) → {any}

Sends a request for the get.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 15

Returns:

Shows the result of the send request.

Type: any

head(link, optionsopt) → {any}

Sends a request for the head.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 97

Returns:

Shows the result of the send request.

Type: any

options(link, optionsopt) → {any}

Sends a request for the options.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 129

Returns:

Shows the result of the send request.

Type: any

patch(link, optionsopt) → {any}

Sends a request for the patch.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 65

Returns:

Shows the result of the send request.

Type: any

post(link, optionsopt) → {any}

Sends a request for the post.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`data`	Object	Data of the request to be post.
`body`	Object	Data of the request to be post.
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 33

Returns:

Shows the result of the send request.

Type: any

put(link, optionsopt) → {any}

Sends a request for the put.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 49

Returns:

Shows the result of the send request.

Type: any

trace(link, optionsopt) → {any}

Sends a request for the trace.

Parameters:

Name Type Attributes Description

link String Link to the site to which the request will be sent.

options

Object

Settings of the request to be send. (default = {})

Properties

Name	Type	Description
`headers`	Object	Headers of the request to be send. (default = {})
`json`	Boolean	Is the body in JSON format? (default = false)
`xml`	Boolean	Whether the body will be converted to json format if the body is in xml format. (default = false)
`html`	Boolean	Whether the body will be converted to json format if the body is in html format. (default = false)
`jquery`	Boolean	Whether jQuery mode is active. (default = false)
`webJS`	Boolean	Whether webJS mode is active. (default = false)

Source:

index.js, line 145

Returns:

Shows the result of the send request.

Type: any