mirror of
https://github.com/meteor/meteor.git
synced 2026-05-02 03:01:46 -04:00
Automate EJSON and HTTP
This commit is contained in:
Sashko Stubailo
@@ -2905,19 +2905,19 @@ and a binary buffer would be serialized in EJSON as:
|
||||
Meteor supports all built-in EJSON data types in publishers, method arguments
|
||||
and results, Mongo databases, and [`Session`](#session) variables.
|
||||
|
||||
{{> api_box ejsonParse}}
|
||||
{{> autoApiBox "EJSON.parse"}}
|
||||
|
||||
{{> api_box ejsonStringify}}
|
||||
{{> autoApiBox "EJSON.stringify"}}
|
||||
|
||||
{{> api_box ejsonFromJSONValue}}
|
||||
{{> autoApiBox "EJSON.fromJSONValue"}}
|
||||
|
||||
{{> api_box ejsonToJSONValue}}
|
||||
{{> autoApiBox "EJSON.toJSONValue"}}
|
||||
|
||||
{{> api_box ejsonEquals}}
|
||||
{{> autoApiBox "EJSON.equals"}}
|
||||
|
||||
{{> api_box ejsonClone}}
|
||||
{{> autoApiBox "EJSON.clone"}}
|
||||
|
||||
{{> api_box ejsonNewBinary}}
|
||||
{{> autoApiBox "EJSON.newBinary"}}
|
||||
|
||||
Buffers of binary data are represented by `Uint8Array` instances on JavaScript
|
||||
platforms that support them. On implementations of JavaScript that do not
|
||||
@@ -2925,9 +2925,9 @@ support `Uint8Array`, binary data buffers are represented by standard arrays
|
||||
containing numbers ranging from 0 to 255, and the `$Uint8ArrayPolyfill` key
|
||||
set to `true`.
|
||||
|
||||
{{> api_box ejsonIsBinary}}
|
||||
{{> autoApiBox "EJSON.isBinary"}}
|
||||
|
||||
{{> api_box ejsonAddType}}
|
||||
{{> autoApiBox "EJSON.addType"}}
|
||||
|
||||
When you add a type to EJSON, Meteor will be able to use that type in:
|
||||
|
||||
@@ -2985,7 +2985,7 @@ result of calling [`toJSONValue`](#ejson_type_toJSONValue) instead.
|
||||
`HTTP` provides an HTTP request API on the client and server. To use
|
||||
these functions, add the HTTP package to your project with `$ meteor add http`.
|
||||
|
||||
{{> api_box httpcall}}
|
||||
{{> autoApiBox "HTTP.call"}}
|
||||
|
||||
This function initiates an HTTP request to a remote server.
|
||||
|
||||
|
||||
@@ -2042,6 +2042,725 @@ DocsData = {
|
||||
"locus": "Client"
|
||||
}
|
||||
},
|
||||
"EJSON": {
|
||||
"newBinary": {
|
||||
"meta": {
|
||||
"range": [
|
||||
1470,
|
||||
1769
|
||||
],
|
||||
"filename": "base64.js",
|
||||
"lineno": 70,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100269628",
|
||||
"name": "EJSON.newBinary",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"len"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"ret": null,
|
||||
"i": null,
|
||||
"ret.$Uint8ArrayPolyfill": null
|
||||
}
|
||||
},
|
||||
"summary": "Allocate a new buffer of binary data that EJSON can serialize.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Number"
|
||||
]
|
||||
},
|
||||
"description": "<p>The number of bytes of binary data to allocate.</p>",
|
||||
"name": "size"
|
||||
}
|
||||
],
|
||||
"name": "newBinary",
|
||||
"longname": "EJSON.newBinary",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R050894",
|
||||
"___s": true,
|
||||
"options": [],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"addType": {
|
||||
"meta": {
|
||||
"range": [
|
||||
1156,
|
||||
1321
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 24,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100270478",
|
||||
"name": "EJSON.addType",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"name",
|
||||
"factory"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"customTypes[undefined]": null
|
||||
}
|
||||
},
|
||||
"summary": "Add a custom datatype to EJSON.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>A tag for your custom type; must be unique among custom data types defined in your project, and must match the result of your type's <code>typeName</code> method.</p>",
|
||||
"name": "name"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"function"
|
||||
]
|
||||
},
|
||||
"description": "<p>A function that deserializes a JSON-compatible value into an instance of your type. This should match the serialization performed by your type's <code>toJSONValue</code> method.</p>",
|
||||
"name": "factory"
|
||||
}
|
||||
],
|
||||
"name": "addType",
|
||||
"longname": "EJSON.addType",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R050975",
|
||||
"___s": true,
|
||||
"options": [],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"toJSONValue": {
|
||||
"meta": {
|
||||
"range": [
|
||||
5932,
|
||||
6178
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 193,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100271095",
|
||||
"name": "EJSON.toJSONValue",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"item"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"changed": null,
|
||||
"item": null
|
||||
}
|
||||
},
|
||||
"summary": "Serialize an EJSON-compatible value into its plain JSON representation.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"EJSON"
|
||||
]
|
||||
},
|
||||
"description": "<p>A value to serialize to plain JSON.</p>",
|
||||
"name": "val"
|
||||
}
|
||||
],
|
||||
"name": "toJSONValue",
|
||||
"longname": "EJSON.toJSONValue",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R051025",
|
||||
"___s": true,
|
||||
"options": [],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"fromJSONValue": {
|
||||
"meta": {
|
||||
"range": [
|
||||
7902,
|
||||
8158
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 262,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100271293",
|
||||
"name": "EJSON.fromJSONValue",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"item"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"changed": null,
|
||||
"item": null
|
||||
}
|
||||
},
|
||||
"summary": "Deserialize an EJSON value from its plain JSON representation.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"description": "<p>A value to deserialize into EJSON.</p>",
|
||||
"name": "val"
|
||||
}
|
||||
],
|
||||
"name": "fromJSONValue",
|
||||
"longname": "EJSON.fromJSONValue",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R051036",
|
||||
"___s": true,
|
||||
"options": [],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"stringify": {
|
||||
"meta": {
|
||||
"range": [
|
||||
8786,
|
||||
9029
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 283,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100271334",
|
||||
"name": "EJSON.stringify",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"item",
|
||||
"options"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"json": null
|
||||
}
|
||||
},
|
||||
"summary": "Serialize a value to a string.\n\nFor EJSON values, the serialization fully represents the value. For non-EJSON values, serializes the same way as `JSON.stringify`.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"EJSON"
|
||||
]
|
||||
},
|
||||
"description": "<p>A value to stringify.</p>",
|
||||
"name": "val"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"optional": true,
|
||||
"name": "options"
|
||||
}
|
||||
],
|
||||
"name": "stringify",
|
||||
"longname": "EJSON.stringify",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R051039",
|
||||
"___s": true,
|
||||
"options": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Boolean",
|
||||
"Integer",
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>Indents objects and arrays for easy readability. When <code>true</code>, indents by 2 spaces; when an integer, indents by that number of spaces; and when a string, uses the string as the indentation pattern.</p>",
|
||||
"name": "indent"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Boolean"
|
||||
]
|
||||
},
|
||||
"description": "<p>When <code>true</code>, stringifies keys in an object in sorted order.</p>",
|
||||
"name": "canonical"
|
||||
}
|
||||
],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"parse": {
|
||||
"meta": {
|
||||
"range": [
|
||||
9219,
|
||||
9396
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 297,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100271376",
|
||||
"name": "EJSON.parse",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"item"
|
||||
]
|
||||
}
|
||||
},
|
||||
"summary": "Parse a string into an EJSON value. Throws an error if the string is not valid EJSON.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>A string to parse into an EJSON value.</p>",
|
||||
"name": "str"
|
||||
}
|
||||
],
|
||||
"name": "parse",
|
||||
"longname": "EJSON.parse",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R051041",
|
||||
"___s": true,
|
||||
"options": [],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"isBinary": {
|
||||
"meta": {
|
||||
"range": [
|
||||
9587,
|
||||
9741
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 308,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100271403",
|
||||
"name": "EJSON.isBinary",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"obj"
|
||||
]
|
||||
}
|
||||
},
|
||||
"summary": "Returns true if `x` is a buffer of binary data, as returned from [`EJSON.newBinary`](#ejson_new_binary).",
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"description": "<p>The variable to check.</p>",
|
||||
"name": "x"
|
||||
}
|
||||
],
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"name": "isBinary",
|
||||
"longname": "EJSON.isBinary",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R051042",
|
||||
"___s": true,
|
||||
"options": [],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"equals": {
|
||||
"meta": {
|
||||
"range": [
|
||||
10260,
|
||||
12514
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 321,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100271428",
|
||||
"name": "EJSON.equals",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"a",
|
||||
"b",
|
||||
"options"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"i": null,
|
||||
"keyOrderSensitive": null,
|
||||
"ret": null,
|
||||
"bKeys": null,
|
||||
"": null
|
||||
}
|
||||
},
|
||||
"summary": "Return true if `a` and `b` are equal to each other. Return false otherwise. Uses the `equals` method on `a` if present, otherwise performs a deep comparison.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"EJSON"
|
||||
]
|
||||
},
|
||||
"name": "a"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"EJSON"
|
||||
]
|
||||
},
|
||||
"name": "b"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"optional": true,
|
||||
"name": "options"
|
||||
}
|
||||
],
|
||||
"name": "equals",
|
||||
"longname": "EJSON.equals",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R051043",
|
||||
"___s": true,
|
||||
"options": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Boolean"
|
||||
]
|
||||
},
|
||||
"description": "<p>Compare in key sensitive order, if supported by the JavaScript implementation. For example, <code>{a: 1, b: 2}</code> is equal to <code>{b: 2, a: 1}</code> only when <code>keyOrderSensitive</code> is <code>false</code>. The default is <code>false</code>.</p>",
|
||||
"name": "keyOrderSensitive"
|
||||
}
|
||||
],
|
||||
"locus": "Anywhere"
|
||||
},
|
||||
"clone": {
|
||||
"meta": {
|
||||
"range": [
|
||||
12624,
|
||||
13890
|
||||
],
|
||||
"filename": "ejson.js",
|
||||
"lineno": 407,
|
||||
"path": "/Users/sashko/git/meteor/packages/ejson",
|
||||
"code": {
|
||||
"id": "astnode100271815",
|
||||
"name": "EJSON.clone",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"v"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"ret": null,
|
||||
"i": null,
|
||||
"ret[undefined]": null,
|
||||
"": null
|
||||
}
|
||||
},
|
||||
"summary": "Return a deep copy of `val`.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"EJSON"
|
||||
]
|
||||
},
|
||||
"description": "<p>A value to copy.</p>",
|
||||
"name": "val"
|
||||
}
|
||||
],
|
||||
"name": "clone",
|
||||
"longname": "EJSON.clone",
|
||||
"kind": "function",
|
||||
"memberof": "EJSON",
|
||||
"scope": "static",
|
||||
"___id": "T000002R051054",
|
||||
"___s": true,
|
||||
"options": [],
|
||||
"locus": "Anywhere"
|
||||
}
|
||||
},
|
||||
"HTTP": {
|
||||
"call": {
|
||||
"meta": {
|
||||
"range": [
|
||||
1469,
|
||||
6302
|
||||
],
|
||||
"filename": "httpcall_client.js",
|
||||
"lineno": 17,
|
||||
"path": "/Users/sashko/git/meteor/packages/http",
|
||||
"code": {
|
||||
"id": "astnode100308171",
|
||||
"name": "HTTP.call",
|
||||
"type": "FunctionExpression",
|
||||
"value": "function",
|
||||
"paramnames": [
|
||||
"method",
|
||||
"url",
|
||||
"options",
|
||||
"callback"
|
||||
]
|
||||
},
|
||||
"vars": {
|
||||
"callback": null,
|
||||
"options": null,
|
||||
"method": null,
|
||||
"headers": null,
|
||||
"content": null,
|
||||
"headers['Content-Type']": null,
|
||||
"params_for_url": null,
|
||||
"params_for_body": null,
|
||||
"query_match": null,
|
||||
"url": null,
|
||||
"username": null,
|
||||
"password": null,
|
||||
"colonLoc": null,
|
||||
"": null,
|
||||
"xhr": null,
|
||||
"k": null,
|
||||
"timed_out": null,
|
||||
"timer": null,
|
||||
"xhr.onreadystatechange": null
|
||||
}
|
||||
},
|
||||
"summary": "Perform an outbound HTTP request.",
|
||||
"tags": [
|
||||
{
|
||||
"originalTitle": "locus",
|
||||
"title": "locus",
|
||||
"text": "Anywhere",
|
||||
"value": "Anywhere"
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>The <a href=\"http://en.wikipedia.org/wiki/HTTP_method\">HTTP method</a> to use, such as "<code>GET</code>", "<code>POST</code>", or "<code>HEAD</code>".</p>",
|
||||
"name": "method"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>The URL to retrieve.</p>",
|
||||
"name": "url"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"function"
|
||||
]
|
||||
},
|
||||
"description": "<p>Optional callback. If passed, the method runs asynchronously, instead of synchronously, and calls asyncCallback. On the client, this callback is required.</p>",
|
||||
"name": "asyncCallback"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"optional": true,
|
||||
"name": "options"
|
||||
}
|
||||
],
|
||||
"name": "call",
|
||||
"longname": "HTTP.call",
|
||||
"kind": "function",
|
||||
"memberof": "HTTP",
|
||||
"scope": "static",
|
||||
"___id": "T000002R059489",
|
||||
"___s": true,
|
||||
"options": [
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>String to use as the HTTP request body.</p>",
|
||||
"name": "content"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"description": "<p>JSON-able object to stringify and use as the HTTP request body. Overwrites <code>content</code>.</p>",
|
||||
"name": "data"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>Query string to go in the URL. Overwrites any query string in <code>url</code>.</p>",
|
||||
"name": "query"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"description": "<p>Dictionary of request parameters to be encoded and placed in the URL (for GETs) or request body (for POSTs). If <code>content</code> or <code>data</code> is specified, <code>params</code> will always be placed in the URL.</p>",
|
||||
"name": "params"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"description": "<p>HTTP basic authentication string of the form <code>"username:password"</code></p>",
|
||||
"name": "auth"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Object"
|
||||
]
|
||||
},
|
||||
"description": "<p>Dictionary of strings, headers to add to the HTTP request.</p>",
|
||||
"name": "headers"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Number"
|
||||
]
|
||||
},
|
||||
"description": "<p>Maximum time in milliseconds to wait for the request before failing. There is no timeout by default.</p>",
|
||||
"name": "timeout"
|
||||
},
|
||||
{
|
||||
"type": {
|
||||
"names": [
|
||||
"Boolean"
|
||||
]
|
||||
},
|
||||
"description": "<p>If <code>true</code>, transparently follow HTTP redirects. Cannot be set to <code>false</code> on the client. Default <code>true</code>.</p>",
|
||||
"name": "followRedirects"
|
||||
}
|
||||
],
|
||||
"locus": "Anywhere"
|
||||
}
|
||||
},
|
||||
"DDP": {
|
||||
"connect": {
|
||||
"meta": {
|
||||
|
||||
@@ -40,6 +40,20 @@
|
||||
"onInvalidate": {},
|
||||
"afterFlush": {}
|
||||
},
|
||||
"EJSON": {
|
||||
"newBinary": {},
|
||||
"addType": {},
|
||||
"toJSONValue": {},
|
||||
"fromJSONValue": {},
|
||||
"stringify": {},
|
||||
"parse": {},
|
||||
"isBinary": {},
|
||||
"equals": {},
|
||||
"clone": {}
|
||||
},
|
||||
"HTTP": {
|
||||
"call": {}
|
||||
},
|
||||
"DDP": {
|
||||
"connect": {}
|
||||
},
|
||||
|
||||
@@ -62,6 +62,11 @@ var getVal = function (ch) {
|
||||
return BASE_64_VALS[ch];
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Allocate a new buffer of binary data that EJSON can serialize.
|
||||
* @locus Anywhere
|
||||
* @param {Number} size The number of bytes of binary data to allocate.
|
||||
*/
|
||||
EJSON.newBinary = function (len) {
|
||||
if (typeof Uint8Array === 'undefined' || typeof ArrayBuffer === 'undefined') {
|
||||
var ret = [];
|
||||
|
||||
@@ -14,7 +14,13 @@ var customTypes = {};
|
||||
// used instead.
|
||||
// Similarly, EJSON.equals will use toJSONValue to make comparisons,
|
||||
// but you may provide a method equals() instead.
|
||||
//
|
||||
|
||||
/**
|
||||
* @summary Add a custom datatype to EJSON.
|
||||
* @locus Anywhere
|
||||
* @param {String} name A tag for your custom type; must be unique among custom data types defined in your project, and must match the result of your type's `typeName` method.
|
||||
* @param {Function} factory A function that deserializes a JSON-compatible value into an instance of your type. This should match the serialization performed by your type's `toJSONValue` method.
|
||||
*/
|
||||
EJSON.addType = function (name, factory) {
|
||||
if (_.has(customTypes, name))
|
||||
throw new Error("Type " + name + " already present");
|
||||
@@ -179,6 +185,11 @@ var toJSONValueHelper = function (item) {
|
||||
return undefined;
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Serialize an EJSON-compatible value into its plain JSON representation.
|
||||
* @locus Anywhere
|
||||
* @param {EJSON} val A value to serialize to plain JSON.
|
||||
*/
|
||||
EJSON.toJSONValue = function (item) {
|
||||
var changed = toJSONValueHelper(item);
|
||||
if (changed !== undefined)
|
||||
@@ -243,6 +254,11 @@ var fromJSONValueHelper = function (value) {
|
||||
return value;
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Deserialize an EJSON value from its plain JSON representation.
|
||||
* @locus Anywhere
|
||||
* @param {Object} val A value to deserialize into EJSON.
|
||||
*/
|
||||
EJSON.fromJSONValue = function (item) {
|
||||
var changed = fromJSONValueHelper(item);
|
||||
if (changed === item && typeof item === 'object') {
|
||||
@@ -254,6 +270,16 @@ EJSON.fromJSONValue = function (item) {
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Serialize a value to a string.
|
||||
|
||||
For EJSON values, the serialization fully represents the value. For non-EJSON values, serializes the same way as `JSON.stringify`.
|
||||
* @locus Anywhere
|
||||
* @param {EJSON} val A value to stringify.
|
||||
* @param {Object} [options]
|
||||
* @param {Boolean | Integer | String} options.indent Indents objects and arrays for easy readability. When `true`, indents by 2 spaces; when an integer, indents by that number of spaces; and when a string, uses the string as the indentation pattern.
|
||||
* @param {Boolean} options.canonical When `true`, stringifies keys in an object in sorted order.
|
||||
*/
|
||||
EJSON.stringify = function (item, options) {
|
||||
var json = EJSON.toJSONValue(item);
|
||||
if (options && (options.canonical || options.indent)) {
|
||||
@@ -263,17 +289,35 @@ EJSON.stringify = function (item, options) {
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Parse a string into an EJSON value. Throws an error if the string is not valid EJSON.
|
||||
* @locus Anywhere
|
||||
* @param {String} str A string to parse into an EJSON value.
|
||||
*/
|
||||
EJSON.parse = function (item) {
|
||||
if (typeof item !== 'string')
|
||||
throw new Error("EJSON.parse argument should be a string");
|
||||
return EJSON.fromJSONValue(JSON.parse(item));
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Returns true if `x` is a buffer of binary data, as returned from [`EJSON.newBinary`](#ejson_new_binary).
|
||||
* @param {Object} x The variable to check.
|
||||
* @locus Anywhere
|
||||
*/
|
||||
EJSON.isBinary = function (obj) {
|
||||
return !!((typeof Uint8Array !== 'undefined' && obj instanceof Uint8Array) ||
|
||||
(obj && obj.$Uint8ArrayPolyfill));
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Return true if `a` and `b` are equal to each other. Return false otherwise. Uses the `equals` method on `a` if present, otherwise performs a deep comparison.
|
||||
* @locus Anywhere
|
||||
* @param {EJSON} a
|
||||
* @param {EJSON} b
|
||||
* @param {Object} [options]
|
||||
* @param {Boolean} options.keyOrderSensitive Compare in key sensitive order, if supported by the JavaScript implementation. For example, `{a: 1, b: 2}` is equal to `{b: 2, a: 1}` only when `keyOrderSensitive` is `false`. The default is `false`.
|
||||
*/
|
||||
EJSON.equals = function (a, b, options) {
|
||||
var i;
|
||||
var keyOrderSensitive = !!(options && options.keyOrderSensitive);
|
||||
@@ -355,6 +399,11 @@ EJSON.equals = function (a, b, options) {
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @summary Return a deep copy of `val`.
|
||||
* @locus Anywhere
|
||||
* @param {EJSON} val A value to copy.
|
||||
*/
|
||||
EJSON.clone = function (v) {
|
||||
var ret;
|
||||
if (typeof v !== "object")
|
||||
|
||||
@@ -1,3 +1,19 @@
|
||||
/**
|
||||
* @summary Perform an outbound HTTP request.
|
||||
* @locus Anywhere
|
||||
* @param {String} method The [HTTP method](http://en.wikipedia.org/wiki/HTTP_method) to use, such as "`GET`", "`POST`", or "`HEAD`".
|
||||
* @param {String} url The URL to retrieve.
|
||||
* @param {Function} [asyncCallback] Optional callback. If passed, the method runs asynchronously, instead of synchronously, and calls asyncCallback. On the client, this callback is required.
|
||||
* @param {Object} [options]
|
||||
* @param {String} options.content String to use as the HTTP request body.
|
||||
* @param {Object} options.data JSON-able object to stringify and use as the HTTP request body. Overwrites `content`.
|
||||
* @param {String} options.query Query string to go in the URL. Overwrites any query string in `url`.
|
||||
* @param {Object} options.params Dictionary of request parameters to be encoded and placed in the URL (for GETs) or request body (for POSTs). If `content` or `data` is specified, `params` will always be placed in the URL.
|
||||
* @param {String} options.auth HTTP basic authentication string of the form `"username:password"`
|
||||
* @param {Object} options.headers Dictionary of strings, headers to add to the HTTP request.
|
||||
* @param {Number} options.timeout Maximum time in milliseconds to wait for the request before failing. There is no timeout by default.
|
||||
* @param {Boolean} options.followRedirects If `true`, transparently follow HTTP redirects. Cannot be set to `false` on the client. Default `true`.
|
||||
*/
|
||||
HTTP.call = function(method, url, options, callback) {
|
||||
|
||||
////////// Process arguments //////////
|
||||
|
||||
Reference in New Issue
Block a user