From c600c250b028f9cec2e342e5f33953e31d51e1cd Mon Sep 17 00:00:00 2001 From: rolux Date: Tue, 3 Jul 2012 23:55:05 +0200 Subject: [PATCH] update documentation for request methods --- source/Ox/js/Request.js | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/source/Ox/js/Request.js b/source/Ox/js/Request.js index 0199d868..3e47b05a 100644 --- a/source/Ox/js/Request.js +++ b/source/Ox/js/Request.js @@ -1,12 +1,12 @@ 'use strict'; /*@ -Ox.get Get a remote file +Ox.get Get a remote resource (url, callback) -> undefined url Remote URL callback Callback function - data The contents of the remote resource - error Error, or null + data The contents of the remote resource, or `null` on error + error Error, or `null` on success code Status code text Status text @*/ @@ -37,12 +37,12 @@ Ox.getAsync Runs an asynchonous loader for an array of URLs get Asynchronous function that loads a URL (for example Ox.get) url URL callback Callback function - result Result - error Error, or null + result Result, or `null` on error + error Error, or `null` on success code Status code text Status text callback Callback function - results Results + results Results Keys are file names, values are results errors Errors, or null Keys are file names, values are error objects @@ -186,7 +186,7 @@ Ox.getJSON Get and parse one or more remote JSON files (url, callback) -> undefined url One or more remote URLs callback 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 Error(s) For multiple URLs, keys are file names, values are error objects @@ -208,7 +208,7 @@ Ox.getJSONC Get and parse a remote JSONC file (url, callback) -> undefined url One or more remote URLs callback 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 Error(s) For multiple URLs, keys are file names, values are error objects @@ -225,7 +225,7 @@ Ox.getJSONP Get and parse one or more remote JSONP files url One or more remote URLs {callback} gets replaced with jsonp callback function name callback 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 Error(s) For multiple URLs, keys are file names, values are error objects