docs/httpPost

src/io/files.js

@@ -706,14 +706,79 @@ p5.prototype.httpGet = function () {
  *
  * @method httpPost
  * @param {String} path name of the file or url to load
- * @param {String} [datatype] "json", "jsonp", "xml", or "text"
+ * @param {String} [datatype] "json", "jsonp", "xml", or "text".
+ * If omitted, httpPost() will guess.
  * @param {Object} [data] param data passed sent with request
  * @param {function} [callback] function to be executed after
- * httpGet() completes, data is passed in
+ * httpPost() completes, data is passed in
  * as first argument
  * @param {function} [errorCallback] function to be executed if
  * there is an error, response is passed
  * in as first argument
+ *
+ * @example
+ * <div>
+ * <code>
+ * // Examples use jsonplaceholder.typicode.com for a Mock Data API
+ *
+ * var url = 'https://jsonplaceholder.typicode.com/posts';
+ * var postData = { userId: 1, title: 'p5 Clicked!', body: 'p5.js is way cool.' };
+ *
+ * function setup() {
+ * createCanvas(800, 800);
+ * }
+ *
+ * function mousePressed() {
+ * // Pick new random color values
+ * var r = random(255);
+ * var g = random(255);
+ * var b = random(255);
+ *
+ * httpPost(url, 'json',
+ * postData,
+ * function (result) {
+ * strokeWeight(2);
+ * stroke(r, g, b);
+ * fill(r, g, b, 127);
+ * ellipse(mouseX, mouseY, 200, 200);
+ * text(result.body, mouseX, mouseY);
+ * });
+ * }
+ * </code>
+ * </div>
+ *
+ *
+ * <div><code>
+ *
+ * var url = 'https://invalidURL'; // A bad URL that will cause errors
+ * var postData = { title: 'p5 Clicked!', body: 'p5.js is way cool.' };
+ *
+ * function setup() {
+ * createCanvas(800, 800);
+ * }
+ *
+ * function mousePressed() {
+ * // Pick new random color values
+ * var r = random(255);
+ * var g = random(255);
+ * var b = random(255);
+ *
+ * httpPost(url, 'json',
+ * postData,
+ * function (result) {
+ * // ... won't be called
+ * },
+ * function (error) {
+ * strokeWeight(2);
+ * stroke(r, g, b);
+ * fill(r, g, b, 127);
+ * text(error.toString(), mouseX, mouseY);
+ * });
+ * }
+ *
+ * </code>
+ * </div>
+ *
  */
 p5.prototype.httpPost = function () {
  var args = Array.prototype.slice.call(arguments);