Skip to content

Commit

Permalink
Merge pull request #2186 from nickanderson/CFE-3107/3.12
Browse files Browse the repository at this point in the history
CFE-3107/3.12: Documented default values used for url_get()
  • Loading branch information
nickanderson committed Jul 26, 2019
2 parents 5f93799 + ec75b31 commit 16cf9d0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions reference/functions/url_get.markdown
Expand Up @@ -31,13 +31,13 @@ always provided.

The available options currently are:

* `url.max_content`: if present, specifies the maximum number of content bytes to retrieve.
* `url.max_headers`: if present, specifies the maximum number of response headers to retrieve.
* `url.verbose`: if 1, `libcurl` will be more verbose while retrieving the content
* `url.timeout`: if present, `libcurl` will time out the request after that many seconds
* `url.referer`: if present, `libcurl` will set the Referer to this
* `url.user-agent`: if present, `libcurl` will set the User-Agent to this
* `url.headers`: an array of strings in the format `Foo: bar` specifying headers for the request
* `url.max_content`: if present, specifies the maximum number of content bytes to retrieve (**default 4096**).
* `url.max_headers`: if present, specifies the maximum number of response headers to retrieve (**default 4096**).
* `url.verbose`: if 1, `libcurl` will be more verbose while retrieving the content (**default 0**).
* `url.timeout`: if present, `libcurl` will time out the request after that many seconds (**default 3**).
* `url.referer`: if present, `libcurl` will set the Referer to this (**default unset**).
* `url.user-agent`: if present, `libcurl` will set the User-Agent to this (**default unset**).
* `url.headers`: an array of strings in the format `Foo: bar` specifying headers for the request (**default `[Host: host , Accept: \*/\*]`**).

The returned data container will have the following keys:

Expand Down

0 comments on commit 16cf9d0

Please sign in to comment.