The function to run. It receives one argument: a Tracker.Computation object.
",
"name": "runFunc",
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "A version of [Tracker.autorun](#tracker_autorun) that is stopped when the template is destroyed."
},
"Blaze.TemplateInstance#data": {
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 158,
"locus": "Client",
"longname": "Blaze.TemplateInstance#data",
"memberof": "Blaze.TemplateInstance",
"name": "data",
"scope": "instance",
"summary": "The data context of this instance's latest invocation."
},
"Blaze.TemplateInstance#find": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 311,
"locus": "Client",
"longname": "Blaze.TemplateInstance#find",
"memberof": "Blaze.TemplateInstance",
"name": "find",
"options": [],
"params": [
{
"description": "The CSS selector to match, scoped to the template contents.
",
"name": "selector",
"type": {
"names": [
"String"
]
}
}
],
"returns": [
{
"type": {
"names": [
"DOMElement"
]
}
}
],
"scope": "instance",
"summary": "Find one element matching `selector` in this template instance."
},
"Blaze.TemplateInstance#findAll": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 301,
"locus": "Client",
"longname": "Blaze.TemplateInstance#findAll",
"memberof": "Blaze.TemplateInstance",
"name": "findAll",
"options": [],
"params": [
{
"description": "The CSS selector to match, scoped to the template contents.
",
"name": "selector",
"type": {
"names": [
"String"
]
}
}
],
"returns": [
{
"type": {
"names": [
"Array."
]
}
}
],
"scope": "instance",
"summary": "Find all elements matching `selector` in this template instance."
},
"Blaze.TemplateInstance#firstNode": {
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 251,
"locus": "Client",
"longname": "Blaze.TemplateInstance#firstNode",
"memberof": "Blaze.TemplateInstance",
"name": "firstNode",
"scope": "instance",
"summary": "The first top-level DOM node in this template instance.",
"type": {
"names": [
"DOMNode"
]
}
},
"Blaze.TemplateInstance#lastNode": {
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 261,
"locus": "Client",
"longname": "Blaze.TemplateInstance#lastNode",
"memberof": "Blaze.TemplateInstance",
"name": "lastNode",
"scope": "instance",
"summary": "The last top-level DOM node in this template instance.",
"type": {
"names": [
"DOMNode"
]
}
},
"Blaze.TemplateInstance#subscribe": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 344,
"locus": "Client",
"longname": "Blaze.TemplateInstance#subscribe",
"memberof": "Blaze.TemplateInstance",
"name": "subscribe",
"options": [
{
"description": "Passed to Meteor.subscribe
",
"name": "onReady",
"optional": true,
"type": {
"names": [
"function"
]
}
},
{
"description": "Passed to Meteor.subscribe
",
"name": "onStop",
"optional": true,
"type": {
"names": [
"function"
]
}
},
{
"description": "The connection on which to make the\nsubscription.
",
"name": "connection",
"optional": true,
"type": {
"names": [
"DDP.Connection"
]
}
}
],
"params": [
{
"description": "Name of the subscription. Matches the name of the\nserver's publish() call.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional arguments passed to publisher function\non server.
",
"name": "arg1, arg2...",
"optional": true,
"type": {
"names": [
"Any"
]
}
},
{
"description": "If a function is passed instead of an\nobject, it is interpreted as an onReady callback.
",
"name": "options",
"optional": true,
"type": {
"names": [
"function",
"Object"
]
}
}
],
"returns": [
{
"description": "The subscription handle to the newly made\nsubscription. Call handle.stop() to manually stop the subscription, or\nhandle.ready() to find out if this particular subscription has loaded all\nof its inital data.
",
"type": {
"names": [
"SubscriptionHandle"
]
}
}
],
"scope": "instance",
"summary": "A version of [Meteor.subscribe](#meteor_subscribe) that is stopped\nwhen the template is destroyed."
},
"Blaze.TemplateInstance#subscriptionsReady": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 424,
"longname": "Blaze.TemplateInstance#subscriptionsReady",
"memberof": "Blaze.TemplateInstance",
"name": "subscriptionsReady",
"options": [],
"params": [],
"returns": [
{
"description": "True if all subscriptions on this template instance are\nready.
",
"type": {
"names": [
"Boolean"
]
}
}
],
"scope": "instance",
"summary": "A reactive function that returns true when all of the subscriptions\ncalled with [this.subscribe](#TemplateInstance-subscribe) are ready."
},
"Blaze.TemplateInstance#view": {
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 240,
"locus": "Client",
"longname": "Blaze.TemplateInstance#view",
"memberof": "Blaze.TemplateInstance",
"name": "view",
"scope": "instance",
"summary": "The [View](#blaze_view) object for this invocation of the template.",
"type": {
"names": [
"Blaze.View"
]
}
},
"Blaze.Unless": {
"filepath": "blaze/builtins.js",
"kind": "function",
"lineno": 98,
"locus": "Client",
"longname": "Blaze.Unless",
"memberof": "Blaze",
"name": "Unless",
"options": [],
"params": [
{
"description": "A function to reactively re-run. If the result is falsy, contentFunc is shown, otherwise elseFunc is shown. An empty array is considered falsy.
",
"name": "conditionFunc",
"type": {
"names": [
"function"
]
}
},
{
"description": "A Function that returns renderable content
",
"name": "contentFunc",
"type": {
"names": [
"function"
]
}
},
{
"description": "Optional. A Function that returns renderable content elseFunc is supplied, no content is shown in the "else" case.
",
"name": "elseFunc",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "An inverted [`Blaze.If`](#blaze_if)."
},
"Blaze.View": {
"filepath": "blaze/view.js",
"kind": "class",
"lineno": 43,
"locus": "Client",
"longname": "Blaze.View",
"memberof": "Blaze",
"name": "View",
"options": [],
"params": [
{
"description": "Optional. A name for this type of View. See view.name
",
"name": "name",
"optional": true,
"type": {
"names": [
"String"
]
}
},
{
"description": "A function that returns renderable content this is bound to the View.
",
"name": "renderFunction",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Constructor for a View, which represents a reactive region of DOM."
},
"Blaze.With": {
"filepath": "blaze/builtins.js",
"kind": "function",
"lineno": 13,
"locus": "Client",
"longname": "Blaze.With",
"memberof": "Blaze",
"name": "With",
"options": [],
"params": [
{
"description": "An object to use as the data context, or a function returning such an object. If a function is provided, it will be reactively re-run.
",
"name": "data",
"type": {
"names": [
"Object",
"function"
]
}
},
{
"description": "A Function that returns renderable content
",
"name": "contentFunc",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Constructs a View that renders content with a data context."
},
"Blaze.currentView": {
"filepath": "blaze/view.js",
"kind": "member",
"lineno": 532,
"locus": "Client",
"longname": "Blaze.currentView",
"memberof": "Blaze",
"name": "currentView",
"scope": "static",
"summary": "The View corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.",
"type": {
"names": [
"Blaze.View"
]
}
},
"Blaze.getData": {
"filepath": "blaze/view.js",
"kind": "function",
"lineno": 743,
"locus": "Client",
"longname": "Blaze.getData",
"memberof": "Blaze",
"name": "getData",
"options": [],
"params": [
{
"description": "Optional. An element that was rendered by a Meteor, or a View.
",
"name": "elementOrView",
"optional": true,
"type": {
"names": [
"DOMElement",
"Blaze.View"
]
}
}
],
"scope": "static",
"summary": "Returns the current data context, or the data context that was used when rendering a particular DOM element or View from a Meteor template."
},
"Blaze.getView": {
"filepath": "blaze/view.js",
"kind": "function",
"lineno": 781,
"locus": "Client",
"longname": "Blaze.getView",
"memberof": "Blaze",
"name": "getView",
"options": [],
"params": [
{
"description": "Optional. If specified, the View enclosing element is returned.
",
"name": "element",
"optional": true,
"type": {
"names": [
"DOMElement"
]
}
}
],
"scope": "static",
"summary": "Gets either the current View, or the View enclosing the given DOM element."
},
"Blaze.isTemplate": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 61,
"locus": "Client",
"longname": "Blaze.isTemplate",
"memberof": "Blaze",
"name": "isTemplate",
"options": [],
"params": [
{
"description": "The value to test.
",
"name": "value",
"type": {
"names": [
"Any"
]
}
}
],
"scope": "static",
"summary": "Returns true if `value` is a template object like `Template.myTemplate`."
},
"Blaze.remove": {
"filepath": "blaze/view.js",
"kind": "function",
"lineno": 677,
"locus": "Client",
"longname": "Blaze.remove",
"memberof": "Blaze",
"name": "remove",
"options": [],
"params": [
{
"description": "The return value from Blaze.render or Blaze.renderWithData.
",
"name": "renderedView",
"type": {
"names": [
"Blaze.View"
]
}
}
],
"scope": "static",
"summary": "Removes a rendered View from the DOM, stopping all reactive updates and event listeners on it."
},
"Blaze.render": {
"filepath": "blaze/view.js",
"kind": "function",
"lineno": 614,
"locus": "Client",
"longname": "Blaze.render",
"memberof": "Blaze",
"name": "render",
"options": [],
"params": [
{
"description": "The template (e.g. Template.myTemplate) or View object to render. If a template, a View object is constructed . If a View, it must be an unrendered View, which becomes a rendered View and is returned.
",
"name": "templateOrView",
"type": {
"names": [
"Template",
"Blaze.View"
]
}
},
{
"description": "The node that will be the parent of the rendered template. It must be an Element node.
",
"name": "parentNode",
"type": {
"names": [
"DOMNode"
]
}
},
{
"description": "Optional. If provided, must be a child of parentNode ; the template will be inserted before this node. If not provided, the template will be inserted as the last child of parentNode.
",
"name": "nextNode",
"optional": true,
"type": {
"names": [
"DOMNode"
]
}
},
{
"description": "Optional. If provided, it will be set as the rendered View's parentView
",
"name": "parentView",
"optional": true,
"type": {
"names": [
"Blaze.View"
]
}
}
],
"scope": "static",
"summary": "Renders a template or View to DOM nodes and inserts it into the DOM, returning a rendered [View](#blaze_view) which can be passed to [`Blaze.remove`](#blaze_remove)."
},
"Blaze.renderWithData": {
"filepath": "blaze/view.js",
"kind": "function",
"lineno": 665,
"locus": "Client",
"longname": "Blaze.renderWithData",
"memberof": "Blaze",
"name": "renderWithData",
"options": [],
"params": [
{
"description": "The template (e.g. Template.myTemplate) or View object to render.
",
"name": "templateOrView",
"type": {
"names": [
"Template",
"Blaze.View"
]
}
},
{
"description": "The data context to use, or a function returning a data context. If a function is provided, it will be reactively re-run.
",
"name": "data",
"type": {
"names": [
"Object",
"function"
]
}
},
{
"description": "The node that will be the parent of the rendered template. It must be an Element node.
",
"name": "parentNode",
"type": {
"names": [
"DOMNode"
]
}
},
{
"description": "Optional. If provided, must be a child of parentNode ; the template will be inserted before this node. If not provided, the template will be inserted as the last child of parentNode.
",
"name": "nextNode",
"optional": true,
"type": {
"names": [
"DOMNode"
]
}
},
{
"description": "Optional. If provided, it will be set as the rendered View's parentView
",
"name": "parentView",
"optional": true,
"type": {
"names": [
"Blaze.View"
]
}
}
],
"scope": "static",
"summary": "Renders a template or View to DOM nodes with a data context. Otherwise identical to `Blaze.render`."
},
"Blaze.toHTML": {
"filepath": "blaze/view.js",
"kind": "function",
"lineno": 698,
"locus": "Client",
"longname": "Blaze.toHTML",
"memberof": "Blaze",
"name": "toHTML",
"options": [],
"params": [
{
"description": "The template (e.g. Template.myTemplate) or View object from which to generate HTML.
",
"name": "templateOrView",
"type": {
"names": [
"Template",
"Blaze.View"
]
}
}
],
"scope": "static",
"summary": "Renders a template or View to a string of HTML."
},
"Blaze.toHTMLWithData": {
"filepath": "blaze/view.js",
"kind": "function",
"lineno": 710,
"locus": "Client",
"longname": "Blaze.toHTMLWithData",
"memberof": "Blaze",
"name": "toHTMLWithData",
"options": [],
"params": [
{
"description": "The template (e.g. Template.myTemplate) or View object from which to generate HTML.
",
"name": "templateOrView",
"type": {
"names": [
"Template",
"Blaze.View"
]
}
},
{
"description": "The data context to use, or a function returning a data context.
",
"name": "data",
"type": {
"names": [
"Object",
"function"
]
}
}
],
"scope": "static",
"summary": "Renders a template or View to HTML with a data context. Otherwise identical to `Blaze.toHTML`."
},
"CompileStep": {
"description": "The comments for this class aren't used to generate docs right now.\nThe docs live in the GitHub Wiki at: https://github.com/meteor/meteor/wiki/CompileStep-API-for-Build-Plugin-Source-Handlers
",
"kind": "class",
"longname": "CompileStep",
"name": "CompileStep",
"options": [],
"params": [],
"scope": "global",
"summary": "The object passed into Plugin.registerSourceHandler"
},
"CompileStep#addAsset": {
"kind": "function",
"longname": "CompileStep#addAsset",
"memberof": "CompileStep",
"name": "addAsset",
"options": [],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
},
{
"description": "The path at which to serve the asset.
",
"name": "path",
"type": {
"names": [
"String"
]
}
},
{
"description": "The data that should be placed in\nthe file.
",
"name": "data",
"type": {
"names": [
"Buffer",
"String"
]
}
}
],
"scope": "instance",
"summary": "Add a file to serve as-is to the browser or to include on\nthe browser, depending on the target. On the web, it will be served\nat the exact path requested. For server targets, it can be retrieved\nusing `Assets.getText` or `Assets.getBinary`."
},
"CompileStep#addHtml": {
"kind": "function",
"longname": "CompileStep#addHtml",
"memberof": "CompileStep",
"name": "addHtml",
"options": [
{
"description": "Which section of the document should\nbe appended to. Can only be "head" or "body".
",
"name": "section",
"type": {
"names": [
"String"
]
}
},
{
"description": "The content to append.
",
"name": "data",
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Works in web targets only. Add markup to the `head` or `body`\nsection of the document."
},
"CompileStep#addJavaScript": {
"kind": "function",
"longname": "CompileStep#addJavaScript",
"memberof": "CompileStep",
"name": "addJavaScript",
"options": [
{
"description": "The path at which the JavaScript file\nshould be inserted, may not be honored in case of path conflicts.
",
"name": "path",
"type": {
"names": [
"String"
]
}
},
{
"description": "The code to be added.
",
"name": "data",
"type": {
"names": [
"String"
]
}
},
{
"description": "The path that will be used in\nany error messages generated by this file, e.g. foo.js:4:1: error.
",
"name": "sourcePath",
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Add JavaScript code. The code added will only see the\nnamespaces imported by this package as runtime dependencies using\n['api.use'](#PackageAPI-use). If the file being compiled was added\nwith the bare flag, the resulting JavaScript won't be wrapped in a\nclosure."
},
"CompileStep#addStylesheet": {
"kind": "function",
"longname": "CompileStep#addStylesheet",
"memberof": "CompileStep",
"name": "addStylesheet",
"options": [],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
},
{
"description": "The requested path for the added CSS, may not be\nsatisfied if there are path conflicts.
",
"name": "path",
"type": {
"names": [
"String"
]
}
},
{
"description": "The content of the stylesheet that should be\nadded.
",
"name": "data",
"type": {
"names": [
"String"
]
}
},
{
"description": "A stringified JSON sourcemap, in case the\nstylesheet was generated from a different file.
",
"name": "sourceMap",
"type": {
"names": [
"String"
]
}
}
],
"scope": "instance",
"summary": "Web targets only. Add a stylesheet to the document."
},
"CompileStep#arch": {
"kind": "member",
"longname": "CompileStep#arch",
"memberof": "CompileStep",
"name": "arch",
"scope": "instance",
"summary": "The architecture for which we are building. Can be \"os\",\n\"web.browser\", or \"web.cordova\".",
"type": {
"names": [
"String"
]
}
},
"CompileStep#declaredExports": {
"kind": "member",
"longname": "CompileStep#declaredExports",
"memberof": "CompileStep",
"name": "declaredExports",
"scope": "instance",
"summary": "The list of exports that the current package has defined.\nCan be used to treat those symbols differently during compilation.",
"type": {
"names": [
"Object"
]
}
},
"CompileStep#error": {
"kind": "function",
"longname": "CompileStep#error",
"memberof": "CompileStep",
"name": "error",
"options": [],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
},
{
"description": "The error message to display.
",
"name": "message",
"type": {
"names": [
"String"
]
}
},
{
"description": "The path to display in the error message.
",
"name": "sourcePath",
"optional": true,
"type": {
"names": [
"String"
]
}
},
{
"description": "The line number to display in the error message.
",
"name": "line",
"type": {
"names": [
"Integer"
]
}
},
{
"description": "The function name to display in the error message.
",
"name": "func",
"type": {
"names": [
"String"
]
}
}
],
"scope": "instance",
"summary": "Display a build error."
},
"CompileStep#fileOptions": {
"kind": "member",
"longname": "CompileStep#fileOptions",
"memberof": "CompileStep",
"name": "fileOptions",
"scope": "instance",
"summary": "Any options passed to \"api.addFiles\".",
"type": {
"names": [
"Object"
]
}
},
"CompileStep#fullInputPath": {
"kind": "member",
"longname": "CompileStep#fullInputPath",
"memberof": "CompileStep",
"name": "fullInputPath",
"scope": "instance",
"summary": "The filename and absolute path of the input file.\nPlease don't use this filename to read the file from disk, instead\nuse [compileStep.read](CompileStep-read).",
"type": {
"names": [
"String"
]
}
},
"CompileStep#inputPath": {
"kind": "member",
"longname": "CompileStep#inputPath",
"memberof": "CompileStep",
"name": "inputPath",
"scope": "instance",
"summary": "The filename and relative path of the input file.\nPlease don't use this filename to read the file from disk, instead\nuse [compileStep.read](CompileStep-read).",
"type": {
"names": [
"String"
]
}
},
"CompileStep#inputSize": {
"kind": "member",
"longname": "CompileStep#inputSize",
"memberof": "CompileStep",
"name": "inputSize",
"scope": "instance",
"summary": "The total number of bytes in the input file.",
"type": {
"names": [
"Integer"
]
}
},
"CompileStep#packageName": {
"kind": "member",
"longname": "CompileStep#packageName",
"memberof": "CompileStep",
"name": "packageName",
"scope": "instance",
"summary": "The name of the package in which the file being built exists.",
"type": {
"names": [
"String"
]
}
},
"CompileStep#pathForSourceMap": {
"kind": "member",
"longname": "CompileStep#pathForSourceMap",
"memberof": "CompileStep",
"name": "pathForSourceMap",
"scope": "instance",
"summary": "If you are generating a sourcemap for the compiled file, use\nthis path for the original file in the sourcemap.",
"type": {
"names": [
"String"
]
}
},
"CompileStep#read": {
"kind": "function",
"longname": "CompileStep#read",
"memberof": "CompileStep",
"name": "read",
"options": [],
"params": [
{
"description": "The number of bytes to return.
",
"name": "n",
"optional": true,
"type": {
"names": [
"Integer"
]
}
}
],
"returns": [
{
"type": {
"names": [
"Buffer"
]
}
}
],
"scope": "instance",
"summary": "Read from the input file. If `n` is specified, returns the\nnext `n` bytes of the file as a Buffer. XXX not sure if this actually\nreturns a String sometimes..."
},
"CompileStep#rootOutputPath": {
"kind": "member",
"longname": "CompileStep#rootOutputPath",
"memberof": "CompileStep",
"name": "rootOutputPath",
"scope": "instance",
"summary": "On web targets, this will be the root URL prepended\nto the paths you pick for your output files. For example,\nit could be \"/packages/my-package\".",
"type": {
"names": [
"String"
]
}
},
"Cordova": {
"kind": "namespace",
"longname": "Cordova",
"name": "Cordova",
"scope": "global",
"summary": "The Cordova object in package.js."
},
"Cordova.depends": {
"kind": "function",
"locus": "package.js",
"longname": "Cordova.depends",
"memberof": "Cordova",
"name": "depends",
"options": [],
"params": [
{
"description": "An object where the keys are plugin\nnames and the values are version numbers or GitHub tarball URLs\nin string form.\nExample:
\nCordova.depends({\n "org.apache.cordova.camera": "0.3.0"\n});Alternatively, with a GitHub URL:
\nCordova.depends({\n "org.apache.cordova.camera":\n "https://github.com/apache/cordova-plugin-camera/tarball/d84b875c"\n});The URL of another Meteor application.
",
"name": "url",
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Connect to the server of a different Meteor application to subscribe to its document sets and invoke its remote methods."
},
"DDPCommon": {
"filepath": "ddp-common/namespace.js",
"kind": "namespace",
"lineno": 1,
"longname": "DDPCommon",
"name": "DDPCommon",
"scope": "global",
"summary": "Namespace for DDPCommon-related methods/classes. Shared between \n`ddp-client` and `ddp-server`, where the ddp-client is the implementation\nof a ddp client for both client AND server; and the ddp server is the\nimplementation of the livedata server and stream server. Common \nfunctionality shared between both can be shared under this namespace"
},
"DDPCommon.MethodInvocation": {
"filepath": "ddp-common/method_invocation.js",
"instancename": "this",
"kind": "function",
"lineno": 9,
"longname": "DDPCommon.MethodInvocation",
"memberof": "DDPCommon",
"name": "MethodInvocation",
"options": [],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "The state for a single invocation of a method, referenced by this\ninside a method definition."
},
"DDPCommon.MethodInvocation#connection": {
"filepath": "ddp-common/method_invocation.js",
"kind": "member",
"lineno": 53,
"locus": "Server",
"longname": "DDPCommon.MethodInvocation#connection",
"memberof": "DDPCommon.MethodInvocation",
"name": "connection",
"scope": "instance",
"summary": "Access inside a method invocation. The [connection](#meteor_onconnection) that this method was received on. `null` if the method is not associated with a connection, eg. a server initiated method call."
},
"DDPCommon.MethodInvocation#isSimulation": {
"filepath": "ddp-common/method_invocation.js",
"kind": "member",
"lineno": 20,
"locus": "Anywhere",
"longname": "DDPCommon.MethodInvocation#isSimulation",
"memberof": "DDPCommon.MethodInvocation",
"name": "isSimulation",
"scope": "instance",
"summary": "Access inside a method invocation. Boolean value, true if this invocation is a stub.",
"type": {
"names": [
"Boolean"
]
}
},
"DDPCommon.MethodInvocation#setUserId": {
"filepath": "ddp-common/method_invocation.js",
"kind": "function",
"lineno": 89,
"locus": "Server",
"longname": "DDPCommon.MethodInvocation#setUserId",
"memberof": "DDPCommon.MethodInvocation",
"name": "setUserId",
"options": [],
"params": [
{
"description": "The value that should be returned by userId on this connection.
",
"name": "userId",
"type": {
"names": [
"String",
"null"
]
}
}
],
"scope": "instance",
"summary": "Set the logged in user."
},
"DDPCommon.MethodInvocation#unblock": {
"filepath": "ddp-common/method_invocation.js",
"kind": "function",
"lineno": 76,
"locus": "Server",
"longname": "DDPCommon.MethodInvocation#unblock",
"memberof": "DDPCommon.MethodInvocation",
"name": "unblock",
"options": [],
"params": [],
"scope": "instance",
"summary": "Call inside a method invocation. Allow subsequent method from this client to begin running in a new fiber."
},
"DDPCommon.MethodInvocation#userId": {
"filepath": "ddp-common/method_invocation.js",
"kind": "member",
"lineno": 38,
"locus": "Anywhere",
"longname": "DDPCommon.MethodInvocation#userId",
"memberof": "DDPCommon.MethodInvocation",
"name": "userId",
"scope": "instance",
"summary": "The id of the user that made this method call, or `null` if no user was logged in."
},
"DDPRateLimiter.addRule": {
"filepath": "ddp-rate-limiter/ddp-rate-limiter.js",
"kind": "function",
"lineno": 67,
"longname": "DDPRateLimiter.addRule",
"memberof": "DDPRateLimiter",
"name": "addRule",
"options": [],
"params": [
{
"description": "Matchers specify which events are counted towards a rate limit. A matcher\n is an object that has a subset of the same properties as the event objects\n described above. Each value in a matcher object is one of the following:
\n\na string: for the event to satisfy the matcher, this value must be equal\nto the value of the same property in the event object
\na function: for the event to satisfy the matcher, the function must\nevaluate to true when passed the value of the same property\nin the event object
\n \nHere's how events are counted: Each event that satisfies the matcher's\nfilter is mapped to a bucket. Buckets are uniquely determined by the\nevent object's values for all properties present in both the matcher and\nevent objects.
",
"name": "matcher",
"type": {
"names": [
"Object"
]
}
},
{
"description": "number of requests allowed per time interval.\nDefault = 10.
",
"name": "numRequests",
"type": {
"names": [
"number"
]
}
},
{
"description": "time interval in milliseconds after which\nrule's counters are reset. Default = 1000.
",
"name": "timeInterval",
"type": {
"names": [
"number"
]
}
}
],
"scope": "static",
"summary": "Add a rule that matches against a stream of events describing method or\nsubscription attempts. Each event is an object with the following\nproperties:\n\n- `type`: Either \"method\" or \"subscription\"\n- `name`: The name of the method or subscription being called\n- `userId`: The user ID attempting the method or subscription\n- `connectionId`: A string representing the user's DDP connection\n- `clientAddress`: The IP address of the user\n\nReturns unique `ruleId` that can be passed to `removeRule`."
},
"DDPRateLimiter.removeRule": {
"filepath": "ddp-rate-limiter/ddp-rate-limiter.js",
"kind": "function",
"lineno": 81,
"longname": "DDPRateLimiter.removeRule",
"memberof": "DDPRateLimiter",
"name": "removeRule",
"options": [],
"params": [
{
"description": "'ruleId' returned from addRule
",
"name": "id",
"type": {
"names": [
"string"
]
}
}
],
"returns": [
{
"description": "True if a rule was removed.
",
"type": {
"names": [
"boolean"
]
}
}
],
"scope": "static",
"summary": "Removes the specified rule from the rate limiter. If rule had\nhit a rate limit, that limit is removed as well."
},
"DDPRateLimiter.setErrorMessage": {
"filepath": "ddp-rate-limiter/ddp-rate-limiter.js",
"kind": "function",
"lineno": 27,
"longname": "DDPRateLimiter.setErrorMessage",
"memberof": "DDPRateLimiter",
"name": "setErrorMessage",
"options": [],
"params": [
{
"description": "Functions are passed in an object with a\ntimeToReset field that specifies the number of milliseconds until the next\nmethod or subscription is allowed to run. The function must return a string\nof the error message.
",
"name": "message",
"type": {
"names": [
"string",
"function"
]
}
}
],
"scope": "static",
"summary": "Set error message text when method or subscription rate limit\nexceeded."
},
"EJSON": {
"filepath": "ejson/ejson.js",
"kind": "namespace",
"lineno": 5,
"longname": "EJSON",
"name": "EJSON",
"scope": "global",
"summary": "Namespace for EJSON functions"
},
"EJSON.CustomType": {
"filepath": "ejson/ejson.js",
"instancename": "customType",
"kind": "class",
"lineno": 11,
"longname": "EJSON.CustomType",
"memberof": "EJSON",
"name": "CustomType",
"options": [],
"params": [],
"scope": "static",
"summary": "The interface that a class must satisfy to be able to become an\nEJSON custom type via EJSON.addType."
},
"EJSON.CustomType#clone": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 35,
"locus": "Anywhere",
"longname": "EJSON.CustomType#clone",
"memberof": "EJSON.CustomType",
"name": "clone",
"options": [],
"params": [],
"scope": "instance",
"summary": "Return a value `r` such that `this.equals(r)` is true, and modifications to `r` do not affect `this` and vice versa."
},
"EJSON.CustomType#equals": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 43,
"locus": "Anywhere",
"longname": "EJSON.CustomType#equals",
"memberof": "EJSON.CustomType",
"name": "equals",
"options": [],
"params": [
{
"description": "Another object to compare this to.
",
"name": "other",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Return `true` if `other` has a value equal to `this`; `false` otherwise."
},
"EJSON.CustomType#toJSONValue": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 27,
"locus": "Anywhere",
"longname": "EJSON.CustomType#toJSONValue",
"memberof": "EJSON.CustomType",
"name": "toJSONValue",
"options": [],
"params": [],
"scope": "instance",
"summary": "Serialize this instance into a JSON-compatible value."
},
"EJSON.CustomType#typeName": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 19,
"locus": "Anywhere",
"longname": "EJSON.CustomType#typeName",
"memberof": "EJSON.CustomType",
"name": "typeName",
"options": [],
"params": [],
"scope": "instance",
"summary": "Return the tag used to identify this type. This must match the tag used to register this type with [`EJSON.addType`](#ejson_add_type)."
},
"EJSON.addType": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 72,
"locus": "Anywhere",
"longname": "EJSON.addType",
"memberof": "EJSON",
"name": "addType",
"options": [],
"params": [
{
"description": "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.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "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.
",
"name": "factory",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Add a custom datatype to EJSON."
},
"EJSON.clone": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 462,
"locus": "Anywhere",
"longname": "EJSON.clone",
"memberof": "EJSON",
"name": "clone",
"options": [],
"params": [
{
"description": "A value to copy.
",
"name": "val",
"type": {
"names": [
"EJSON"
]
}
}
],
"scope": "static",
"summary": "Return a deep copy of `val`."
},
"EJSON.equals": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 376,
"locus": "Anywhere",
"longname": "EJSON.equals",
"memberof": "EJSON",
"name": "equals",
"options": [
{
"description": "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.
",
"name": "keyOrderSensitive",
"type": {
"names": [
"Boolean"
]
}
}
],
"params": [
{
"name": "a",
"type": {
"names": [
"EJSON"
]
}
},
{
"name": "b",
"type": {
"names": [
"EJSON"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"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."
},
"EJSON.fromJSONValue": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 317,
"locus": "Anywhere",
"longname": "EJSON.fromJSONValue",
"memberof": "EJSON",
"name": "fromJSONValue",
"options": [],
"params": [
{
"description": "A value to deserialize into EJSON.
",
"name": "val",
"type": {
"names": [
"JSONCompatible"
]
}
}
],
"scope": "static",
"summary": "Deserialize an EJSON value from its plain JSON representation."
},
"EJSON.isBinary": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 363,
"locus": "Anywhere",
"longname": "EJSON.isBinary",
"memberof": "EJSON",
"name": "isBinary",
"options": [],
"params": [
{
"description": "The variable to check.
",
"name": "x",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Returns true if `x` is a buffer of binary data, as returned from [`EJSON.newBinary`](#ejson_new_binary)."
},
"EJSON.newBinary": {
"filepath": "ejson/ejson.js",
"kind": "member",
"lineno": 516,
"locus": "Anywhere",
"longname": "EJSON.newBinary",
"memberof": "EJSON",
"name": "newBinary",
"params": [
{
"description": "The number of bytes of binary data to allocate.
",
"name": "size",
"type": {
"names": [
"Number"
]
}
}
],
"scope": "static",
"summary": "Allocate a new buffer of binary data that EJSON can serialize."
},
"EJSON.parse": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 352,
"locus": "Anywhere",
"longname": "EJSON.parse",
"memberof": "EJSON",
"name": "parse",
"options": [],
"params": [
{
"description": "A string to parse into an EJSON value.
",
"name": "str",
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Parse a string into an EJSON value. Throws an error if the string is not valid EJSON."
},
"EJSON.stringify": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 338,
"locus": "Anywhere",
"longname": "EJSON.stringify",
"memberof": "EJSON",
"name": "stringify",
"options": [
{
"description": "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.
",
"name": "indent",
"type": {
"names": [
"Boolean",
"Integer",
"String"
]
}
},
{
"description": "When true, stringifies keys in an object in sorted order.
",
"name": "canonical",
"type": {
"names": [
"Boolean"
]
}
}
],
"params": [
{
"description": "A value to stringify.
",
"name": "val",
"type": {
"names": [
"EJSON"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"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`."
},
"EJSON.toJSONValue": {
"filepath": "ejson/ejson.js",
"kind": "function",
"lineno": 248,
"locus": "Anywhere",
"longname": "EJSON.toJSONValue",
"memberof": "EJSON",
"name": "toJSONValue",
"options": [],
"params": [
{
"description": "A value to serialize to plain JSON.
",
"name": "val",
"type": {
"names": [
"EJSON"
]
}
}
],
"scope": "static",
"summary": "Serialize an EJSON-compatible value into its plain JSON representation."
},
"Email.send": {
"filepath": "email/email.js",
"kind": "function",
"lineno": 142,
"locus": "Server",
"longname": "Email.send",
"memberof": "Email",
"name": "send",
"options": [
{
"description": ""From:" address (required)
",
"name": "from",
"type": {
"names": [
"String"
]
}
},
{
"description": ""To:", "Cc:", "Bcc:", and "Reply-To:" addresses
",
"name": "to, cc, bcc, replyTo",
"type": {
"names": [
"String",
"Array."
]
}
},
{
"description": ""Subject:" line
",
"name": "subject",
"optional": true,
"type": {
"names": [
"String"
]
}
},
{
"description": "Mail body (in plain text and/or HTML)
",
"name": "text, html",
"optional": true,
"type": {
"names": [
"String"
]
}
},
{
"description": "Dictionary of custom headers
",
"name": "headers",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Array of attachment objects, as\ndescribed in the mailcomposer documentation .
",
"name": "attachments",
"optional": true,
"type": {
"names": [
"Array."
]
}
},
{
"description": "A MailComposer \nobject representing the message to be sent. Overrides all other options. You\ncan access the mailcomposer npm module at\nEmailInternals.NpmModules.mailcomposer.module.
",
"name": "mailComposer",
"optional": true,
"type": {
"names": [
"MailComposer"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Send an email. Throws an `Error` on failure to contact mail server\nor if mail server returns an error. All fields should match\n[RFC5322](http://tools.ietf.org/html/rfc5322) specification."
},
"HTTP.call": {
"filepath": "http/httpcall_client.js",
"kind": "function",
"lineno": 19,
"locus": "Anywhere",
"longname": "HTTP.call",
"memberof": "HTTP",
"name": "call",
"options": [
{
"description": "String to use as the HTTP request body.
",
"name": "content",
"type": {
"names": [
"String"
]
}
},
{
"description": "JSON-able object to stringify and use as the HTTP request body. Overwrites content.
",
"name": "data",
"type": {
"names": [
"Object"
]
}
},
{
"description": "Query string to go in the URL. Overwrites any query string in url.
",
"name": "query",
"type": {
"names": [
"String"
]
}
},
{
"description": "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.
",
"name": "params",
"type": {
"names": [
"Object"
]
}
},
{
"description": "HTTP basic authentication string of the form "username:password"
",
"name": "auth",
"type": {
"names": [
"String"
]
}
},
{
"description": "Dictionary of strings, headers to add to the HTTP request.
",
"name": "headers",
"type": {
"names": [
"Object"
]
}
},
{
"description": "Maximum time in milliseconds to wait for the request before failing. There is no timeout by default.
",
"name": "timeout",
"type": {
"names": [
"Number"
]
}
},
{
"description": "If true, transparently follow HTTP redirects. Cannot be set to false on the client. Default true.
",
"name": "followRedirects",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "On the server, HTTP.call is implemented by using the npm request module . Any options in this object will be passed directly to the request invocation.
",
"name": "npmRequestOptions",
"type": {
"names": [
"Object"
]
}
},
{
"description": "On the client, this will be called before the request is sent to allow for more direct manipulation of the underlying XMLHttpRequest object, which will be passed as the first argument. If the callback returns false, the request will be not be send.
",
"name": "beforeSend",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"description": "The HTTP method to use, such as "GET", "POST", or "HEAD".
",
"name": "method",
"type": {
"names": [
"String"
]
}
},
{
"description": "The URL to retrieve.
",
"name": "url",
"type": {
"names": [
"String"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Optional callback. If passed, the method runs asynchronously, instead of synchronously, and calls asyncCallback. On the client, this callback is required.
",
"name": "asyncCallback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Perform an outbound HTTP request."
},
"HTTP.del": {
"filepath": "http/httpcall_common.js",
"kind": "function",
"lineno": 78,
"locus": "Anywhere",
"longname": "HTTP.del",
"memberof": "HTTP",
"name": "del",
"options": [],
"params": [
{
"description": "The URL to which the request should be sent.
",
"name": "url",
"type": {
"names": [
"String"
]
}
},
{
"description": "Options passed on to HTTP.call
",
"name": "callOptions",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Callback that is called when the request is completed. Required on the client.
",
"name": "asyncCallback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Send an HTTP `DELETE` request. Equivalent to calling [`HTTP.call`](#http_call) with \"DELETE\" as the first argument. (Named `del` to avoid conflic with the Javascript keyword `delete`)"
},
"HTTP.get": {
"filepath": "http/httpcall_common.js",
"kind": "function",
"lineno": 45,
"locus": "Anywhere",
"longname": "HTTP.get",
"memberof": "HTTP",
"name": "get",
"options": [],
"params": [
{
"description": "The URL to which the request should be sent.
",
"name": "url",
"type": {
"names": [
"String"
]
}
},
{
"description": "Options passed on to HTTP.call
",
"name": "callOptions",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Callback that is called when the request is completed. Required on the client.
",
"name": "asyncCallback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Send an HTTP `GET` request. Equivalent to calling [`HTTP.call`](#http_call) with \"GET\" as the first argument."
},
"HTTP.post": {
"filepath": "http/httpcall_common.js",
"kind": "function",
"lineno": 56,
"locus": "Anywhere",
"longname": "HTTP.post",
"memberof": "HTTP",
"name": "post",
"options": [],
"params": [
{
"description": "The URL to which the request should be sent.
",
"name": "url",
"type": {
"names": [
"String"
]
}
},
{
"description": "Options passed on to HTTP.call
",
"name": "callOptions",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Callback that is called when the request is completed. Required on the client.
",
"name": "asyncCallback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Send an HTTP `POST` request. Equivalent to calling [`HTTP.call`](#http_call) with \"POST\" as the first argument."
},
"HTTP.put": {
"filepath": "http/httpcall_common.js",
"kind": "function",
"lineno": 67,
"locus": "Anywhere",
"longname": "HTTP.put",
"memberof": "HTTP",
"name": "put",
"options": [],
"params": [
{
"description": "The URL to which the request should be sent.
",
"name": "url",
"type": {
"names": [
"String"
]
}
},
{
"description": "Options passed on to HTTP.call
",
"name": "callOptions",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Callback that is called when the request is completed. Required on the client.
",
"name": "asyncCallback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Send an HTTP `PUT` request. Equivalent to calling [`HTTP.call`](#http_call) with \"PUT\" as the first argument."
},
"InputFile#addAsset": {
"kind": "function",
"longname": "InputFile#addAsset",
"memberof": "InputFile",
"name": "addAsset",
"options": [
{
"description": "The path at which to serve the asset.
",
"name": "path",
"type": {
"names": [
"String"
]
}
},
{
"description": "The data that should be placed in the\nfile.
",
"name": "data",
"type": {
"names": [
"Buffer",
"String"
]
}
},
{
"description": "Optionally, supply a hash for the output\nfile.
",
"name": "hash",
"optional": true,
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Add a file to serve as-is to the browser or to include on\nthe browser, depending on the target. On the web, it will be served\nat the exact path requested. For server targets, it can be retrieved\nusing `Assets.getText` or `Assets.getBinary`."
},
"InputFile#addHtml": {
"kind": "function",
"longname": "InputFile#addHtml",
"memberof": "InputFile",
"name": "addHtml",
"options": [
{
"description": "Which section of the document should\nbe appended to. Can only be "head" or "body".
",
"name": "section",
"type": {
"names": [
"String"
]
}
},
{
"description": "The content to append.
",
"name": "data",
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Works in web targets only. Add markup to the `head` or `body`\nsection of the document."
},
"InputFile#addJavaScript": {
"kind": "function",
"longname": "InputFile#addJavaScript",
"memberof": "InputFile",
"name": "addJavaScript",
"options": [
{
"description": "The path at which the JavaScript file\nshould be inserted, may not be honored in case of path conflicts.
",
"name": "path",
"type": {
"names": [
"String"
]
}
},
{
"description": "The code to be added.
",
"name": "data",
"type": {
"names": [
"String"
]
}
},
{
"description": "A stringified JSON\nsourcemap, in case the JavaScript file was generated from a\ndifferent file.
",
"name": "sourceMap",
"type": {
"names": [
"String",
"Object"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Add JavaScript code. The code added will only see the\nnamespaces imported by this package as runtime dependencies using\n['api.use'](#PackageAPI-use). If the file being compiled was added\nwith the bare flag, the resulting JavaScript won't be wrapped in a\nclosure."
},
"InputFile#addStylesheet": {
"kind": "function",
"longname": "InputFile#addStylesheet",
"memberof": "InputFile",
"name": "addStylesheet",
"options": [
{
"description": "The requested path for the added CSS, may not\nbe satisfied if there are path conflicts.
",
"name": "path",
"type": {
"names": [
"String"
]
}
},
{
"description": "The content of the stylesheet that should be\nadded.
",
"name": "data",
"type": {
"names": [
"String"
]
}
},
{
"description": "A stringified JSON\nsourcemap, in case the stylesheet was generated from a different\nfile.
",
"name": "sourceMap",
"type": {
"names": [
"String",
"Object"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Web targets only. Add a stylesheet to the document. Not available\nfor linter build plugins."
},
"InputFile#getPathInBundle": {
"kind": "function",
"longname": "InputFile#getPathInBundle",
"memberof": "InputFile",
"name": "getPathInBundle",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "instance",
"summary": "Returns the path of the compiled file in the bundle."
},
"InputFile#getSourceMap": {
"kind": "function",
"longname": "InputFile#getSourceMap",
"memberof": "InputFile",
"name": "getSourceMap",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "instance",
"summary": "Returns the source-map associated with the file."
},
"InputFile.error": {
"kind": "function",
"longname": "InputFile.error",
"memberof": "InputFile",
"name": "error",
"options": [
{
"description": "The error message to display.
",
"name": "message",
"type": {
"names": [
"String"
]
}
},
{
"description": "The path to display in the error message.
",
"name": "sourcePath",
"optional": true,
"type": {
"names": [
"String"
]
}
},
{
"description": "The line number to display in the error message.
",
"name": "line",
"type": {
"names": [
"Integer"
]
}
},
{
"description": "The function name to display in the error message.
",
"name": "func",
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Call this method to raise a compilation or linting error for the\nfile."
},
"InputFile.getArch": {
"kind": "function",
"longname": "InputFile.getArch",
"memberof": "InputFile",
"name": "getArch",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns the architecture that is targeted while processing this\nfile."
},
"InputFile.getBasename": {
"kind": "function",
"longname": "InputFile.getBasename",
"memberof": "InputFile",
"name": "getBasename",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns the filename of the file."
},
"InputFile.getContentsAsBuffer": {
"kind": "function",
"longname": "InputFile.getContentsAsBuffer",
"memberof": "InputFile",
"name": "getContentsAsBuffer",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"Buffer"
]
}
}
],
"scope": "static",
"summary": "Returns the full contents of the file as a buffer."
},
"InputFile.getContentsAsString": {
"kind": "function",
"longname": "InputFile.getContentsAsString",
"memberof": "InputFile",
"name": "getContentsAsString",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns the full contents of the file as a string."
},
"InputFile.getDeclaredExports": {
"kind": "function",
"longname": "InputFile.getDeclaredExports",
"memberof": "InputFile",
"name": "getDeclaredExports",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"Array."
]
}
}
],
"scope": "static",
"summary": "Returns a list of symbols declared as exports in this target. The\nresult of `api.export('symbol')` calls in target's control file such as\npackage.js."
},
"InputFile.getDirname": {
"kind": "function",
"longname": "InputFile.getDirname",
"memberof": "InputFile",
"name": "getDirname",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns the directory path relative to the package or app root.\nThe returned path always uses forward slashes."
},
"InputFile.getDisplayPath": {
"kind": "function",
"longname": "InputFile.getDisplayPath",
"memberof": "InputFile",
"name": "getDisplayPath",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns a relative path that can be used to form error messages or\nother display properties. Can be used as an input to a source map."
},
"InputFile.getPackageName": {
"kind": "function",
"longname": "InputFile.getPackageName",
"memberof": "InputFile",
"name": "getPackageName",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns the name of the package or `null` if the file is not in a\npackage."
},
"InputFile.getPathInPackage": {
"kind": "function",
"longname": "InputFile.getPathInPackage",
"memberof": "InputFile",
"name": "getPathInPackage",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns the relative path of file to the package or app root\ndirectory. The returned path always uses forward slashes."
},
"InputFile.getSourceHash": {
"kind": "function",
"longname": "InputFile.getSourceHash",
"memberof": "InputFile",
"name": "getSourceHash",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Returns a hash string for the file that can be used to implement\ncaching."
},
"IterationCallback": {
"filepath": "minimongo/minimongo.js",
"kind": "typedef",
"lineno": 140,
"longname": "IterationCallback",
"name": "IterationCallback",
"params": [
{
"name": "doc",
"type": {
"names": [
"Object"
]
}
},
{
"name": "index",
"type": {
"names": [
"Number"
]
}
}
],
"scope": "global",
"type": {
"names": [
"function"
]
}
},
"Match": {
"filepath": "check/match.js",
"kind": "namespace",
"lineno": 40,
"longname": "Match",
"name": "Match",
"scope": "global",
"summary": "The namespace for all Match types and methods."
},
"Match.test": {
"filepath": "check/match.js",
"kind": "function",
"lineno": 90,
"locus": "Anywhere",
"longname": "Match.test",
"memberof": "Match",
"name": "test",
"options": [],
"params": [
{
"description": "The value to check
",
"name": "value",
"type": {
"names": [
"Any"
]
}
},
{
"description": "The pattern to match value against
",
"name": "pattern",
"type": {
"names": [
"MatchPattern"
]
}
}
],
"scope": "static",
"summary": "Returns true if the value matches the pattern."
},
"Meteor": {
"filepath": "meteor/client_environment.js",
"kind": "namespace",
"lineno": 1,
"longname": "Meteor",
"name": "Meteor",
"scope": "global",
"summary": "The Meteor namespace"
},
"Meteor.Error": {
"filepath": "meteor/errors.js",
"kind": "class",
"lineno": 78,
"locus": "Anywhere",
"longname": "Meteor.Error",
"memberof": "Meteor",
"name": "Error",
"options": [],
"params": [
{
"description": "A string code uniquely identifying this kind of error.\nThis string should be used by callers of the method to determine the\nappropriate action to take, instead of attempting to parse the reason\nor details fields. For example:
\n// on the server, pick a code unique to this error\n// the reason field should be a useful debug message\nthrow new Meteor.Error("logged-out", \n "The user must be logged in to post a comment.");\n\n// on the client\nMeteor.call("methodName", function (error) {\n // identify the error\n if (error && error.error === "logged-out") {\n // show a nice error message\n Session.set("errorMessage", "Please log in to post a comment.");\n }\n});For legacy reasons, some built-in Meteor functions such as check throw\nerrors with a number in this field.
",
"name": "error",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional. A short human-readable summary of the\nerror, like 'Not Found'.
",
"name": "reason",
"optional": true,
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional. Additional information about the error,\nlike a textual stack trace.
",
"name": "details",
"optional": true,
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "This class represents a symbolic error thrown by a method."
},
"Meteor.absoluteUrl": {
"filepath": "meteor/url_common.js",
"kind": "function",
"lineno": 10,
"locus": "Anywhere",
"longname": "Meteor.absoluteUrl",
"memberof": "Meteor",
"name": "absoluteUrl",
"options": [
{
"description": "Create an HTTPS URL.
",
"name": "secure",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "Replace localhost with 127.0.0.1. Useful for services that don't recognize localhost as a domain name.
",
"name": "replaceLocalhost",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "Override the default ROOT_URL from the server environment. For example: "http://foo.example.com"
",
"name": "rootUrl",
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"description": "A path to append to the root URL. Do not include a leading "/".
",
"name": "path",
"optional": true,
"type": {
"names": [
"String"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Generate an absolute URL pointing to the application. The server reads from the `ROOT_URL` environment variable to determine where it is running. This is taken care of automatically for apps deployed with `meteor deploy`, but must be provided when using `meteor build`."
},
"Meteor.apply": {
"filepath": "ddp-client/livedata_connection.js",
"kind": "function",
"lineno": 706,
"locus": "Anywhere",
"longname": "Meteor.apply",
"memberof": "Meteor",
"name": "apply",
"options": [
{
"description": "(Client only) If true, don't send this method until all previous method calls have completed, and don't send any subsequent method calls until this one is completed.
",
"name": "wait",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "(Client only) This callback is invoked with the error or result of the method (just like asyncCallback) as soon as the error or result is available. The local cache may not yet reflect the writes performed by the method.
",
"name": "onResultReceived",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"description": "Name of method to invoke
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "Method arguments
",
"name": "args",
"type": {
"names": [
"Array."
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Optional callback; same semantics as in Meteor.call
",
"name": "asyncCallback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Invoke a method passing an array of arguments."
},
"Meteor.call": {
"filepath": "ddp-client/livedata_connection.js",
"kind": "function",
"lineno": 665,
"locus": "Anywhere",
"longname": "Meteor.call",
"memberof": "Meteor",
"name": "call",
"options": [],
"params": [
{
"description": "Name of method to invoke
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional method arguments
",
"name": "arg1, arg2...",
"optional": true,
"type": {
"names": [
"EJSONable"
]
}
},
{
"description": "Optional callback, which is called asynchronously with the error or result after the method is complete. If not provided, the method runs synchronously if possible (see below).
",
"name": "asyncCallback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Invokes a method passing any number of arguments."
},
"Meteor.clearInterval": {
"filepath": "meteor/timers.js",
"kind": "function",
"lineno": 49,
"locus": "Anywhere",
"longname": "Meteor.clearInterval",
"memberof": "Meteor",
"name": "clearInterval",
"options": [],
"params": [
{
"description": "The handle returned by Meteor.setInterval
",
"name": "id",
"type": {
"names": [
"Number"
]
}
}
],
"scope": "static",
"summary": "Cancel a repeating function call scheduled by `Meteor.setInterval`."
},
"Meteor.clearTimeout": {
"filepath": "meteor/timers.js",
"kind": "function",
"lineno": 59,
"locus": "Anywhere",
"longname": "Meteor.clearTimeout",
"memberof": "Meteor",
"name": "clearTimeout",
"options": [],
"params": [
{
"description": "The handle returned by Meteor.setTimeout
",
"name": "id",
"type": {
"names": [
"Number"
]
}
}
],
"scope": "static",
"summary": "Cancel a function call scheduled by `Meteor.setTimeout`."
},
"Meteor.disconnect": {
"filepath": "ddp-client/livedata_connection.js",
"kind": "function",
"lineno": 1018,
"locus": "Client",
"longname": "Meteor.disconnect",
"memberof": "Meteor",
"name": "disconnect",
"options": [],
"params": [],
"scope": "static",
"summary": "Disconnect the client from the server."
},
"Meteor.isClient": {
"filepath": "meteor/client_environment.js",
"kind": "member",
"lineno": 13,
"locus": "Anywhere",
"longname": "Meteor.isClient",
"memberof": "Meteor",
"name": "isClient",
"scope": "static",
"summary": "Boolean variable. True if running in client environment.",
"type": {
"names": [
"Boolean"
]
}
},
"Meteor.isCordova": {
"filepath": "meteor/cordova_environment.js",
"kind": "member",
"lineno": 7,
"locus": "Anywhere",
"longname": "Meteor.isCordova",
"memberof": "Meteor",
"name": "isCordova",
"scope": "static",
"summary": "Boolean variable. True if running in a Cordova mobile environment.",
"type": {
"names": [
"Boolean"
]
}
},
"Meteor.isServer": {
"filepath": "meteor/client_environment.js",
"kind": "member",
"lineno": 21,
"locus": "Anywhere",
"longname": "Meteor.isServer",
"memberof": "Meteor",
"name": "isServer",
"scope": "static",
"summary": "Boolean variable. True if running in server environment.",
"type": {
"names": [
"Boolean"
]
}
},
"Meteor.loggingIn": {
"filepath": "accounts-base/accounts_client.js",
"kind": "function",
"lineno": 53,
"locus": "Client",
"longname": "Meteor.loggingIn",
"memberof": "Meteor",
"name": "loggingIn",
"options": [],
"params": [],
"scope": "static",
"summary": "True if a login method (such as `Meteor.loginWithPassword`, `Meteor.loginWithFacebook`, or `Accounts.createUser`) is currently in progress. A reactive data source."
},
"Meteor.loginWith": {
"filepath": "accounts-oauth/oauth_client.js",
"kind": "function",
"lineno": 3,
"locus": "Client",
"longname": "Meteor.loginWith",
"memberof": "Meteor",
"name": "loginWith",
"options": [
{
"description": "A list of permissions to request from the user.
",
"name": "requestPermissions",
"type": {
"names": [
"Array."
]
}
},
{
"description": "If true, asks the user for permission to act on their behalf when offline. This stores an additional offline token in the services field of the user document. Currently only supported with Google.
",
"name": "requestOfflineToken",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "If true, forces the user to approve the app's permissions, even if previously approved. Currently only supported with Google.
",
"name": "forceApprovalPrompt",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "String of the kind of prompt(s) to always show. Valid options are "consent", "none", "select_account" or a combination. i.e. "select_account+consent". Currently only supported with Google.
",
"name": "prompt",
"type": {
"names": [
"String"
]
}
},
{
"description": "An email address that the external service will use to pre-fill the login prompt. Currently only supported with Meteor developer accounts.
",
"name": "userEmail",
"type": {
"names": [
"String"
]
}
},
{
"description": "Login style ("popup" or "redirect", defaults to the login service configuration). The "popup" style opens the login page in a separate popup window, which is generally preferred because the Meteor application doesn't need to be reloaded. The "redirect" style redirects the Meteor application's window to the login page, and the login service provider redirects back to the Meteor application which is then reloaded. The "redirect" style can be used in situations where a popup window can't be opened, such as in a mobile UIWebView. The "redirect" style however relies on session storage which isn't available in Safari private mode, so the "popup" style will be forced if session storage can't be used.
",
"name": "loginStyle",
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure. The callback cannot be called if you are using the "redirect" loginStyle, because the app will have reloaded in the meantime; try using client-side login hooks instead.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Log the user in using an external service."
},
"Meteor.loginWithPassword": {
"filepath": "accounts-password/password_client.js",
"kind": "function",
"lineno": 23,
"locus": "Client",
"longname": "Meteor.loginWithPassword",
"memberof": "Meteor",
"name": "loginWithPassword",
"options": [],
"params": [
{
"description": "Either a string interpreted as a username or an email; or an object with a\n single key: email, username or id. Username or email match in a case\n insensitive manner.
",
"name": "user",
"type": {
"names": [
"Object",
"String"
]
}
},
{
"description": "The user's password.
",
"name": "password",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional callback.\n Called with no arguments on success, or with a single Error argument\n on failure.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Log the user in with a password."
},
"Meteor.logout": {
"filepath": "accounts-base/accounts_client.js",
"kind": "function",
"lineno": 256,
"locus": "Client",
"longname": "Meteor.logout",
"memberof": "Meteor",
"name": "logout",
"options": [],
"params": [
{
"description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Log the user out."
},
"Meteor.logoutOtherClients": {
"filepath": "accounts-base/accounts_client.js",
"kind": "function",
"lineno": 279,
"locus": "Client",
"longname": "Meteor.logoutOtherClients",
"memberof": "Meteor",
"name": "logoutOtherClients",
"options": [],
"params": [
{
"description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Log out other clients logged in as the current user, but does not log out the client that calls this function."
},
"Meteor.methods": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1513,
"locus": "Anywhere",
"longname": "Meteor.methods",
"memberof": "Meteor",
"name": "methods",
"options": [],
"params": [
{
"description": "Dictionary whose keys are method names and values are functions.
",
"name": "methods",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Defines functions that can be invoked over the network by clients."
},
"Meteor.onConnection": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1374,
"locus": "Server",
"longname": "Meteor.onConnection",
"memberof": "Meteor",
"name": "onConnection",
"options": [],
"params": [
{
"description": "The function to call when a new DDP connection is established.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Register a callback to be called when a new DDP connection is made to the server."
},
"Meteor.publish": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1448,
"locus": "Server",
"longname": "Meteor.publish",
"memberof": "Meteor",
"name": "publish",
"options": [],
"params": [
{
"description": "Name of the record set. If null, the set has no name, and the record set is automatically sent to all connected clients.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "Function called on the server each time a client subscribes. Inside the function, this is the publish handler object, described below. If the client passed arguments to subscribe, the function is called with the same arguments.
",
"name": "func",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Publish a record set."
},
"Meteor.reconnect": {
"filepath": "ddp-client/livedata_connection.js",
"kind": "function",
"lineno": 1008,
"locus": "Client",
"longname": "Meteor.reconnect",
"memberof": "Meteor",
"name": "reconnect",
"options": [],
"params": [],
"scope": "static",
"summary": "Force an immediate reconnection attempt if the client is not connected to the server.\n\n This method does nothing if the client is already connected."
},
"Meteor.release": {
"filepath": "meteor/helpers.js",
"kind": "member",
"lineno": 11,
"locus": "Anywhere",
"longname": "Meteor.release",
"memberof": "Meteor",
"name": "release",
"scope": "static",
"summary": "`Meteor.release` is a string containing the name of the [release](#meteorupdate) with which the project was built (for example, `\"1.2.3\"`). It is `undefined` if the project was built using a git checkout of Meteor.",
"type": {
"names": [
"String"
]
}
},
"Meteor.setInterval": {
"filepath": "meteor/timers.js",
"kind": "function",
"lineno": 39,
"locus": "Anywhere",
"longname": "Meteor.setInterval",
"memberof": "Meteor",
"name": "setInterval",
"options": [],
"params": [
{
"description": "The function to run
",
"name": "func",
"type": {
"names": [
"function"
]
}
},
{
"description": "Number of milliseconds to wait between each function call.
",
"name": "delay",
"type": {
"names": [
"Number"
]
}
}
],
"scope": "static",
"summary": "Call a function repeatedly, with a time delay between calls."
},
"Meteor.setTimeout": {
"filepath": "meteor/timers.js",
"kind": "function",
"lineno": 28,
"locus": "Anywhere",
"longname": "Meteor.setTimeout",
"memberof": "Meteor",
"name": "setTimeout",
"options": [],
"params": [
{
"description": "The function to run
",
"name": "func",
"type": {
"names": [
"function"
]
}
},
{
"description": "Number of milliseconds to wait before calling function
",
"name": "delay",
"type": {
"names": [
"Number"
]
}
}
],
"scope": "static",
"summary": "Call a function in the future after waiting for a specified delay."
},
"Meteor.settings": {
"filepath": "meteor/client_environment.js",
"kind": "member",
"lineno": 32,
"locus": "Anywhere",
"longname": "Meteor.settings",
"memberof": "Meteor",
"name": "settings",
"scope": "static",
"summary": "`Meteor.settings` contains deployment-specific configuration options. You can initialize settings by passing the `--settings` option (which takes the name of a file containing JSON data) to `meteor run` or `meteor deploy`. When running your server directly (e.g. from a bundle), you instead specify settings by putting the JSON directly into the `METEOR_SETTINGS` environment variable. If you don't provide any settings, `Meteor.settings` will be an empty object. If the settings object contains a key named `public`, then `Meteor.settings.public` will be available on the client as well as the server. All other properties of `Meteor.settings` are only defined on the server.",
"type": {
"names": [
"Object"
]
}
},
"Meteor.startup": {
"filepath": "meteor/startup_client.js",
"kind": "function",
"lineno": 57,
"locus": "Anywhere",
"longname": "Meteor.startup",
"memberof": "Meteor",
"name": "startup",
"options": [],
"params": [
{
"description": "A function to run on startup.
",
"name": "func",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Run code when a client or a server starts."
},
"Meteor.status": {
"filepath": "ddp-client/livedata_connection.js",
"kind": "function",
"lineno": 996,
"locus": "Client",
"longname": "Meteor.status",
"memberof": "Meteor",
"name": "status",
"options": [],
"params": [],
"scope": "static",
"summary": "Get the current connection status. A reactive data source."
},
"Meteor.subscribe": {
"filepath": "ddp-client/livedata_connection.js",
"kind": "function",
"lineno": 480,
"locus": "Client",
"longname": "Meteor.subscribe",
"memberof": "Meteor",
"name": "subscribe",
"options": [],
"params": [
{
"description": "Name of the subscription. Matches the name of the\nserver's publish() call.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional arguments passed to publisher\nfunction on server.
",
"name": "arg1, arg2...",
"optional": true,
"type": {
"names": [
"Any"
]
}
},
{
"description": "Optional. May include onStop\nand onReady callbacks. If there is an error, it is passed as an\nargument to onStop. If a function is passed instead of an object, it\nis interpreted as an onReady callback.
",
"name": "callbacks",
"optional": true,
"type": {
"names": [
"function",
"Object"
]
}
}
],
"scope": "static",
"summary": "Subscribe to a record set. Returns a handle that provides\n`stop()` and `ready()` methods."
},
"Meteor.user": {
"filepath": "accounts-base/accounts_common.js",
"kind": "function",
"lineno": 59,
"locus": "Anywhere but publish functions",
"longname": "Meteor.user",
"memberof": "Meteor",
"name": "user",
"options": [],
"params": [],
"scope": "static",
"summary": "Get the current user record, or `null` if no user is logged in. A reactive data source."
},
"Meteor.users": {
"filepath": "accounts-base/globals_server.js",
"kind": "member",
"lineno": 16,
"locus": "Anywhere",
"longname": "Meteor.users",
"memberof": "Meteor",
"name": "users",
"scope": "static",
"summary": "A [Mongo.Collection](#collections) containing user documents.",
"type": {
"names": [
"Mongo.Collection"
]
}
},
"Meteor.wrapAsync": {
"filepath": "meteor/helpers.js",
"kind": "function",
"lineno": 90,
"locus": "Anywhere",
"longname": "Meteor.wrapAsync",
"memberof": "Meteor",
"name": "wrapAsync",
"options": [],
"params": [
{
"description": "A function that takes a callback as its final parameter
",
"name": "func",
"type": {
"names": [
"function"
]
}
},
{
"description": "Optional this object against which the original function will be invoked
",
"name": "context",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Wrap a function that takes a callback function as its final parameter. The signature of the callback of the wrapped function should be `function(error, result){}`. On the server, the wrapped function can be used either synchronously (without passing a callback) or asynchronously (when a callback is passed). On the client, a callback is always required; errors will be logged if there is no callback. If a callback is provided, the environment captured when the original function was called will be restored in the callback."
},
"Mongo": {
"filepath": "mongo/collection.js",
"kind": "namespace",
"lineno": 8,
"longname": "Mongo",
"name": "Mongo",
"scope": "global",
"summary": "Namespace for MongoDB-related items"
},
"Mongo.Collection": {
"filepath": "mongo/collection.js",
"instancename": "collection",
"kind": "class",
"lineno": 26,
"locus": "Anywhere",
"longname": "Mongo.Collection",
"memberof": "Mongo",
"name": "Collection",
"options": [
{
"description": "The server connection that will manage this collection. Uses the default connection if not specified. Pass the return value of calling DDP.connectnull to specify no connection. Unmanaged (name is null) collections cannot specify a connection.
",
"name": "connection",
"type": {
"names": [
"Object"
]
}
},
{
"description": "The method of generating the _id fields of new documents in this collection. Possible values:
\n\nThe default id generation technique is 'STRING'.
",
"name": "idGeneration",
"type": {
"names": [
"String"
]
}
},
{
"description": "An optional transformation function. Documents will be passed through this function before being returned from fetch or findOne, and before being passed to callbacks of observe, map, forEach, allow, and deny. Transforms are not applied for the callbacks of observeChanges or to cursors returned from publish functions.
",
"name": "transform",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"description": "The name of the collection. If null, creates an unmanaged (unsynchronized) local collection.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Constructor for a Collection"
},
"Mongo.Collection#allow": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 776,
"locus": "Server",
"longname": "Mongo.Collection#allow",
"memberof": "Mongo.Collection",
"name": "allow",
"options": [
{
"description": "Functions that look at a proposed modification to the database and return true if it should be allowed.
",
"name": "insert, update, remove",
"type": {
"names": [
"function"
]
}
},
{
"description": "Optional performance enhancement. Limits the fields that will be fetched from the database for inspection by your update and remove functions.
",
"name": "fetch",
"type": {
"names": [
"Array."
]
}
},
{
"description": "Overrides transform on the Collectionnull to disable transformation.
",
"name": "transform",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Allow users to write directly to this collection from client code, subject to limitations you define."
},
"Mongo.Collection#deny": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 788,
"locus": "Server",
"longname": "Mongo.Collection#deny",
"memberof": "Mongo.Collection",
"name": "deny",
"options": [
{
"description": "Functions that look at a proposed modification to the database and return true if it should be denied, even if an allow rule says otherwise.
",
"name": "insert, update, remove",
"type": {
"names": [
"function"
]
}
},
{
"description": "Optional performance enhancement. Limits the fields that will be fetched from the database for inspection by your update and remove functions.
",
"name": "fetch",
"type": {
"names": [
"Array."
]
}
},
{
"description": "Overrides transform on the Collectionnull to disable transformation.
",
"name": "transform",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Override `allow` rules."
},
"Mongo.Collection#find": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 252,
"locus": "Anywhere",
"longname": "Mongo.Collection#find",
"memberof": "Mongo.Collection",
"name": "find",
"options": [
{
"description": "Sort order (default: natural order)
",
"name": "sort",
"type": {
"names": [
"MongoSortSpecifier"
]
}
},
{
"description": "Number of results to skip at the beginning
",
"name": "skip",
"type": {
"names": [
"Number"
]
}
},
{
"description": "Maximum number of results to return
",
"name": "limit",
"type": {
"names": [
"Number"
]
}
},
{
"description": "Dictionary of fields to return or exclude.
",
"name": "fields",
"type": {
"names": [
"MongoFieldSpecifier"
]
}
},
{
"description": "(Client only) Default true; pass false to disable reactivity
",
"name": "reactive",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "Overrides transform on the Collectionnull to disable transformation.
",
"name": "transform",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"description": "A query describing the documents to find
",
"name": "selector",
"optional": true,
"type": {
"names": [
"MongoSelector"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"returns": [
{
"type": {
"names": [
"Mongo.Cursor"
]
}
}
],
"scope": "instance",
"summary": "Find the documents in a collection that match the selector."
},
"Mongo.Collection#findOne": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 278,
"locus": "Anywhere",
"longname": "Mongo.Collection#findOne",
"memberof": "Mongo.Collection",
"name": "findOne",
"options": [
{
"description": "Sort order (default: natural order)
",
"name": "sort",
"type": {
"names": [
"MongoSortSpecifier"
]
}
},
{
"description": "Number of results to skip at the beginning
",
"name": "skip",
"type": {
"names": [
"Number"
]
}
},
{
"description": "Dictionary of fields to return or exclude.
",
"name": "fields",
"type": {
"names": [
"MongoFieldSpecifier"
]
}
},
{
"description": "(Client only) Default true; pass false to disable reactivity
",
"name": "reactive",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "Overrides transform on the Collectionnull to disable transformation.
",
"name": "transform",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"description": "A query describing the documents to find
",
"name": "selector",
"optional": true,
"type": {
"names": [
"MongoSelector"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"returns": [
{
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Finds the first document that matches the selector, as ordered by sort and skip options."
},
"Mongo.Collection#insert": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 416,
"locus": "Anywhere",
"longname": "Mongo.Collection#insert",
"memberof": "Mongo.Collection",
"name": "insert",
"options": [],
"params": [
{
"description": "The document to insert. May not yet have an _id attribute, in which case Meteor will generate one for you.
",
"name": "doc",
"type": {
"names": [
"Object"
]
}
},
{
"description": "Optional. If present, called with an error object as the first argument and, if no error, the _id as the second.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Insert a document in the collection. Returns its unique _id."
},
"Mongo.Collection#rawCollection": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 645,
"locus": "Server",
"longname": "Mongo.Collection#rawCollection",
"memberof": "Mongo.Collection",
"name": "rawCollection",
"options": [],
"params": [],
"scope": "instance",
"summary": "Returns the [`Collection`](http://mongodb.github.io/node-mongodb-native/1.4/api-generated/collection.html) object corresponding to this collection from the [npm `mongodb` driver module](https://www.npmjs.com/package/mongodb) which is wrapped by `Mongo.Collection`."
},
"Mongo.Collection#rawDatabase": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 657,
"locus": "Server",
"longname": "Mongo.Collection#rawDatabase",
"memberof": "Mongo.Collection",
"name": "rawDatabase",
"options": [],
"params": [],
"scope": "instance",
"summary": "Returns the [`Db`](http://mongodb.github.io/node-mongodb-native/1.4/api-generated/db.html) object corresponding to this collection's database connection from the [npm `mongodb` driver module](https://www.npmjs.com/package/mongodb) which is wrapped by `Mongo.Collection`."
},
"Mongo.Collection#remove": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 440,
"locus": "Anywhere",
"longname": "Mongo.Collection#remove",
"memberof": "Mongo.Collection",
"name": "remove",
"options": [],
"params": [
{
"description": "Specifies which documents to remove
",
"name": "selector",
"type": {
"names": [
"MongoSelector"
]
}
},
{
"description": "Optional. If present, called with an error object as its argument.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Remove documents from the collection"
},
"Mongo.Collection#update": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 426,
"locus": "Anywhere",
"longname": "Mongo.Collection#update",
"memberof": "Mongo.Collection",
"name": "update",
"options": [
{
"description": "True to modify all matching documents; false to only modify one of the matching documents (the default).
",
"name": "multi",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "True to insert a document if no matching documents are found.
",
"name": "upsert",
"type": {
"names": [
"Boolean"
]
}
}
],
"params": [
{
"description": "Specifies which documents to modify
",
"name": "selector",
"type": {
"names": [
"MongoSelector"
]
}
},
{
"description": "Specifies how to modify the documents
",
"name": "modifier",
"type": {
"names": [
"MongoModifier"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Optional. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Modify one or more documents in the collection. Returns the number of affected documents."
},
"Mongo.Collection#upsert": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 602,
"locus": "Anywhere",
"longname": "Mongo.Collection#upsert",
"memberof": "Mongo.Collection",
"name": "upsert",
"options": [
{
"description": "True to modify all matching documents; false to only modify one of the matching documents (the default).
",
"name": "multi",
"type": {
"names": [
"Boolean"
]
}
}
],
"params": [
{
"description": "Specifies which documents to modify
",
"name": "selector",
"type": {
"names": [
"MongoSelector"
]
}
},
{
"description": "Specifies how to modify the documents
",
"name": "modifier",
"type": {
"names": [
"MongoModifier"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "Optional. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.
",
"name": "callback",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Modify one or more documents in the collection, or insert one if no matching documents were found. Returns an object with keys `numberAffected` (the number of documents modified) and `insertedId` (the unique _id of the document that was inserted, if any)."
},
"Mongo.Cursor": {
"filepath": "mongo/collection.js",
"instancename": "cursor",
"kind": "class",
"lineno": 679,
"longname": "Mongo.Cursor",
"memberof": "Mongo",
"name": "Cursor",
"options": [],
"params": [],
"scope": "static",
"summary": "To create a cursor, use find. To access the documents in a cursor, use forEach, map, or fetch."
},
"Mongo.Cursor#count": {
"filepath": "minimongo/minimongo.js",
"kind": "function",
"lineno": 216,
"locus": "Anywhere",
"longname": "Mongo.Cursor#count",
"memberof": "Mongo.Cursor",
"name": "count",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"Number"
]
}
}
],
"scope": "instance",
"summary": "Returns the number of documents that match a query."
},
"Mongo.Cursor#fetch": {
"filepath": "minimongo/minimongo.js",
"kind": "function",
"lineno": 199,
"locus": "Anywhere",
"longname": "Mongo.Cursor#fetch",
"memberof": "Mongo.Cursor",
"name": "fetch",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"Array."
]
}
}
],
"scope": "instance",
"summary": "Return all matching documents as an Array."
},
"Mongo.Cursor#forEach": {
"filepath": "minimongo/minimongo.js",
"kind": "function",
"lineno": 145,
"locus": "Anywhere",
"longname": "Mongo.Cursor#forEach",
"memberof": "Mongo.Cursor",
"name": "forEach",
"options": [],
"params": [
{
"description": "Function to call. It will be called with three arguments: the document, a 0-based index, and cursor itself.
",
"name": "callback",
"type": {
"names": [
"IterationCallback"
]
}
},
{
"description": "An object which will be the value of this inside callback.
",
"name": "thisArg",
"optional": true,
"type": {
"names": [
"Any"
]
}
}
],
"scope": "instance",
"summary": "Call `callback` once for each matching document, sequentially and synchronously."
},
"Mongo.Cursor#map": {
"filepath": "minimongo/minimongo.js",
"kind": "function",
"lineno": 181,
"locus": "Anywhere",
"longname": "Mongo.Cursor#map",
"memberof": "Mongo.Cursor",
"name": "map",
"options": [],
"params": [
{
"description": "Function to call. It will be called with three arguments: the document, a 0-based index, and cursor itself.
",
"name": "callback",
"type": {
"names": [
"IterationCallback"
]
}
},
{
"description": "An object which will be the value of this inside callback.
",
"name": "thisArg",
"optional": true,
"type": {
"names": [
"Any"
]
}
}
],
"scope": "instance",
"summary": "Map callback over all matching documents. Returns an Array."
},
"Mongo.Cursor#observe": {
"filepath": "minimongo/minimongo.js",
"kind": "function",
"lineno": 299,
"locus": "Anywhere",
"longname": "Mongo.Cursor#observe",
"memberof": "Mongo.Cursor",
"name": "observe",
"options": [],
"params": [
{
"description": "Functions to call to deliver the result set as it changes
",
"name": "callbacks",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Watch a query. Receive callbacks as the result set changes."
},
"Mongo.Cursor#observeChanges": {
"filepath": "minimongo/minimongo.js",
"kind": "function",
"lineno": 311,
"locus": "Anywhere",
"longname": "Mongo.Cursor#observeChanges",
"memberof": "Mongo.Cursor",
"name": "observeChanges",
"options": [],
"params": [
{
"description": "Functions to call to deliver the result set as it changes
",
"name": "callbacks",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Watch a query. Receive callbacks as the result set changes. Only the differences between the old and new documents are passed to the callbacks."
},
"Mongo.ObjectID": {
"filepath": "mongo/collection.js",
"kind": "class",
"lineno": 672,
"locus": "Anywhere",
"longname": "Mongo.ObjectID",
"memberof": "Mongo",
"name": "ObjectID",
"options": [],
"params": [
{
"description": "Optional. The 24-character hexadecimal contents of the ObjectID to create
",
"name": "hexString",
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Create a Mongo-style `ObjectID`. If you don't specify a `hexString`, the `ObjectID` will generated randomly (not using MongoDB's ID construction rules)."
},
"Npm": {
"kind": "namespace",
"longname": "Npm",
"name": "Npm",
"scope": "global",
"summary": "The Npm object in package.js and package source files."
},
"Npm.depends": {
"kind": "function",
"locus": "package.js",
"longname": "Npm.depends",
"memberof": "Npm",
"name": "depends",
"options": [],
"params": [
{
"description": "An object where the keys are package\nnames and the values are version numbers in string form or URLs to a\ngit commit by SHA. You can only depend on exact versions of NPM\npackages. Example:
\nNpm.depends({\n moment: "2.8.3",\n async: "https://github.com/caolan/async/archive/71fa2638973dafd8761fa5457c472a312cc820fe.tar.gz"\n});The name of the package to require.
",
"name": "name",
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Require a package that was specified using\n`Npm.depends()`."
},
"Package": {
"kind": "namespace",
"locus": "package.js",
"longname": "Package",
"name": "Package",
"scope": "global",
"summary": "The Package object in package.js"
},
"Package.describe": {
"kind": "function",
"locus": "package.js",
"longname": "Package.describe",
"memberof": "Package",
"name": "describe",
"options": [
{
"description": "A concise 1-2 sentence description of\nthe package, required for publication.
",
"name": "summary",
"type": {
"names": [
"String"
]
}
},
{
"description": "The (extended)\nsemver version for your package. Additionally,\nMeteor allows a wrap number: a positive integer that follows the\nversion number. If you are porting another package that uses semver\nversioning, you may want to use the original version, postfixed with\n_wrapnumber. For example, 1.2.3_1 or 2.4.5-rc1_4. Wrap numbers\nsort after the original numbers: 1.2.3 < 1.2.3_1 < 1.2.3_2 <\n1.2.4-rc.0. If no version is specified, this field defaults to\n0.0.0. If you want to publish your package to the package server, you\nmust specify a version.
",
"name": "version",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional name override. By default, the\npackage name comes from the name of its directory.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional Git URL to the source repository.
",
"name": "git",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional Filepath to\ndocumentation. Set to 'README.md' by default. Set this to null to submit\nno documentation.
",
"name": "documentation",
"type": {
"names": [
"String"
]
}
},
{
"description": "A package with this flag set to true\nwill not be bundled into production builds. This is useful for packages\nmeant to be used in development only.
",
"name": "debugOnly",
"type": {
"names": [
"String"
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Provide basic package information."
},
"Package.onTest": {
"kind": "function",
"locus": "package.js",
"longname": "Package.onTest",
"memberof": "Package",
"name": "onTest",
"options": [],
"params": [
{
"description": "A function that takes in the package control 'api' object, which keeps track of dependencies and exports.
",
"name": "func",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Define dependencies and expose package methods for unit tests."
},
"Package.onUse": {
"kind": "function",
"locus": "package.js",
"longname": "Package.onUse",
"memberof": "Package",
"name": "onUse",
"options": [],
"params": [
{
"description": "A function that takes in the package control api object, which keeps track of dependencies and exports.
",
"name": "func",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Define package dependencies and expose package methods."
},
"Package.registerBuildPlugin": {
"kind": "function",
"locus": "package.js",
"longname": "Package.registerBuildPlugin",
"memberof": "Package",
"name": "registerBuildPlugin",
"options": [
{
"description": "A cosmetic name, must be unique in the\npackage.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "Meteor packages that this\nplugin uses, independent of the packages specified in\napi.onUse .
",
"name": "use",
"type": {
"names": [
"String",
"Array."
]
}
},
{
"description": "The source files that make up the\nbuild plugin, independent from api.addFiles .
",
"name": "sources",
"type": {
"names": [
"Array."
]
}
},
{
"description": "An object where the keys\nare NPM package names, and the keys are the version numbers of\nrequired NPM packages, just like in Npm.depends .
",
"name": "npmDependencies",
"type": {
"names": [
"Object"
]
}
}
],
"params": [
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Define a build plugin. A build plugin extends the build\nprocess for apps and packages that use this package. For example,\nthe `coffeescript` package uses a build plugin to compile CoffeeScript\nsource files into JavaScript."
},
"PackageAPI": {
"instancename": "api",
"kind": "class",
"longname": "PackageAPI",
"name": "PackageAPI",
"options": [],
"params": [],
"scope": "global",
"summary": "Type of the API object passed into the `Package.onUse` function."
},
"PackageAPI#addFiles": {
"kind": "function",
"locus": "package.js",
"longname": "PackageAPI#addFiles",
"memberof": "PackageAPI",
"name": "addFiles",
"options": [],
"params": [
{
"description": "Name of the source file, or array of\nstrings of source file names.
",
"name": "filename",
"type": {
"names": [
"String",
"Array."
]
}
},
{
"description": "If you only want to export the file\non the server (or the client), you can pass in the second argument\n(e.g., 'server', 'client', 'web.browser', 'web.cordova') to specify\nwhat architecture the file is used with. You can specify multiple\narchitectures by passing in an array, for example ['web.cordova', 'os.linux'].
",
"name": "architecture",
"optional": true,
"type": {
"names": [
"String",
"Array."
]
}
},
{
"description": "Options that will be passed to build\nplugins. For example, for JavaScript files, you can pass {bare: true}\nto not wrap the individual file in its own closure. To add a static asset,\npass {isAsset: true}; use the architecture parameter to determine\nif this is a client-side asset served by the HTTP server or a server-side\nasset accessible to the Assets APIs.
",
"name": "fileOptions",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Specify the source code for your package."
},
"PackageAPI#export": {
"kind": "function",
"locus": "package.js",
"longname": "PackageAPI#export",
"memberof": "PackageAPI",
"name": "export",
"options": [],
"params": [
{
"description": "Name of the object to export, or\nan array of object names.
",
"name": "exportedObjects",
"type": {
"names": [
"String",
"Array."
]
}
},
{
"description": "If you only want to export the\nobject on the server (or the client), you can pass in the second argument\n(e.g., 'server', 'client', 'web.browser', 'web.cordova') to specify what\narchitecture the export is used with. You can specify multiple\narchitectures by passing in an array, for example ['web.cordova',\n'os.linux'].
",
"name": "architecture",
"optional": true,
"type": {
"names": [
"String",
"Array."
]
}
},
{
"name": "exportOptions",
"optional": true,
"type": {
"names": [
"Object"
]
}
},
{
"description": "If true, this symbol will only be\nexported when running tests for this package.
",
"name": "exportOptions.testOnly",
"type": {
"names": [
"Boolean"
]
}
}
],
"scope": "instance",
"summary": "Export package-level variables in your package. The specified\nvariables (declared without `var` in the source code) will be available\nto packages that use this package."
},
"PackageAPI#imply": {
"kind": "function",
"locus": "package.js",
"longname": "PackageAPI#imply",
"memberof": "PackageAPI",
"name": "imply",
"options": [],
"params": [
{
"description": "Name of a package, or array of\npackage names, with an optional @version component for each.
",
"name": "packageNames",
"type": {
"names": [
"String",
"Array."
]
}
},
{
"description": "If you only use the package on\nthe server (or the client), you can pass in the second argument (e.g.,\n'server', 'client', 'web.browser', 'web.cordova') to specify what\narchitecture the package is used with. You can specify multiple\narchitectures by passing in an array, for example ['web.cordova',\n'os.linux'].
",
"name": "architecture",
"optional": true,
"type": {
"names": [
"String",
"Array."
]
}
}
],
"scope": "instance",
"summary": "Give users of this package access to another package (by passing\nin the string `packagename`) or a collection of packages (by passing in\nan array of strings [`packagename1`, `packagename2`]"
},
"PackageAPI#use": {
"kind": "function",
"locus": "package.js",
"longname": "PackageAPI#use",
"memberof": "PackageAPI",
"name": "use",
"options": [
{
"description": "Establish a weak dependency on a\npackage. If package A has a weak dependency on package B, it means\nthat including A in an app does not force B to be included too — but,\nif B is included or by another package, then B will load before A.\nYou can use this to make packages that optionally integrate with or\nenhance other packages if those packages are present.\nWhen you weakly depend on a package you don't see its exports.\nYou can detect if the possibly-present weakly-depended-on package\nis there by seeing if Package.foo exists, and get its exports\nfrom the same place.
",
"name": "weak",
"type": {
"names": [
"Boolean"
]
}
},
{
"description": "It's okay to load this dependency\nafter your package. (In general, dependencies specified by api.use\nare loaded before your package.) You can use this option to break\ncircular dependencies.
",
"name": "unordered",
"type": {
"names": [
"Boolean"
]
}
}
],
"params": [
{
"description": "Packages being depended on.\nPackage names may be suffixed with an @version tag.
\nIn general, you must specify a package's version (e.g.,\n'accounts@1.0.0' to use version 1.0.0 or a higher\ncompatible version (ex: 1.0.1, 1.5.0, etc.) of the\naccounts package). If you are sourcing core\npackages from a Meteor release with versionsFrom, you may leave\noff version names for core packages. You may also specify constraints,\nsuch as my:forms@=1.0.0 (this package demands my:forms at 1.0.0 exactly),\nor my:forms@1.0.0 || =2.0.1 (my:forms at 1.x.y, or exactly 2.0.1).
",
"name": "packageNames",
"type": {
"names": [
"String",
"Array."
]
}
},
{
"description": "If you only use the package on the\nserver (or the client), you can pass in the second argument (e.g.,\n'server', 'client', 'web.browser', 'web.cordova') to specify\nwhat architecture the package is used with. You can specify multiple\narchitectures by passing in an array, for example ['web.cordova', 'os.linux'].
",
"name": "architecture",
"optional": true,
"type": {
"names": [
"String",
"Array."
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Depend on package `packagename`."
},
"PackageAPI#versionsFrom": {
"kind": "function",
"locus": "package.js",
"longname": "PackageAPI#versionsFrom",
"memberof": "PackageAPI",
"name": "versionsFrom",
"options": [],
"params": [
{
"description": "Specification of a release:\ntrack@version. Just 'version' (e.g. "0.9.0") is sufficient if using the\ndefault release track METEOR. Can be an array of specifications.
",
"name": "meteorRelease",
"type": {
"names": [
"String",
"Array."
]
}
}
],
"scope": "instance",
"summary": "Use versions of core packages from a release. Unless provided,\nall packages will default to the versions released along with\n`meteorRelease`. This will save you from having to figure out the exact\nversions of the core packages you want to use. For example, if the newest\nrelease of meteor is `METEOR@0.9.0` and it includes `jquery@1.0.0`, you\ncan write `api.versionsFrom('METEOR@0.9.0')` in your package, and when you\nlater write `api.use('jquery')`, it will be equivalent to\n`api.use('jquery@1.0.0')`. You may specify an array of multiple releases,\nin which case the default value for constraints will be the \"or\" of the\nversions from each release: `api.versionsFrom(['METEOR@0.9.0',\n'METEOR@0.9.5'])` may cause `api.use('jquery')` to be interpreted as\n`api.use('jquery@1.0.0 || 2.0.0')`."
},
"Plugin": {
"kind": "namespace",
"longname": "Plugin",
"name": "Plugin",
"scope": "global",
"summary": "The namespace that is exposed inside build plugin files."
},
"Plugin.registerCompiler": {
"kind": "function",
"locus": "Build Plugin",
"longname": "Plugin.registerCompiler",
"memberof": "Plugin",
"name": "registerCompiler",
"options": [
{
"description": "The file extensions that this\nplugin should handle, without the first dot.\nExamples: ["coffee", "coffee.md"].
",
"name": "extensions",
"type": {
"names": [
"Array."
]
}
},
{
"description": "The list of filenames\nthat this plugin should handle. Examples: ["config.json"].
",
"name": "filenames",
"type": {
"names": [
"Array."
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
},
{
"description": "A function that returns an instance\nof a compiler class.
\nMore detailed documentation for build plugins is available on the GitHub Wiki .
",
"name": "factory",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a compiler that will handle files with certain extensions or\nfilenames."
},
"Plugin.registerLinter": {
"kind": "function",
"locus": "Build Plugin",
"longname": "Plugin.registerLinter",
"memberof": "Plugin",
"name": "registerLinter",
"options": [
{
"description": "The file extensions that this\nplugin should handle, without the first dot.\nExamples: ["js", "es6", "jsx"].
",
"name": "extensions",
"type": {
"names": [
"Array."
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
},
{
"description": "A function that returns an instance\nof a linter class.
\nMore detailed documentation for build plugins is available on the GitHub Wiki .
",
"name": "factory",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a linter that will handle files with certain extensions or\nfilenames."
},
"Plugin.registerMinifier": {
"kind": "function",
"locus": "Build Plugin",
"longname": "Plugin.registerMinifier",
"memberof": "Plugin",
"name": "registerMinifier",
"options": [
{
"description": "The file extensions that this\nplugin should handle, without the first dot. Can only be "js" or "css".\nExamples: ["js", "css"].
",
"name": "extensions",
"type": {
"names": [
"Array."
]
}
},
{
"description": "The list of filenames\nthat this plugin should handle. Examples: ["config.json"].
",
"name": "filenames",
"type": {
"names": [
"Array."
]
}
}
],
"params": [
{
"name": "options",
"type": {
"names": [
"Object"
]
}
},
{
"description": "A function that returns an instance\nof a minifier class.
\nMore detailed documentation for build plugins is available on the GitHub Wiki .
",
"name": "factory",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a linter that will handle files with certain extensions or\nfilenames."
},
"Plugin.registerSourceHandler": {
"deprecated": "since 1.2\nXXX COMPAT WITH 1.1",
"kind": "function",
"locus": "Build Plugin",
"longname": "Plugin.registerSourceHandler",
"memberof": "Plugin",
"name": "registerSourceHandler",
"options": [],
"params": [
{
"description": "The file extension that this plugin\nshould handle, without the first dot.\nExamples: "coffee", "coffee.md".
",
"name": "fileExtension",
"type": {
"names": [
"String"
]
}
},
{
"description": "A function that takes one argument,\na CompileStep object.
\nDocumentation for CompileStep is available on the GitHub Wiki .
",
"name": "handler",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a handler to compile files with a certain file extension."
},
"ReactiveVar": {
"filepath": "reactive-var/reactive-var.js",
"instancename": "reactiveVar",
"kind": "class",
"lineno": 37,
"locus": "Client",
"longname": "ReactiveVar",
"name": "ReactiveVar",
"options": [],
"params": [
{
"description": "The initial value to set. equalsFunc is ignored when setting the initial value.
",
"name": "initialValue",
"type": {
"names": [
"Any"
]
}
},
{
"description": "Optional. A function of two arguments, called on the old value and the new value whenever the ReactiveVar is set. If it returns true, no set is performed. If omitted, the default equalsFunc returns true if its arguments are === and are of type number, boolean, string, undefined, or null.
",
"name": "equalsFunc",
"optional": true,
"type": {
"names": [
"function"
]
}
}
],
"scope": "global",
"summary": "Constructor for a ReactiveVar, which represents a single reactive variable."
},
"ReactiveVar#get": {
"filepath": "reactive-var/reactive-var.js",
"kind": "function",
"lineno": 62,
"locus": "Client",
"longname": "ReactiveVar#get",
"memberof": "ReactiveVar",
"name": "get",
"options": [],
"params": [],
"scope": "instance",
"summary": "Returns the current value of the ReactiveVar, establishing a reactive dependency."
},
"ReactiveVar#set": {
"filepath": "reactive-var/reactive-var.js",
"kind": "function",
"lineno": 74,
"locus": "Client",
"longname": "ReactiveVar#set",
"memberof": "ReactiveVar",
"name": "set",
"options": [],
"params": [
{
"name": "newValue",
"type": {
"names": [
"Any"
]
}
}
],
"scope": "instance",
"summary": "Sets the current value of the ReactiveVar, invalidating the Computations that called `get` if `newValue` is different from the old value."
},
"Session.equals": {
"filepath": "session/session.js",
"kind": "function",
"lineno": 41,
"locus": "Client",
"longname": "Session.equals",
"memberof": "Session",
"name": "equals",
"options": [],
"params": [
{
"description": "The name of the session variable to test
",
"name": "key",
"type": {
"names": [
"String"
]
}
},
{
"description": "The value to\ntest against
",
"name": "value",
"type": {
"names": [
"String",
"Number",
"Boolean",
"null",
"undefined"
]
}
}
],
"scope": "static",
"summary": "Test if a session variable is equal to a value. If inside a\n[reactive computation](#reactivity), invalidate the computation the next\ntime the variable changes to or from the value."
},
"Session.get": {
"filepath": "session/session.js",
"kind": "function",
"lineno": 28,
"locus": "Client",
"longname": "Session.get",
"memberof": "Session",
"name": "get",
"options": [],
"params": [
{
"description": "The name of the session variable to return
",
"name": "key",
"type": {
"names": [
"String"
]
}
}
],
"scope": "static",
"summary": "Get the value of a session variable. If inside a [reactive\ncomputation](#reactivity), invalidate the computation the next time the\nvalue of the variable is changed by [`Session.set`](#session_set). This\nreturns a clone of the session value, so if it's an object or an array,\nmutating the returned value has no effect on the value stored in the\nsession."
},
"Session.set": {
"filepath": "session/session.js",
"kind": "function",
"lineno": 6,
"locus": "Client",
"longname": "Session.set",
"memberof": "Session",
"name": "set",
"options": [],
"params": [
{
"description": "The key to set, eg, selectedItem
",
"name": "key",
"type": {
"names": [
"String"
]
}
},
{
"description": "The new value for key
",
"name": "value",
"type": {
"names": [
"EJSONable",
"undefined"
]
}
}
],
"scope": "static",
"summary": "Set a variable in the session. Notify any listeners that the value\nhas changed (eg: redraw templates, and rerun any\n[`Tracker.autorun`](#tracker_autorun) computations, that called\n[`Session.get`](#session_get) on this `key`.)"
},
"Session.setDefault": {
"filepath": "session/session.js",
"kind": "function",
"lineno": 18,
"locus": "Client",
"longname": "Session.setDefault",
"memberof": "Session",
"name": "setDefault",
"options": [],
"params": [
{
"description": "The key to set, eg, selectedItem
",
"name": "key",
"type": {
"names": [
"String"
]
}
},
{
"description": "The new value for key
",
"name": "value",
"type": {
"names": [
"EJSONable",
"undefined"
]
}
}
],
"scope": "static",
"summary": "Set a variable in the session if it hasn't been set before.\nOtherwise works exactly the same as [`Session.set`](#session_set)."
},
"Subscription": {
"filepath": "ddp-server/livedata_server.js",
"instancename": "this",
"kind": "class",
"lineno": 916,
"longname": "Subscription",
"name": "Subscription",
"options": [],
"params": [],
"scope": "global",
"summary": "The server's side of a subscription"
},
"Subscription#added": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1204,
"locus": "Server",
"longname": "Subscription#added",
"memberof": "Subscription",
"name": "added",
"options": [],
"params": [
{
"description": "The name of the collection that contains the new document.
",
"name": "collection",
"type": {
"names": [
"String"
]
}
},
{
"description": "The new document's ID.
",
"name": "id",
"type": {
"names": [
"String"
]
}
},
{
"description": "The fields in the new document. If _id is present it is ignored.
",
"name": "fields",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Call inside the publish function. Informs the subscriber that a document has been added to the record set."
},
"Subscription#changed": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1222,
"locus": "Server",
"longname": "Subscription#changed",
"memberof": "Subscription",
"name": "changed",
"options": [],
"params": [
{
"description": "The name of the collection that contains the changed document.
",
"name": "collection",
"type": {
"names": [
"String"
]
}
},
{
"description": "The changed document's ID.
",
"name": "id",
"type": {
"names": [
"String"
]
}
},
{
"description": "The fields in the document that have changed, together with their new values. If a field is not present in fields it was left unchanged; if it is present in fields and has a value of undefined it was removed from the document. If _id is present it is ignored.
",
"name": "fields",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Call inside the publish function. Informs the subscriber that a document in the record set has been modified."
},
"Subscription#connection": {
"filepath": "ddp-server/livedata_server.js",
"kind": "member",
"lineno": 926,
"locus": "Server",
"longname": "Subscription#connection",
"memberof": "Subscription",
"name": "connection",
"scope": "instance",
"summary": "Access inside the publish function. The incoming [connection](#meteor_onconnection) for this subscription."
},
"Subscription#error": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1147,
"locus": "Server",
"longname": "Subscription#error",
"memberof": "Subscription",
"name": "error",
"options": [],
"params": [
{
"description": "The error to pass to the client.
",
"name": "error",
"type": {
"names": [
"Error"
]
}
}
],
"scope": "instance",
"summary": "Call inside the publish function. Stops this client's subscription, triggering a call on the client to the `onStop` callback passed to [`Meteor.subscribe`](#meteor_subscribe), if any. If `error` is not a [`Meteor.Error`](#meteor_error), it will be [sanitized](#meteor_error)."
},
"Subscription#onStop": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1179,
"locus": "Server",
"longname": "Subscription#onStop",
"memberof": "Subscription",
"name": "onStop",
"options": [],
"params": [
{
"description": "The callback function
",
"name": "func",
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Call inside the publish function. Registers a callback function to run when the subscription is stopped."
},
"Subscription#ready": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1255,
"locus": "Server",
"longname": "Subscription#ready",
"memberof": "Subscription",
"name": "ready",
"options": [],
"params": [],
"scope": "instance",
"summary": "Call inside the publish function. Informs the subscriber that an initial, complete snapshot of the record set has been sent. This will trigger a call on the client to the `onReady` callback passed to [`Meteor.subscribe`](#meteor_subscribe), if any."
},
"Subscription#removed": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1238,
"locus": "Server",
"longname": "Subscription#removed",
"memberof": "Subscription",
"name": "removed",
"options": [],
"params": [
{
"description": "The name of the collection that the document has been removed from.
",
"name": "collection",
"type": {
"names": [
"String"
]
}
},
{
"description": "The ID of the document that has been removed.
",
"name": "id",
"type": {
"names": [
"String"
]
}
}
],
"scope": "instance",
"summary": "Call inside the publish function. Informs the subscriber that a document has been removed from the record set."
},
"Subscription#stop": {
"filepath": "ddp-server/livedata_server.js",
"kind": "function",
"lineno": 1165,
"locus": "Server",
"longname": "Subscription#stop",
"memberof": "Subscription",
"name": "stop",
"options": [],
"params": [],
"scope": "instance",
"summary": "Call inside the publish function. Stops this client's subscription and invokes the client's `onStop` callback with no error."
},
"Subscription#userId": {
"filepath": "ddp-server/livedata_server.js",
"kind": "member",
"lineno": 968,
"locus": "Server",
"longname": "Subscription#userId",
"memberof": "Subscription",
"name": "userId",
"scope": "instance",
"summary": "Access inside the publish function. The id of the logged-in user, or `null` if no user is logged in."
},
"Template": {
"filepath": "templating/templating.js",
"instancename": "Template.myTemplate",
"kind": "class",
"lineno": 9,
"longname": "Template",
"name": "Template",
"options": [],
"params": [],
"scope": "global",
"summary": "The class for defining templates"
},
"Template#created": {
"deprecated": "in 1.1",
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 179,
"locus": "Client",
"longname": "Template#created",
"memberof": "Template",
"name": "created",
"scope": "instance",
"summary": "Provide a callback when an instance of a template is created."
},
"Template#destroyed": {
"deprecated": "in 1.1",
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 208,
"locus": "Client",
"longname": "Template#destroyed",
"memberof": "Template",
"name": "destroyed",
"scope": "instance",
"summary": "Provide a callback when an instance of a template is destroyed."
},
"Template#events": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 468,
"locus": "Client",
"longname": "Template#events",
"memberof": "Template",
"name": "events",
"options": [],
"params": [
{
"description": "Event handlers to associate with this template.
",
"name": "eventMap",
"type": {
"names": [
"EventMap"
]
}
}
],
"scope": "instance",
"summary": "Specify event handlers for this template."
},
"Template#helpers": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 439,
"locus": "Client",
"longname": "Template#helpers",
"memberof": "Template",
"name": "helpers",
"options": [],
"params": [
{
"description": "Dictionary of helper functions by name.
",
"name": "helpers",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "instance",
"summary": "Specify template helpers available to this template."
},
"Template#onCreated": {
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 65,
"locus": "Client",
"longname": "Template#onCreated",
"memberof": "Template",
"name": "onCreated",
"params": [
{
"description": "A function to be added as a callback.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Register a function to be called when an instance of this template is created."
},
"Template#onDestroyed": {
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 89,
"locus": "Client",
"longname": "Template#onDestroyed",
"memberof": "Template",
"name": "onDestroyed",
"params": [
{
"description": "A function to be added as a callback.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Register a function to be called when an instance of this template is removed from the DOM and destroyed."
},
"Template#onRendered": {
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 77,
"locus": "Client",
"longname": "Template#onRendered",
"memberof": "Template",
"name": "onRendered",
"params": [
{
"description": "A function to be added as a callback.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Register a function to be called when an instance of this template is inserted into the DOM."
},
"Template#rendered": {
"deprecated": "in 1.1",
"filepath": "blaze/template.js",
"kind": "member",
"lineno": 195,
"locus": "Client",
"longname": "Template#rendered",
"memberof": "Template",
"name": "rendered",
"scope": "instance",
"summary": "Provide a callback when an instance of a template is rendered."
},
"Template.body": {
"filepath": "templating/templating.js",
"kind": "member",
"lineno": 47,
"locus": "Client",
"longname": "Template.body",
"memberof": "Template",
"name": "body",
"scope": "static",
"summary": "The [template object](#templates_api) representing your ``\ntag."
},
"Template.currentData": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 522,
"locus": "Client",
"longname": "Template.currentData",
"memberof": "Template",
"name": "currentData",
"options": [],
"params": [],
"scope": "static",
"summary": "- Inside an `onCreated`, `onRendered`, or `onDestroyed` callback, returns\nthe data context of the template.\n- Inside an event handler, returns the data context of the template on which\nthis event handler was defined.\n- Inside a helper, returns the data context of the DOM node where the helper\nwas used.\n\nEstablishes a reactive dependency on the result."
},
"Template.dynamic": {
"filepath": "spacebars/dynamic.js",
"istemplate": "true",
"kind": "function",
"lineno": 1,
"locus": "Templates",
"longname": "Template.dynamic",
"memberof": "Template",
"name": "dynamic",
"options": [],
"params": [
{
"description": "The name of the template to include.
",
"name": "template",
"type": {
"names": [
"String"
]
}
},
{
"description": "Optional. The data context in which to include the template.
",
"name": "data",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Choose a template to include dynamically, by name."
},
"Template.instance": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 492,
"locus": "Client",
"longname": "Template.instance",
"memberof": "Template",
"name": "instance",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"Blaze.TemplateInstance"
]
}
}
],
"scope": "static",
"summary": "The [template instance](#template_inst) corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`."
},
"Template.parentData": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 530,
"locus": "Client",
"longname": "Template.parentData",
"memberof": "Template",
"name": "parentData",
"options": [],
"params": [
{
"description": "The number of levels beyond the current data context to look. Defaults to 1.
",
"name": "numLevels",
"optional": true,
"type": {
"names": [
"Integer"
]
}
}
],
"scope": "static",
"summary": "Accesses other data contexts that enclose the current data context."
},
"Template.registerHelper": {
"filepath": "blaze/template.js",
"kind": "function",
"lineno": 539,
"locus": "Client",
"longname": "Template.registerHelper",
"memberof": "Template",
"name": "registerHelper",
"options": [],
"params": [
{
"description": "The name of the helper function you are defining.
",
"name": "name",
"type": {
"names": [
"String"
]
}
},
{
"description": "The helper function itself.
",
"name": "function",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Defines a [helper function](#template_helpers) which can be used from all templates."
},
"Tracker": {
"filepath": "tracker/tracker.js",
"kind": "namespace",
"lineno": 5,
"longname": "Tracker",
"name": "Tracker",
"scope": "global",
"summary": "The namespace for Tracker-related methods."
},
"Tracker.Computation": {
"filepath": "tracker/tracker.js",
"instancename": "computation",
"kind": "function",
"lineno": 153,
"longname": "Tracker.Computation",
"memberof": "Tracker",
"name": "Computation",
"options": [],
"params": [],
"scope": "static",
"summary": "A Computation object represents code that is repeatedly rerun\nin response to\nreactive data changes. Computations don't have return values; they just\nperform actions, such as rerendering a template on the screen. Computations\nare created using Tracker.autorun. Use stop to prevent further rerunning of a\ncomputation."
},
"Tracker.Computation#firstRun": {
"filepath": "tracker/tracker.js",
"kind": "member",
"lineno": 186,
"locus": "Client",
"longname": "Tracker.Computation#firstRun",
"memberof": "Tracker.Computation",
"name": "firstRun",
"scope": "instance",
"summary": "True during the initial run of the computation at the time `Tracker.autorun` is called, and false on subsequent reruns and at other times.",
"type": {
"names": [
"Boolean"
]
}
},
"Tracker.Computation#invalidate": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 268,
"locus": "Client",
"longname": "Tracker.Computation#invalidate",
"memberof": "Tracker.Computation",
"name": "invalidate",
"options": [],
"params": [],
"scope": "instance",
"summary": "Invalidates this computation so that it will be rerun."
},
"Tracker.Computation#invalidated": {
"filepath": "tracker/tracker.js",
"kind": "member",
"lineno": 174,
"locus": "Client",
"longname": "Tracker.Computation#invalidated",
"memberof": "Tracker.Computation",
"name": "invalidated",
"scope": "instance",
"summary": "True if this computation has been invalidated (and not yet rerun), or if it has been stopped.",
"type": {
"names": [
"Boolean"
]
}
},
"Tracker.Computation#onInvalidate": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 227,
"locus": "Client",
"longname": "Tracker.Computation#onInvalidate",
"memberof": "Tracker.Computation",
"name": "onInvalidate",
"options": [],
"params": [
{
"description": "Function to be called on invalidation. Receives one argument, the computation that was invalidated.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Registers `callback` to run when this computation is next invalidated, or runs it immediately if the computation is already invalidated. The callback is run exactly once and not upon future invalidations unless `onInvalidate` is called again after the computation becomes valid again."
},
"Tracker.Computation#onStop": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 247,
"locus": "Client",
"longname": "Tracker.Computation#onStop",
"memberof": "Tracker.Computation",
"name": "onStop",
"options": [],
"params": [
{
"description": "Function to be called on stop. Receives one argument, the computation that was stopped.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "instance",
"summary": "Registers `callback` to run when this computation is stopped, or runs it immediately if the computation is already stopped. The callback is run after any `onInvalidate` callbacks."
},
"Tracker.Computation#stop": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 297,
"locus": "Client",
"longname": "Tracker.Computation#stop",
"memberof": "Tracker.Computation",
"name": "stop",
"options": [],
"params": [],
"scope": "instance",
"summary": "Prevents this computation from rerunning."
},
"Tracker.Computation#stopped": {
"filepath": "tracker/tracker.js",
"kind": "member",
"lineno": 163,
"locus": "Client",
"longname": "Tracker.Computation#stopped",
"memberof": "Tracker.Computation",
"name": "stopped",
"scope": "instance",
"summary": "True if this computation has been stopped."
},
"Tracker.ComputationFunction": {
"filepath": "tracker/tracker.js",
"kind": "typedef",
"lineno": 538,
"longname": "Tracker.ComputationFunction",
"memberof": "Tracker",
"name": "ComputationFunction",
"params": [
{
"type": {
"names": [
"Tracker.Computation"
]
}
}
],
"scope": "static",
"type": {
"names": [
"function"
]
}
},
"Tracker.Dependency": {
"filepath": "tracker/tracker.js",
"instancename": "dependency",
"kind": "class",
"lineno": 368,
"longname": "Tracker.Dependency",
"memberof": "Tracker",
"name": "Dependency",
"options": [],
"params": [],
"scope": "static",
"summary": "A Dependency represents an atomic unit of reactive data that a\ncomputation might depend on. Reactive data sources such as Session or\nMinimongo internally create different Dependency objects for different\npieces of data, each of which may be depended on by multiple computations.\nWhen the data changes, the computations are invalidated."
},
"Tracker.Dependency#changed": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 414,
"locus": "Client",
"longname": "Tracker.Dependency#changed",
"memberof": "Tracker.Dependency",
"name": "changed",
"options": [],
"params": [],
"scope": "instance",
"summary": "Invalidate all dependent computations immediately and remove them as dependents."
},
"Tracker.Dependency#depend": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 389,
"locus": "Client",
"longname": "Tracker.Dependency#depend",
"memberof": "Tracker.Dependency",
"name": "depend",
"options": [],
"params": [
{
"description": "An optional computation declared to depend on dependency instead of the current computation.
",
"name": "fromComputation",
"optional": true,
"type": {
"names": [
"Tracker.Computation"
]
}
}
],
"returns": [
{
"type": {
"names": [
"Boolean"
]
}
}
],
"scope": "instance",
"summary": "Declares that the current computation (or `fromComputation` if given) depends on `dependency`. The computation will be invalidated the next time `dependency` changes.\n\nIf there is no current computation and `depend()` is called with no arguments, it does nothing and returns false.\n\nReturns true if the computation is a new dependent of `dependency` rather than an existing one."
},
"Tracker.Dependency#hasDependents": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 427,
"locus": "Client",
"longname": "Tracker.Dependency#hasDependents",
"memberof": "Tracker.Dependency",
"name": "hasDependents",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"Boolean"
]
}
}
],
"scope": "instance",
"summary": "True if this Dependency has one or more dependent Computations, which would be invalidated if this Dependency were to change."
},
"Tracker.active": {
"filepath": "tracker/tracker.js",
"kind": "member",
"lineno": 18,
"locus": "Client",
"longname": "Tracker.active",
"memberof": "Tracker",
"name": "active",
"scope": "static",
"summary": "True if there is a current computation, meaning that dependencies on reactive data sources will be tracked and potentially cause the current computation to be rerun.",
"type": {
"names": [
"Boolean"
]
}
},
"Tracker.afterFlush": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 616,
"locus": "Client",
"longname": "Tracker.afterFlush",
"memberof": "Tracker",
"name": "afterFlush",
"options": [],
"params": [
{
"description": "A function to call at flush time.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Schedules a function to be called during the next flush, or later in the current flush if one is in progress, after all invalidated computations have been rerun. The function will be run once and not on subsequent flushes unless `afterFlush` is called again."
},
"Tracker.autorun": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 555,
"locus": "Client",
"longname": "Tracker.autorun",
"memberof": "Tracker",
"name": "autorun",
"options": [
{
"description": "Optional. The function to run when an error\nhappens in the Computation. The only argument it recieves is the Error\nthrown. Defaults to the error being logged to the console.
",
"name": "onError",
"type": {
"names": [
"function"
]
}
}
],
"params": [
{
"description": "The function to run. It receives\none argument: the Computation object that will be returned.
",
"name": "runFunc",
"type": {
"names": [
"Tracker.ComputationFunction"
]
}
},
{
"name": "options",
"optional": true,
"type": {
"names": [
"Object"
]
}
}
],
"returns": [
{
"type": {
"names": [
"Tracker.Computation"
]
}
}
],
"scope": "static",
"summary": "Run a function now and rerun it later whenever its dependencies\nchange. Returns a Computation object that can be used to stop or observe the\nrerunning."
},
"Tracker.currentComputation": {
"filepath": "tracker/tracker.js",
"kind": "member",
"lineno": 27,
"locus": "Client",
"longname": "Tracker.currentComputation",
"memberof": "Tracker",
"name": "currentComputation",
"scope": "static",
"summary": "The current computation, or `null` if there isn't one. The current computation is the [`Tracker.Computation`](#tracker_computation) object created by the innermost active call to `Tracker.autorun`, and it's the computation that gains dependencies when reactive data sources are accessed.",
"type": {
"names": [
"Tracker.Computation"
]
}
},
"Tracker.flush": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 440,
"locus": "Client",
"longname": "Tracker.flush",
"memberof": "Tracker",
"name": "flush",
"options": [],
"params": [],
"scope": "static",
"summary": "Process all reactive updates immediately and ensure that all invalidated computations are rerun."
},
"Tracker.nonreactive": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 585,
"locus": "Client",
"longname": "Tracker.nonreactive",
"memberof": "Tracker",
"name": "nonreactive",
"options": [],
"params": [
{
"description": "A function to call immediately.
",
"name": "func",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Run a function without tracking dependencies."
},
"Tracker.onInvalidate": {
"filepath": "tracker/tracker.js",
"kind": "function",
"lineno": 602,
"locus": "Client",
"longname": "Tracker.onInvalidate",
"memberof": "Tracker",
"name": "onInvalidate",
"options": [],
"params": [
{
"description": "A callback function that will be invoked as func(c), where c is the computation on which the callback is registered.
",
"name": "callback",
"type": {
"names": [
"function"
]
}
}
],
"scope": "static",
"summary": "Registers a new [`onInvalidate`](#computation_oninvalidate) callback on the current computation (which must exist), to be called immediately when the current computation is invalidated or stopped."
},
"check": {
"filepath": "check/match.js",
"kind": "function",
"lineno": 19,
"locus": "Anywhere",
"longname": "check",
"name": "check",
"options": [],
"params": [
{
"description": "The value to check
",
"name": "value",
"type": {
"names": [
"Any"
]
}
},
{
"description": "The pattern to match\nvalue against
",
"name": "pattern",
"type": {
"names": [
"MatchPattern"
]
}
}
],
"scope": "global",
"summary": "Check that a value matches a [pattern](#matchpatterns).\nIf the value does not match the pattern, throw a `Match.Error`.\n\nParticularly useful to assert that arguments to a function have the right\ntypes and structure."
},
"currentUser": {
"filepath": "accounts-base/accounts_client.js",
"ishelper": "true",
"kind": "member",
"lineno": 390,
"longname": "currentUser",
"name": "currentUser",
"scope": "global",
"summary": "Calls [Meteor.user()](#meteor_user). Use `{{#if currentUser}}` to check whether the user is logged in."
},
"getExtension": {
"kind": "function",
"longname": "getExtension",
"name": "getExtension",
"options": [],
"params": [],
"returns": [
{
"type": {
"names": [
"String"
]
}
}
],
"scope": "global",
"summary": "Returns the extension that matched the compiler plugin.\nThe longest prefix is preferred."
},
"loggingIn": {
"filepath": "accounts-base/accounts_client.js",
"ishelper": "true",
"kind": "member",
"lineno": 400,
"longname": "loggingIn",
"name": "loggingIn",
"scope": "global",
"summary": "Calls [Meteor.loggingIn()](#meteor_loggingin)."
}
};