update documentation for request methods
This commit is contained in:
parent
eac3168de0
commit
c600c250b0
1 changed files with 9 additions and 9 deletions
|
@ -1,12 +1,12 @@
|
|||
'use strict';
|
||||
|
||||
/*@
|
||||
Ox.get <f> Get a remote file
|
||||
Ox.get <f> Get a remote resource
|
||||
(url, callback) -> <u> undefined
|
||||
url <s> Remote URL
|
||||
callback <f> Callback function
|
||||
data <s> The contents of the remote resource
|
||||
error <o|null> Error, or null
|
||||
data <s|null> The contents of the remote resource, or `null` on error
|
||||
error <o|null> Error, or `null` on success
|
||||
code <n> Status code
|
||||
text <s> Status text
|
||||
@*/
|
||||
|
@ -37,12 +37,12 @@ Ox.getAsync <f> Runs an asynchonous loader for an array of URLs
|
|||
get <f> Asynchronous function that loads a URL (for example Ox.get)
|
||||
url <s> URL
|
||||
callback <f> Callback function
|
||||
result <s> Result
|
||||
error <o|null> Error, or null
|
||||
result <s|null> Result, or `null` on error
|
||||
error <o|null> Error, or `null` on success
|
||||
code <n> Status code
|
||||
text <s> Status text
|
||||
callback <f> Callback function
|
||||
results <o> Results
|
||||
results <o|null> Results
|
||||
Keys are file names, values are results
|
||||
errors <o|null> Errors, or null
|
||||
Keys are file names, values are error objects
|
||||
|
@ -186,7 +186,7 @@ Ox.getJSON <f> Get and parse one or more remote JSON files
|
|||
(url, callback) -> <u> undefined
|
||||
url <s|a> One or more remote URLs
|
||||
callback <f> Callback function
|
||||
data <*|o> The parsed content of the remote resource(s)
|
||||
data <*|o|null> The parsed content of the remote resource(s)
|
||||
For multiple URLs, keys are file names, values are parsed contents
|
||||
error <o|null> Error(s)
|
||||
For multiple URLs, keys are file names, values are error objects
|
||||
|
@ -208,7 +208,7 @@ Ox.getJSONC <f> Get and parse a remote JSONC file
|
|||
(url, callback) -> <u> undefined
|
||||
url <s|a> One or more remote URLs
|
||||
callback <f> Callback function
|
||||
data <*|o> The parsed content of the remote resource(s)
|
||||
data <*|o|null> The parsed content of the remote resource(s)
|
||||
For multiple URLs, keys are file names, values are parsed contents
|
||||
error <o|null> Error(s)
|
||||
For multiple URLs, keys are file names, values are error objects
|
||||
|
@ -225,7 +225,7 @@ Ox.getJSONP <f> Get and parse one or more remote JSONP files
|
|||
url <s|a> One or more remote URLs
|
||||
{callback} gets replaced with jsonp callback function name
|
||||
callback <f> Callback function
|
||||
data <*|o> The parsed content of the remote resource(s)
|
||||
data <*|o|null> The parsed content of the remote resource(s)
|
||||
For multiple URLs, keys are file names, values are parsed contents
|
||||
error <o|null> Error(s)
|
||||
For multiple URLs, keys are file names, values are error objects
|
||||
|
|
Loading…
Reference in a new issue