0x2620/oxjs
2
0
Fork 1
Code Issues 172 Pull requests Releases Wiki Activity

update documentation for request methods

Browse source
This commit is contained in:
rolux 2012-07-03 23:55:05 +02:00
parent eac3168de0
commit c600c250b0
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
source/Ox/js/Request.js
View file

@ -1,12 +1,12 @@
'use strict'; 'use strict';
/*@ /*@
Ox.get <f> Get a remote file Ox.get <f> Get a remote resource
(url, callback) -> <u> undefined (url, callback) -> <u> undefined
url <s> Remote URL url <s> Remote URL
callback <f> Callback function callback <f> Callback function
data <s> The contents of the remote resource data <s|null> The contents of the remote resource, or `null` on error
error <o|null> Error, or null error <o|null> Error, or `null` on success
code <n> Status code code <n> Status code
text <s> Status text 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) get <f> Asynchronous function that loads a URL (for example Ox.get)
url <s> URL url <s> URL
callback <f> Callback function callback <f> Callback function
result <s> Result result <s|null> Result, or `null` on error
error <o|null> Error, or null error <o|null> Error, or `null` on success
code <n> Status code code <n> Status code
text <s> Status text text <s> Status text
callback <f> Callback function callback <f> Callback function
results <o> Results results <o|null> Results
Keys are file names, values are results Keys are file names, values are results
errors <o|null> Errors, or null errors <o|null> Errors, or null
Keys are file names, values are error objects 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, callback) -> <u> undefined
url <s|a> One or more remote URLs url <s|a> One or more remote URLs
callback <f> Callback function 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 For multiple URLs, keys are file names, values are parsed contents
error <o|null> Error(s) error <o|null> Error(s)
For multiple URLs, keys are file names, values are error objects 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, callback) -> <u> undefined
url <s|a> One or more remote URLs url <s|a> One or more remote URLs
callback <f> Callback function 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 For multiple URLs, keys are file names, values are parsed contents
error <o|null> Error(s) error <o|null> Error(s)
For multiple URLs, keys are file names, values are error objects 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 url <s|a> One or more remote URLs
{callback} gets replaced with jsonp callback function name {callback} gets replaced with jsonp callback function name
callback <f> Callback function 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 For multiple URLs, keys are file names, values are parsed contents
error <o|null> Error(s) error <o|null> Error(s)
For multiple URLs, keys are file names, values are error objects For multiple URLs, keys are file names, values are error objects