// This file is automatically generated by JSDoc; regenerate it with scripts/admin/jsdoc/jsdoc.sh DocsData = { "Accounts": { "kind": "namespace", "longname": "Accounts", "name": "Accounts", "summary": "The namespace for all accounts-related methods." }, "Accounts.changePassword": { "kind": "function", "locus": "Client", "longname": "Accounts.changePassword", "memberof": "Accounts", "name": "changePassword", "options": [], "params": [ { "description": "
The user's current password. This is not sent in plain text over the wire.
", "name": "oldPassword", "type": { "names": [ "String" ] } }, { "description": "A new password for the user. This is not sent in plain text over the wire.
", "name": "newPassword", "type": { "names": [ "String" ] } }, { "description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure.
New users with an email address will receive an address verification email.
", "name": "sendVerificationEmail", "type": { "names": [ "Boolean" ] } }, { "description": "Calls to createUser from the client will be rejected. In addition, if you are using accounts-ui, the "Create account" link will not be available.
If set to a string, only allows new users if the domain part of their email address matches the string. If set to a function, only allows new users if the function returns true. The function is passed the full email address of the proposed new user. Works with password-based sign-in and external services that expose email addresses (Google, Facebook, GitHub). All existing users still can log in after enabling this option. Example: Accounts.config({ restrictCreationByEmailDomain: 'school.edu' }).
The number of days from when a user logs in until their token expires and they are logged out. Defaults to 90. Set to null to disable login expiration.
When using the oauth-encryption package, the 16 byte key using to encrypt sensitive account credentials in the database, encoded in base64. This option may only be specifed on the server. See packages/oauth-encryption/README.md for details.
A unique name for this user.
", "name": "username", "type": { "names": [ "String" ] } }, { "description": "The user's email address.
", "name": "email", "type": { "names": [ "String" ] } }, { "description": "The user's password. This is not sent in plain text over the wire.
", "name": "password", "type": { "names": [ "String" ] } }, { "description": "The user's profile, typically including the name field.
Client only, optional callback. Called with no arguments on success, or with a single Error argument on failure.
The email address to send a password reset link.
", "name": "email", "type": { "names": [ "String" ] } } ], "params": [ { "name": "options", "type": { "names": [ "Object" ] } }, { "description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure.
Called whenever a new user is created. Return the new user object, or throw an Error to abort the creation.
The function to call. It is given two arguments:
\ntoken: An email verification token that can be passed to\nAccounts.verifyEmail.done: A function to call when the email verification UI flow is complete.\nThe normal login process is suspended until this function is called, so\nthat the user can be notified that they are verifying their email before\nbeing logged in.The function to call. It is given two arguments:
\ntoken: A password reset token that can be passed to\nAccounts.resetPassword to give the newly\nenrolled account a password.done: A function to call when the enrollment UI flow is complete.\nThe normal login process is suspended until this function is called, so that\nuser A can be enrolled even if user B was logged in.The callback to be called when login is successful.
", "name": "func", "type": { "names": [ "function" ] } } ], "scope": "static", "summary": "Register a callback to be called after a login attempt succeeds." }, "Accounts.onLoginFailure": { "kind": "function", "locus": "Anywhere", "longname": "Accounts.onLoginFailure", "memberof": "Accounts", "name": "onLoginFailure", "options": [], "params": [ { "description": "The callback to be called after the login has failed.
", "name": "func", "type": { "names": [ "function" ] } } ], "scope": "static", "summary": "Register a callback to be called after a login attempt fails." }, "Accounts.onResetPasswordLink": { "kind": "function", "locus": "Client", "longname": "Accounts.onResetPasswordLink", "memberof": "Accounts", "name": "onResetPasswordLink", "options": [], "params": [ { "description": "The function to call. It is given two arguments:
\ntoken: A password reset token that can be passed to\nAccounts.resetPassword.done: A function to call when the password reset UI flow is complete. The normal\nlogin process is suspended until this function is called, so that the\npassword for user A can be reset even if user B was logged in.The token retrieved from the reset password URL.
", "name": "token", "type": { "names": [ "String" ] } }, { "description": "A new password for the user. This is not sent in plain text over the wire.
", "name": "newPassword", "type": { "names": [ "String" ] } }, { "description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure.
The id of the user to send email to.
", "name": "userId", "type": { "names": [ "String" ] } }, { "description": "Optional. Which address of the user's to send the email to. This address must be in the user's emails list. Defaults to the first email in the list.
The id of the user to send email to.
", "name": "userId", "type": { "names": [ "String" ] } }, { "description": "Optional. Which address of the user's to send the email to. This address must be in the user's emails list. Defaults to the first email in the list.
The id of the user to send email to.
", "name": "userId", "type": { "names": [ "String" ] } }, { "description": "Optional. Which address of the user's to send the email to. This address must be in the user's emails list. Defaults to the first unverified email in the list.
Logout all current connections with this userId (default: true)
", "name": "logout", "type": { "names": [ "Object" ] } } ], "params": [ { "description": "The id of the user to update.
", "name": "userId", "type": { "names": [ "String" ] } }, { "description": "A new password for the user.
", "name": "newPassword", "type": { "names": [ "String" ] } }, { "name": "options", "optional": true, "type": { "names": [ "Object" ] } } ], "scope": "static", "summary": "Forcibly change the password for a user." }, "Accounts.ui": { "kind": "namespace", "longname": "Accounts.ui", "memberof": "Accounts", "name": "ui", "scope": "static", "summary": "Accounts UI" }, "Accounts.ui.config": { "kind": "function", "locus": "Client", "longname": "Accounts.ui.config", "memberof": "Accounts.ui", "name": "config", "options": [ { "description": "Which permissions to request from the user for each external service.
", "name": "requestPermissions", "type": { "names": [ "Object" ] } }, { "description": "To ask the user for permission to act on their behalf when offline, map the relevant external service to true. Currently only supported with Google. See Meteor.loginWithExternalService for more details.
If true, forces the user to approve the app's permissions, even if previously approved. Currently only supported with Google.
", "name": "forceApprovalPrompt", "type": { "names": [ "Object" ] } }, { "description": "Which fields to display in the user creation form. One of 'USERNAME_AND_EMAIL', 'USERNAME_AND_OPTIONAL_EMAIL', 'USERNAME_ONLY', or 'EMAIL_ONLY' (default).
Called whenever a login is attempted (either successful or unsuccessful). A login can be aborted by returning a falsy value or throwing an exception.
", "name": "func", "type": { "names": [ "function" ] } } ], "scope": "static", "summary": "Validate login attempts." }, "Accounts.validateNewUser": { "kind": "function", "locus": "Server", "longname": "Accounts.validateNewUser", "memberof": "Accounts", "name": "validateNewUser", "options": [], "params": [ { "description": "Called whenever a new user is created. Takes the new user object, and returns true to allow the creation or false to abort.
", "name": "func", "type": { "names": [ "function" ] } } ], "scope": "static", "summary": "Set restrictions on new user creation." }, "Accounts.verifyEmail": { "kind": "function", "locus": "Client", "longname": "Accounts.verifyEmail", "memberof": "Accounts", "name": "verifyEmail", "options": [], "params": [ { "description": "The token retrieved from the verification URL.
", "name": "token", "type": { "names": [ "String" ] } }, { "description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure.
Set to true if the matching URL\nshould be handled externally (e.g. phone app or email client on Android).
", "name": "launchExternal", "type": { "names": [ "Boolean" ] } } ], "params": [ { "description": "The pattern defining affected domains or URLs.
", "name": "domainRule", "type": { "names": [ "String" ] } }, { "name": "options", "optional": true, "type": { "names": [ "Object" ] } } ], "scope": "static", "summary": "Set a new access rule based on origin domain for your app.\nBy default your application has a limited list of servers it can contact.\nUse this method to extend this list.\n\nDefault access rules:\n\n- `tel:*`, `geo:*`, `mailto:*`, `sms:*`, `market:*` are allowed and\n launch externally (phone app, or an email client on Android)\n- `gap:*`, `cdv:*`, `file:` are allowed (protocols required to access\n local file-system)\n- `http://meteor.local/*` is allowed (a domain Meteor uses to access\n app's assets)\n- The domain of the server passed to the build process (or local ip\n address in the development mode) is used to be able to contact the\n Meteor app server.\n\nRead more about domain patterns in [Cordova\ndocs](http://cordova.apache.org/docs/en/4.0.0/guide_appdev_whitelist_index.md.html).\n\nStarting with Meteor 1.0.4 access rule for all domains and protocols\n(`The identifier of the plugin you want to\nconfigure.
", "name": "pluginName", "type": { "names": [ "String" ] } }, { "description": "A set of key-value pairs which will be passed\nat build-time to configure the specified plugin.
", "name": "config", "type": { "names": [ "Object" ] } } ], "scope": "static", "summary": "Set the build-time configuration for a Phonegap plugin." }, "App.icons": { "kind": "function", "longname": "App.icons", "memberof": "App", "name": "icons", "options": [], "params": [ { "description": "An Object where the keys are different\ndevices and screen sizes, and values are image paths\nrelative to the project root directory.
\nValid key values:
\niphoneiphone_2xiphone_3xipadipad_2xandroid_ldpiandroid_mdpiandroid_hdpiandroid_xhdpiEach of the options correspond to a key in the app's core configuration\nas described in the PhoneGap documentation.
", "name": "id, version, name, description, author, email, website", "optional": true, "type": { "names": [ "String" ] } } ], "params": [ { "name": "options", "type": { "names": [ "Object" ] } } ], "scope": "static", "summary": "Set your mobile app's core configuration information." }, "App.launchScreens": { "kind": "function", "longname": "App.launchScreens", "memberof": "App", "name": "launchScreens", "options": [], "params": [ { "description": "A dictionary where keys are different\ndevices, screen sizes, and orientations, and the values are image paths\nrelative to the project root directory.
\nFor Android, launch screen images should\nbe special "Nine-patch" image files that specify how they should be\nstretched. See the Android docs.
\nValid key values:
\niphoneiphone_2xiphone5iphone6iphone6p_portraitiphone6p_landscapeipad_portraitipad_portrait_2xipad_landscapeipad_landscape_2xandroid_ldpi_portraitandroid_ldpi_landscapeandroid_mdpi_portraitandroid_mdpi_landscapeandroid_hdpi_portraitandroid_hdpi_landscapeandroid_xhdpi_portraitandroid_xhdpi_landscapeA preference name supported by Phonegap's\nconfig.xml.
The value for that preference.
", "name": "value", "type": { "names": [ "String" ] } } ], "scope": "static", "summary": "Add a preference for your build as described in the\n[PhoneGap documentation](http://docs.phonegap.com/en/3.5.0/config_ref_index.md.html#The%20config.xml%20File_global_preferences)." }, "Assets": { "kind": "namespace", "longname": "Assets", "name": "Assets", "summary": "The namespace for Assets functions, lives in the bundler." }, "Assets.getBinary": { "kind": "function", "locus": "Server", "longname": "Assets.getBinary", "memberof": "Assets", "name": "getBinary", "options": [], "params": [ { "description": "The path of the asset, relative to the application's private subdirectory.
Optional callback, which is called asynchronously with the error or result after the function is complete. If not provided, the function runs synchronously.
", "name": "asyncCallback", "optional": true, "type": { "names": [ "function" ] } } ], "scope": "static", "summary": "Retrieve the contents of the static server asset as an [EJSON Binary](#ejson_new_binary)." }, "Assets.getText": { "kind": "function", "locus": "Server", "longname": "Assets.getText", "memberof": "Assets", "name": "getText", "options": [], "params": [ { "description": "The path of the asset, relative to the application's private subdirectory.
Optional callback, which is called asynchronously with the error or result after the function is complete. If not provided, the function runs synchronously.
", "name": "asyncCallback", "optional": true, "type": { "names": [ "function" ] } } ], "scope": "static", "summary": "Retrieve the contents of the static server asset as a UTF8-encoded string." }, "Blaze": { "kind": "namespace", "longname": "Blaze", "name": "Blaze", "summary": "The namespace for all Blaze-related methods and classes." }, "Blaze.Each": { "kind": "function", "locus": "Client", "longname": "Blaze.Each", "memberof": "Blaze", "name": "Each", "options": [], "params": [ { "description": "A function to reactively re-run. The function may return a Cursor, an array, null, or undefined.
", "name": "argFunc", "type": { "names": [ "function" ] } }, { "description": "A Function that returns renderable content.
", "name": "contentFunc", "type": { "names": [ "function" ] } }, { "description": "Optional. A Function that returns renderable content to display in the case when there are no items to display.
", "name": "elseFunc", "optional": true, "type": { "names": [ "function" ] } } ], "scope": "static", "summary": "Constructs a View that renders `contentFunc` for each item in a sequence." }, "Blaze.If": { "kind": "function", "locus": "Client", "longname": "Blaze.If", "memberof": "Blaze", "name": "If", "options": [], "params": [ { "description": "A function to reactively re-run. Whether the result is truthy or falsy determines whether contentFunc or elseFunc is shown. An empty array is considered falsy.
A Function that returns renderable content.
", "name": "contentFunc", "type": { "names": [ "function" ] } }, { "description": "Optional. A Function that returns renderable content. If no elseFunc is supplied, no content is shown in the "else" case.
Optional. A name for Views constructed by this Template. See view.name.
A function that returns renderable content. This function is used as the renderFunction for Views constructed by this Template.
The CSS selector to match, scoped to the template contents.
", "name": "selector", "type": { "names": [ "String" ] } } ], "returns": [ { "type": { "names": [ "Array.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": { "kind": "member", "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": { "kind": "function", "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": { "kind": "function", "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.Name of the subscription. Matches the name of the\nserver's publish() call.
Optional arguments passed to publisher function\non server.
", "name": "arg1, arg2...", "optional": true, "type": { "names": [ "Any" ] } }, { "description": "Optional. May include onStop and\nonReady callbacks. If a function is passed instead of an object, it is\ninterpreted as an onReady callback.
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.
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": { "kind": "member", "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": { "kind": "function", "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.
A Function that returns renderable content.
", "name": "contentFunc", "type": { "names": [ "function" ] } }, { "description": "Optional. A Function that returns renderable content. If no elseFunc is supplied, no content is shown in the "else" case.
Optional. A name for this type of View. See view.name.
A function that returns renderable content. In this function, this is bound to the View.
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": { "kind": "member", "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": { "kind": "function", "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": { "kind": "function", "locus": "Client", "longname": "Blaze.getView", "memberof": "Blaze", "name": "getView", "options": [], "params": [ { "description": "Optional. If specified, the View enclosing element is returned.
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": { "kind": "function", "locus": "Client", "longname": "Blaze.remove", "memberof": "Blaze", "name": "remove", "options": [], "params": [ { "description": "The return value from Blaze.render or Blaze.renderWithData.
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.
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.
The template (e.g. Template.myTemplate) or View object to render.
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.
The template (e.g. Template.myTemplate) or View object from which to generate HTML.
The template (e.g. Template.myTemplate) or View object from which to generate HTML.
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.
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});",
"name": "dependencies",
"type": {
"names": [
"Object"
]
}
}
],
"scope": "static",
"summary": "Specify which [Cordova / PhoneGap](http://cordova.apache.org/)\nplugins your Meteor package depends on.\n\nPlugins are installed from\n[plugins.cordova.io](http://plugins.cordova.io/), so the plugins and\nversions specified must exist there. Alternatively, the version\ncan be replaced with a GitHub tarball URL as described in the\n[Cordova / PhoneGap](https://github.com/meteor/meteor/wiki/Meteor-Cordova-Phonegap-integration#meteor-packages-with-cordovaphonegap-dependencies)\npage of the Meteor wiki on GitHub."
},
"DDP": {
"kind": "namespace",
"longname": "DDP",
"name": "DDP",
"summary": "The namespace for DDP-related methods."
},
"DDP.connect": {
"kind": "function",
"locus": "Anywhere",
"longname": "DDP.connect",
"memberof": "DDP",
"name": "connect",
"options": [],
"params": [
{
"description": "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." }, "EJSON": { "kind": "namespace", "longname": "EJSON", "name": "EJSON", "scope": "global", "summary": "Namespace for EJSON functions" }, "EJSON.CustomType": { "instancename": "customType", "kind": "class", "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": { "kind": "function", "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": { "kind": "function", "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": { "kind": "function", "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": { "kind": "function", "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": { "kind": "function", "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.
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.
A value to copy.
", "name": "val", "type": { "names": [ "EJSON" ] } } ], "scope": "static", "summary": "Return a deep copy of `val`." }, "EJSON.equals": { "kind": "function", "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.
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": { "kind": "function", "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": { "kind": "member", "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": { "kind": "function", "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": { "kind": "function", "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.
When true, stringifies keys in an object in sorted order.
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": { "kind": "function", "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": { "kind": "function", "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."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" ] } } ], "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": { "kind": "function", "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.
Query string to go in the URL. Overwrites any query string in url.
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.
HTTP basic authentication string of the form "username:password"
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.
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.
The HTTP method to use, such as "GET", "POST", or "HEAD".
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": { "kind": "function", "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.
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": { "kind": "function", "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.
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": { "kind": "function", "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.
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": { "kind": "function", "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.
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." }, "Match": { "kind": "namespace", "longname": "Match", "name": "Match", "summary": "The namespace for all Match types and methods." }, "Match.test": { "kind": "function", "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
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 === "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.
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": { "kind": "function", "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"
A path to append to the root URL. Do not include a leading "/".
(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 of method to invoke
", "name": "name", "type": { "names": [ "String" ] } }, { "description": "Method arguments
", "name": "args", "type": { "names": [ "Array.Optional callback; same semantics as in Meteor.call.
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": { "kind": "function", "locus": "Anywhere", "longname": "Meteor.clearInterval", "memberof": "Meteor", "name": "clearInterval", "options": [], "params": [ { "description": "The handle returned by Meteor.setInterval
The handle returned by Meteor.setTimeout
A list of permissions to request from the user.
", "name": "requestPermissions", "type": { "names": [ "Array.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.
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": "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.
Either a string interpreted as a username or an email; or an object with a single key: email, username or id.
The user's password.
", "name": "password", "type": { "names": [ "String" ] } }, { "description": "Optional callback. Called with no arguments on success, or with a single Error argument on failure.
Optional callback. Called with no arguments on success, or with a single Error argument on failure.
Optional callback. Called with no arguments on success, or with a single Error argument on failure.
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": { "kind": "function", "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": { "kind": "function", "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.
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.
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": { "kind": "function", "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": { "kind": "member", "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": { "kind": "function", "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": { "kind": "function", "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": { "kind": "function", "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.
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.
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
The value that should be returned by userId on this connection.
The server connection that will manage this collection. Uses the default connection if not specified. Pass the return value of calling DDP.connect to specify a different server. Pass null to specify no connection. Unmanaged (name is null) collections cannot specify a connection.
The method of generating the _id fields of new documents in this collection. Possible values:
'STRING': random strings'MONGO': random Mongo.ObjectID valuesThe default id generation technique is 'STRING'.
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.
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": { "kind": "function", "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.
Overrides transform on the Collection. Pass null to disable transformation.
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.
Overrides transform on the Collection. Pass null to disable transformation.
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
Overrides transform on the Collection for this cursor. Pass null to disable transformation.
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": { "kind": "function", "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 Collection for this cursor. Pass null to disable transformation.
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": { "kind": "function", "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#remove": { "kind": "function", "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": { "kind": "function", "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": { "kind": "function", "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": { "instancename": "cursor", "kind": "class", "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": { "kind": "function", "locus": "Anywhere", "longname": "Mongo.Cursor#count", "memberof": "Mongo.Cursor", "name": "count", "options": [], "params": [], "scope": "instance", "summary": "Returns the number of documents that match a query." }, "Mongo.Cursor#fetch": { "kind": "function", "locus": "Anywhere", "longname": "Mongo.Cursor#fetch", "memberof": "Mongo.Cursor", "name": "fetch", "options": [], "params": [], "returns": [ { "type": { "names": [ "Array.