diff --git a/docs/client/api.html b/docs/client/api.html index 09432b1269..868e5712ff 100644 --- a/docs/client/api.html +++ b/docs/client/api.html @@ -3549,11 +3549,11 @@ package is exported to. {{> autoApiBox "Package.onUse"}} -{{> api_box pack_versions }} +{{> autoApiBox "PackageAPI#versionsFrom" }} {{> api_box pack_use }} -{{> api_box pack_api_imply }} -{{> api_box pack_export }} -{{> api_box pack_addFiles }} +{{> autoApiBox "PackageAPI#imply" }} +{{> autoApiBox "PackageAPI#export" }} +{{> autoApiBox "PackageAPI#addFiles" }}

Unit Tests

diff --git a/docs/client/data.js b/docs/client/data.js index af3342fde3..83adbb12d8 100644 --- a/docs/client/data.js +++ b/docs/client/data.js @@ -1,2 +1,2 @@ // This file is automatically generated by JSDoc; -DocsData = {"Accounts":{"comment":"/**\n * @namespace Accounts\n * @summary The namespace for all accounts-related methods.\n */","meta":{"range":[0,90],"filename":"accounts_common.js","lineno":1,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{}},"kind":"namespace","name":"Accounts","summary":"The namespace for all accounts-related methods.","longname":"Accounts","___id":"T000002R000052","___s":true,"ui":{"comment":"/**\n * @summary Accounts UI\n * @namespace\n * @memberOf Accounts\n */","meta":{"range":[68,84],"filename":"accounts_ui.js","lineno":6,"path":"/Users/sashko/git/meteor/packages/accounts-ui-unstyled","code":{"id":"astnode100017176","name":"Accounts.ui","type":"ObjectExpression","value":"{}","paramnames":[]}},"summary":"Accounts UI","kind":"namespace","memberof":"Accounts","name":"ui","longname":"Accounts.ui","scope":"static","___id":"T000002R001237","___s":true,"config":{"meta":{"range":[1184,3840],"filename":"accounts_ui.js","lineno":25,"path":"/Users/sashko/git/meteor/packages/accounts-ui-unstyled","code":{"id":"astnode100017196","name":"Accounts.ui.config","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"VALID_KEYS":null,"":null,"Accounts.ui._options.passwordSignupFields":null}},"summary":"Configure the behavior of [`{{> loginButtons}}`](#accountsui).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"config","longname":"Accounts.ui.config","kind":"function","memberof":"Accounts.ui","scope":"static","___id":"T000002R001242","___s":true,"options":[{"type":{"names":["Object"]},"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.

","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":["String"]},"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).

","name":"passwordSignupFields"}],"locus":"Client"}},"emailTemplates":{"comment":"/**\n * @summary Options to customize emails sent from the Accounts system.\n * @locus Anywhere\n */","meta":{"range":[98,1733],"filename":"email_templates.js","lineno":5,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100008131","name":"Accounts.emailTemplates","type":"ObjectExpression","value":"{\"from\":\"Meteor Accounts \",\"siteName\":\"\",\"resetPassword\":\"\",\"verifyEmail\":\"\",\"enrollAccount\":\"\"}","paramnames":[]}},"summary":"Options to customize emails sent from the Accounts system.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"emailTemplates","longname":"Accounts.emailTemplates","kind":"member","memberof":"Accounts","scope":"static","___id":"T000002R000669","___s":true,"locus":"Anywhere"},"config":{"meta":{"range":[3341,5573],"filename":"accounts_common.js","lineno":55,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000690","name":"Accounts.config","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"__meteor_runtime_config__.accountsConfigCalled":null,"options":null,"VALID_KEYS":null,"":null}},"summary":"Set global accounts options.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"config","longname":"Accounts.config","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000059","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"

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.

","name":"forbidClientAccountCreation"},{"type":{"names":["String","function"]},"description":"

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' }).

","name":"restrictCreationByEmailDomain"},{"type":{"names":["Number"]},"description":"

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.

","name":"loginExpirationInDays"},{"type":{"names":["String"]},"description":"

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.

","name":"oauthSecretKey"}],"locus":"Anywhere"},"validateLoginAttempt":{"meta":{"range":[1621,1715],"filename":"accounts_server.js","lineno":51,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100001146","name":"Accounts.validateLoginAttempt","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Validate login attempts.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

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"}],"name":"validateLoginAttempt","longname":"Accounts.validateLoginAttempt","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000092","___s":true,"options":[],"locus":"Server"},"onLogin":{"meta":{"range":[1898,1973],"filename":"accounts_server.js","lineno":60,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100001160","name":"Accounts.onLogin","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Register a callback to be called after a login attempt succeeds.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

The callback to be called when login is successful.

","name":"func"}],"name":"onLogin","longname":"Accounts.onLogin","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000093","___s":true,"options":[],"locus":"Server"},"onLoginFailure":{"meta":{"range":[2155,2244],"filename":"accounts_server.js","lineno":69,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100001174","name":"Accounts.onLoginFailure","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Register a callback to be called after a login attempt fails.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

The callback to be called after the login has failed.

","name":"func"}],"name":"onLoginFailure","longname":"Accounts.onLoginFailure","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000094","___s":true,"options":[],"locus":"Server"},"onCreateUser":{"meta":{"range":[32747,32906],"filename":"accounts_server.js","lineno":986,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100003188","name":"Accounts.onCreateUser","type":"FunctionExpression","value":"function","paramnames":["func"]},"vars":{"onCreateUserHook":null}},"summary":"Customize new user creation.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

Called whenever a new user is created. Return the new user object, or throw an Error to abort the creation.

","name":"func"}],"name":"onCreateUser","longname":"Accounts.onCreateUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000300","___s":true,"options":[],"locus":"Server"},"validateNewUser":{"meta":{"range":[35595,35676],"filename":"accounts_server.js","lineno":1066,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100003411","name":"Accounts.validateNewUser","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Set restrictions on new user creation.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"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"}],"name":"validateNewUser","longname":"Accounts.validateNewUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000316","___s":true,"options":[],"locus":"Server"},"createUser":{"meta":{"range":[3912,4457],"filename":"password_client.js","lineno":108,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010072","name":"Accounts.createUser","type":"FunctionExpression","value":"function","paramnames":["options","callback"]},"vars":{"options":null,"options.password":null}},"summary":"Create a new user.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Object"]},"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Client only, optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"createUser","longname":"Accounts.createUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000759","___s":true,"options":[{"type":{"names":["String"]},"description":"

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":["Object"]},"description":"

The user's profile, typically including the name field.

","name":"profile"}],"locus":"Anywhere"},"changePassword":{"meta":{"range":[5240,6773],"filename":"password_client.js","lineno":145,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010139","name":"Accounts.changePassword","type":"FunctionExpression","value":"function","paramnames":["oldPassword","newPassword","callback"]},"vars":{"":null}},"summary":"Change the current user's password. Must be logged in.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"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":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"changePassword","longname":"Accounts.changePassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000765","___s":true,"options":[],"locus":"Client"},"forgotPassword":{"meta":{"range":[7284,7476],"filename":"password_client.js","lineno":206,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010280","name":"Accounts.forgotPassword","type":"FunctionExpression","value":"function","paramnames":["options","callback"]}},"summary":"Request a forgot password email.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object"]},"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"forgotPassword","longname":"Accounts.forgotPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000770","___s":true,"options":[{"type":{"names":["String"]},"description":"

The email address to send a password reset link.

","name":"email"}],"locus":"Client"},"resetPassword":{"meta":{"range":[8168,8544],"filename":"password_client.js","lineno":226,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010308","name":"Accounts.resetPassword","type":"FunctionExpression","value":"function","paramnames":["token","newPassword","callback"]}},"summary":"Reset the password for a user using a token received in email. Logs the user in afterwards.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

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":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"resetPassword","longname":"Accounts.resetPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000771","___s":true,"options":[],"locus":"Client"},"verifyEmail":{"meta":{"range":[9058,9288],"filename":"password_client.js","lineno":253,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010358","name":"Accounts.verifyEmail","type":"FunctionExpression","value":"function","paramnames":["token","callback"]}},"summary":"Marks the user's email address as verified. Logs the user in afterwards.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The token retrieved from the verification URL.

","name":"token"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"verifyEmail","longname":"Accounts.verifyEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000775","___s":true,"options":[],"locus":"Client"},"setPassword":{"meta":{"range":[10469,10842],"filename":"password_server.js","lineno":326,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011237","name":"Accounts.setPassword","type":"FunctionExpression","value":"function","paramnames":["userId","newPlaintextPassword"]},"vars":{"user":null}},"summary":"Forcibly change the password for a user.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to update.

","name":"userId"},{"type":{"names":["String"]},"description":"

A new password for the user.

","name":"newPassword"}],"name":"setPassword","longname":"Accounts.setPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000852","___s":true,"options":[],"locus":"Server"},"sendResetPasswordEmail":{"meta":{"range":[11744,13104],"filename":"password_server.js","lineno":364,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011341","name":"Accounts.sendResetPasswordEmail","type":"FunctionExpression","value":"function","paramnames":["userId","email"]},"vars":{"user":null,"email":null,"token":null,"when":null,"tokenRecord":null,".reset":null,"resetPasswordUrl":null,"options":null,"options.html":null}},"summary":"Send an email with a link the user can use to reset their password.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to send email to.

","name":"userId"},{"type":{"names":["String"]},"optional":true,"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.

","name":"email"}],"name":"sendResetPasswordEmail","longname":"Accounts.sendResetPasswordEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000863","___s":true,"options":[],"locus":"Server"},"sendEnrollmentEmail":{"meta":{"range":[13875,15304],"filename":"password_server.js","lineno":419,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011536","name":"Accounts.sendEnrollmentEmail","type":"FunctionExpression","value":"function","paramnames":["userId","email"]},"vars":{"user":null,"email":null,"token":null,"when":null,"tokenRecord":null,".reset":null,"enrollAccountUrl":null,"options":null,"options.html":null}},"summary":"Send an email with a link the user can use to set their initial password.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to send email to.

","name":"userId"},{"type":{"names":["String"]},"optional":true,"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.

","name":"email"}],"name":"sendEnrollmentEmail","longname":"Accounts.sendEnrollmentEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000882","___s":true,"options":[],"locus":"Server"},"sendVerificationEmail":{"meta":{"range":[18249,19994],"filename":"password_server.js","lineno":548,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011948","name":"Accounts.sendVerificationEmail","type":"FunctionExpression","value":"function","paramnames":["userId","address"]},"vars":{"user":null,"email":null,"":null,"address":null,"tokenRecord":null,"user.services.email.verificationTokens":null,"verifyEmailUrl":null,"options":null,"options.html":null}},"summary":"Send an email with a link the user can use verify their email address.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to send email to.

","name":"userId"},{"type":{"names":["String"]},"optional":true,"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.

","name":"email"}],"name":"sendVerificationEmail","longname":"Accounts.sendVerificationEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000924","___s":true,"options":[],"locus":"Server"}},"Meteor":{"comment":"/**\n * @summary The Meteor namespace\n * @namespace Meteor\n */","meta":{"range":[0,61],"filename":"client_environment.js","lineno":1,"path":"/Users/sashko/git/meteor/packages/meteor","code":{}},"summary":"The Meteor namespace","kind":"namespace","name":"Meteor","longname":"Meteor","___id":"T000002R066137","___s":true,"users":{"comment":"/**\n * @summary A [Mongo.Collection](#collections) containing user documents.\n * @locus Anywhere\n */","meta":{"range":[6937,7087],"filename":"accounts_common.js","lineno":140,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000887","name":"Meteor.users","type":"NewExpression","paramnames":[]}},"summary":"A [Mongo.Collection](#collections) containing user documents.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"users","longname":"Meteor.users","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R000066","___s":true,"locus":"Anywhere"},"isClient":{"comment":"/**\n * @summary Boolean variable. True if running in client environment.\n * @locus Anywhere\n * @static\n */","meta":{"range":[194,208],"filename":"client_environment.js","lineno":12,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387447","name":"isClient","type":"Literal","value":"true"}},"summary":"Boolean variable. True if running in client environment.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"scope":"static","name":"isClient","longname":"Meteor.isClient","kind":"member","memberof":"Meteor","___id":"T000002R066139","___s":true,"locus":"Anywhere"},"isServer":{"comment":"/**\n * @summary Boolean variable. True if running in server environment.\n * @locus Anywhere\n * @static\n */","meta":{"range":[331,346],"filename":"client_environment.js","lineno":19,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387449","name":"isServer","type":"Literal","value":"false"}},"summary":"Boolean variable. True if running in server environment.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"scope":"static","name":"isServer","longname":"Meteor.isServer","kind":"member","memberof":"Meteor","___id":"T000002R066140","___s":true,"locus":"Anywhere"},"settings":{"comment":"/**\n * @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.\n * @locus Anywhere\n */","meta":{"range":[1181,1254],"filename":"client_environment.js","lineno":28,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387462","name":"Meteor.settings","type":"ObjectExpression","value":"{\"undefined\":\"\"}","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"settings","longname":"Meteor.settings","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R066141","___s":true,"locus":"Anywhere"},"isCordova":{"comment":"/**\n * @summary Boolean variable. True if running in a Cordova mobile environment.\n * @locus Anywhere\n */","meta":{"range":[107,130],"filename":"cordova_environment.js","lineno":5,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387499","name":"Meteor.isCordova","type":"Literal","value":"true","paramnames":[]}},"summary":"Boolean variable. True if running in a Cordova mobile environment.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"isCordova","longname":"Meteor.isCordova","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R066143","___s":true,"locus":"Anywhere"},"release":{"comment":"/**\n * @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.\n * @locus Anywhere\n */","meta":{"range":[431,487],"filename":"helpers.js","lineno":10,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100389857","name":"Meteor.release","type":"MemberExpression","value":"__meteor_runtime_config__.meteorRelease","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"release","longname":"Meteor.release","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R066301","___s":true,"locus":"Anywhere"},"userId":{"meta":{"range":[193,263],"filename":"accounts_client.js","lineno":11,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000002","name":"Meteor.userId","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Get the current user id, or `null` if no user is logged in. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere but publish functions","value":"Anywhere but publish functions"}],"name":"userId","longname":"Meteor.userId","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000002","___s":true,"options":[],"params":[],"locus":"Anywhere but publish functions"},"loggingIn":{"meta":{"range":[829,909],"filename":"accounts_client.js","lineno":31,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000049","name":"Meteor.loggingIn","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"True if a login method (such as `Meteor.loginWithPassword`, `Meteor.loginWithFacebook`, or `Accounts.createUser`) is currently in progress. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"loggingIn","longname":"Meteor.loggingIn","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000007","___s":true,"options":[],"params":[],"locus":"Client"},"user":{"meta":{"range":[1103,1235],"filename":"accounts_client.js","lineno":42,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000063","name":"Meteor.user","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"userId":null}},"summary":"Get the current user record, or `null` if no user is logged in. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere but publish functions","value":"Anywhere but publish functions"}],"name":"user","longname":"Meteor.user","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000008","___s":true,"options":[],"params":[],"locus":"Anywhere but publish functions"},"logout":{"meta":{"range":[8760,9017],"filename":"accounts_client.js","lineno":226,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000423","name":"Meteor.logout","type":"FunctionExpression","value":"function","paramnames":["callback"]},"vars":{"":null}},"summary":"Log the user out.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"logout","longname":"Meteor.logout","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000039","___s":true,"options":[],"locus":"Client"},"logoutOtherClients":{"meta":{"range":[9302,10695],"filename":"accounts_client.js","lineno":242,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000465","name":"Meteor.logoutOtherClients","type":"FunctionExpression","value":"function","paramnames":["callback"]},"vars":{"":null}},"summary":"Log out other clients logged in as the current user, but does not log out the client that calls this function.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"logoutOtherClients","longname":"Meteor.logoutOtherClients","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000041","___s":true,"options":[],"locus":"Client"},"loginWithPassword":{"meta":{"range":[725,2207],"filename":"password_client.js","lineno":18,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100009879","name":"Meteor.loginWithPassword","type":"FunctionExpression","value":"function","paramnames":["selector","password","callback"]},"vars":{"selector":null,"":null}},"summary":"Log the user in with a password.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object","String"]},"description":"

Either a string interpreted as a username or an email; or an object with a single key: email, username or id.

","name":"user"},{"type":{"names":["String"]},"description":"

The user's password.

","name":"password"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"loginWithPassword","longname":"Meteor.loginWithPassword","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000736","___s":true,"options":[],"locus":"Client"},"subscribe":{"meta":{"range":[19053,23334],"filename":"livedata_connection.js","lineno":471,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100275342","name":"subscribe","type":"FunctionExpression","value":"function"},"vars":{"self":null,"params":null,"callbacks":null,"lastParam":null,"callbacks.onReady":null,"existing":null,"":null,"id":null,"existing.inactive":null,"existing.readyCallback":null,"existing.errorCallback":null,"self._subscriptions[undefined]":null,"handle":null}},"memberof":"Meteor","summary":"Subscribe to a record set. Returns a handle that provides `stop()` and `ready()` methods.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

Name of the subscription. Matches the name of the server's publish() call.

","name":"name"},{"type":{"names":["Any"]},"optional":true,"description":"

Optional arguments passed to publisher function on server.

","name":"arg1, arg2..."},{"type":{"names":["function","Object"]},"optional":true,"description":"

Optional. May include onError and onReady callbacks. If a function is passed instead of an object, it is interpreted as an onReady callback.

","name":"callbacks"}],"name":"subscribe","longname":"Meteor.subscribe","kind":"function","scope":"static","___id":"T000002R051354","___s":true,"options":[],"locus":"Client"},"call":{"meta":{"range":[24767,25144],"filename":"livedata_connection.js","lineno":637,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100275864","name":"call","type":"FunctionExpression","value":"function"},"vars":{"args":null,"callback":null}},"memberof":"Meteor","summary":"Invokes a method passing any number of arguments.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

Name of method to invoke

","name":"name"},{"type":{"names":["EJSONable"]},"optional":true,"description":"

Optional method arguments

","name":"arg1, arg2..."},{"type":{"names":["function"]},"optional":true,"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"}],"name":"call","longname":"Meteor.call","kind":"function","scope":"static","___id":"T000002R051404","___s":true,"options":[],"locus":"Anywhere"},"apply":{"meta":{"range":[27414,34762],"filename":"livedata_connection.js","lineno":678,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100275911","name":"apply","type":"FunctionExpression","value":"function"},"vars":{"self":null,"callback":null,"options":null,"args":null,"methodId":null,"":null,"enclosing":null,"alreadyInSimulation":null,"randomSeed":null,"randomSeedGenerator":null,"stub":null,"setUserId":null,"invocation":null,"stubReturnValue":null,"exception":null,"future":null,"message":null,"message.randomSeed":null,"methodInvoker":null}},"memberof":"Meteor","summary":"Invoke a method passing an array of arguments.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

Name of method to invoke

","name":"name"},{"type":{"names":["Array."]},"description":"

Method arguments

","name":"args"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback; same semantics as in Meteor.call.

","name":"asyncCallback"}],"name":"apply","longname":"Meteor.apply","kind":"function","scope":"static","___id":"T000002R051407","___s":true,"options":[{"type":{"names":["Boolean"]},"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":["function"]},"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"}],"locus":"Anywhere"},"status":{"meta":{"range":[37838,37967],"filename":"livedata_connection.js","lineno":963,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100276624","name":"status","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Get the current connection status. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Meteor","name":"status","longname":"Meteor.status","kind":"function","scope":"static","___id":"T000002R051473","___s":true,"options":[],"params":[],"locus":"Client"},"reconnect":{"meta":{"range":[38189,38324],"filename":"livedata_connection.js","lineno":975,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100276644","name":"reconnect","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Meteor","name":"reconnect","longname":"Meteor.reconnect","kind":"function","scope":"static","___id":"T000002R051475","___s":true,"options":[],"params":[],"locus":"Client"},"disconnect":{"meta":{"range":[38435,38572],"filename":"livedata_connection.js","lineno":985,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100276664","name":"disconnect","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Disconnect the client from the server.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Meteor","name":"disconnect","longname":"Meteor.disconnect","kind":"function","scope":"static","___id":"T000002R051477","___s":true,"options":[],"params":[],"locus":"Client"},"onConnection":{"meta":{"range":[42780,42881],"filename":"livedata_server.js","lineno":1298,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291393","name":"onConnection","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Register a callback to be called when a new DDP connection is made to the server.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

The function to call when a new DDP connection is established.

","name":"callback"}],"memberof":"Meteor","name":"onConnection","longname":"Meteor.onConnection","kind":"function","scope":"static","___id":"T000002R052814","___s":true,"options":[],"locus":"Server"},"publish":{"meta":{"range":[45712,47678],"filename":"livedata_server.js","lineno":1370,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291562","name":"publish","type":"FunctionExpression","value":"function"},"vars":{"self":null,"options":null,"self.warned_about_autopublish":null,"self.publish_handlers[undefined]":null,"":null}},"summary":"Publish a record set.","memberof":"Meteor","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"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":["function"]},"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"}],"name":"publish","longname":"Meteor.publish","kind":"function","scope":"static","___id":"T000002R052825","___s":true,"options":[],"locus":"Server"},"methods":{"meta":{"range":[48062,48324],"filename":"livedata_server.js","lineno":1435,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291722","name":"methods","type":"FunctionExpression","value":"function"},"vars":{"self":null,"":null}},"summary":"Defines functions that can be invoked over the network by clients.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Object"]},"description":"

Dictionary whose keys are method names and values are functions.

","name":"methods"}],"memberof":"Meteor","name":"methods","longname":"Meteor.methods","kind":"function","scope":"static","___id":"T000002R052832","___s":true,"options":[],"locus":"Anywhere"},"startup":{"meta":{"range":[740,1107],"filename":"startup_client.js","lineno":28,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100391831","name":"Meteor.startup","type":"FunctionExpression","value":"function","paramnames":["cb"]},"vars":{"doScroll":null,"":null}},"summary":"Run code when a client or a server starts.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["function"]},"description":"

A function to run on startup.

","name":"func"}],"name":"startup","longname":"Meteor.startup","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R066499","___s":true,"options":[],"locus":"Anywhere"},"setTimeout":{"meta":{"range":[959,1072],"filename":"timers.js","lineno":28,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100391994","name":"setTimeout","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Call a function in the future after waiting for a specified delay.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["function"]},"description":"

The function to run

","name":"func"},{"type":{"names":["Number"]},"description":"

Number of milliseconds to wait before calling function

","name":"delay"}],"name":"setTimeout","longname":"Meteor.setTimeout","kind":"function","scope":"static","___id":"T000002R066505","___s":true,"options":[],"locus":"Anywhere"},"setInterval":{"meta":{"range":[1341,1457],"filename":"timers.js","lineno":39,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392007","name":"setInterval","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Call a function repeatedly, with a time delay between calls.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["function"]},"description":"

The function to run

","name":"func"},{"type":{"names":["Number"]},"description":"

Number of milliseconds to wait between each function call.

","name":"delay"}],"name":"setInterval","longname":"Meteor.setInterval","kind":"function","scope":"static","___id":"T000002R066506","___s":true,"options":[],"locus":"Anywhere"},"clearInterval":{"meta":{"range":[1667,1728],"filename":"timers.js","lineno":49,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392020","name":"clearInterval","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Cancel a repeating function call scheduled by `Meteor.setInterval`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Number"]},"description":"

The handle returned by Meteor.setInterval

","name":"id"}],"name":"clearInterval","longname":"Meteor.clearInterval","kind":"function","scope":"static","___id":"T000002R066507","___s":true,"options":[],"locus":"Anywhere"},"clearTimeout":{"meta":{"range":[1926,1985],"filename":"timers.js","lineno":59,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392028","name":"clearTimeout","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Cancel a function call scheduled by `Meteor.setTimeout`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Number"]},"description":"

The handle returned by Meteor.setTimeout

","name":"id"}],"name":"clearTimeout","longname":"Meteor.clearTimeout","kind":"function","scope":"static","___id":"T000002R066508","___s":true,"options":[],"locus":"Anywhere"},"absoluteUrl":{"meta":{"range":[769,1903],"filename":"url_common.js","lineno":10,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392140","name":"Meteor.absoluteUrl","type":"FunctionExpression","value":"function","paramnames":["path","options"]},"vars":{"options":null,"path":null,"url":null}},"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 bundle`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"optional":true,"description":"

A path to append to the root URL. Do not include a leading "/".

","name":"path"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"absoluteUrl","longname":"Meteor.absoluteUrl","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R066515","___s":true,"options":[{"type":{"names":["Boolean"]},"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":["String"]},"description":"

Override the default ROOT_URL from the server environment. For example: "http://foo.example.com"

","name":"rootUrl"}],"locus":"Anywhere"},"Error":{"meta":{"range":[1911,3068],"filename":"errors.js","lineno":53,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100388767","name":"Meteor.Error","type":"CallExpression","paramnames":[]}},"summary":"This class represents a symbolic error thrown by a method.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"class","params":[{"type":{"names":["Number"]},"description":"

A numeric error code, likely similar to an HTTP code (eg, 404, 500).

","name":"error"},{"type":{"names":["String"]},"optional":true,"description":"

Optional. A short human-readable summary of the error, like 'Not Found'.

","name":"reason"},{"type":{"names":["String"]},"optional":true,"description":"

Optional. Additional information about the error, like a textual stack trace.

","name":"details"}],"name":"Error","longname":"Meteor.Error","memberof":"Meteor","scope":"static","___id":"T000002R066215","___s":true,"options":[],"locus":"Anywhere"}},"Mongo":{"comment":"/**\n * @summary Namespace for MongoDB-related items\n * @namespace\n */","meta":{"range":[208,218],"filename":"collection.js","lineno":8,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100415826","name":"Mongo","type":"ObjectExpression","value":"{}","paramnames":[]}},"summary":"Namespace for MongoDB-related items","kind":"namespace","name":"Mongo","longname":"Mongo","scope":"global","___id":"T000002R068699","___s":true,"Cursor#forEach":{"meta":{"range":[4879,5293],"filename":"minimongo.js","lineno":147,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Call `callback` once for each matching document, sequentially and synchronously.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"forEach","scope":"instance","memberof":"Mongo.Cursor","params":[{"type":{"names":["function"]},"description":"

Function to call. It will be called with three arguments: the document, a 0-based index, and cursor itself.

","name":"callback"},{"type":{"names":["Any"]},"optional":true,"description":"

An object which will be the value of this inside callback.

","name":"thisArg"}],"longname":"Mongo.Cursor#forEach","___id":"T000002R066837","___s":true,"options":[],"locus":"Anywhere"},"Cursor#map":{"meta":{"range":[6047,6436],"filename":"minimongo.js","lineno":188,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Map callback over all matching documents. Returns an Array.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"map","scope":"instance","memberof":"Mongo.Cursor","params":[{"type":{"names":["function"]},"description":"

Function to call. It will be called with three arguments: the document, a 0-based index, and cursor itself.

","name":"callback"},{"type":{"names":["Any"]},"optional":true,"description":"

An object which will be the value of this inside callback.

","name":"thisArg"}],"longname":"Mongo.Cursor#map","___id":"T000002R066850","___s":true,"options":[],"locus":"Anywhere"},"Cursor#fetch":{"meta":{"range":[6661,6799],"filename":"minimongo.js","lineno":206,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Return all matching documents as an Array.","memberof":"Mongo.Cursor","kind":"function","name":"fetch","scope":"instance","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"longname":"Mongo.Cursor#fetch","___id":"T000002R066854","___s":true,"options":[],"params":[],"locus":"Anywhere"},"Cursor#count":{"meta":{"range":[6965,7112],"filename":"minimongo.js","lineno":222,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Returns the number of documents that match a query.","memberof":"Mongo.Cursor","kind":"function","name":"count","scope":"instance","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"longname":"Mongo.Cursor#count","___id":"T000002R066858","___s":true,"options":[],"params":[],"locus":"Anywhere"},"Cursor#observe":{"meta":{"range":[9823,9947],"filename":"minimongo.js","lineno":304,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{"id":"astnode100397156","name":"observe","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Watch a query. Receive callbacks as the result set changes.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"memberof":"Mongo.Cursor","scope":"instance","params":[{"type":{"names":["Object"]},"description":"

Functions to call to deliver the result set as it changes

","name":"callbacks"}],"name":"observe","longname":"Mongo.Cursor#observe","kind":"function","___id":"T000002R066872","___s":true,"options":[],"locus":"Anywhere"},"Cursor#observeChanges":{"meta":{"range":[10277,14230],"filename":"minimongo.js","lineno":316,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{"id":"astnode100397171","name":"observeChanges","type":"FunctionExpression","value":"function"},"vars":{"self":null,"ordered":null,"query":null,"qid":null,"self.collection.queries[undefined]":null,"query.results":null,"query.resultsSnapshot":null,"wrapCallback":null,"":null,"query.added":null,"query.changed":null,"query.removed":null,"query.addedBefore":null,"query.movedBefore":null,"each":null,"handle":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"memberof":"Mongo.Cursor","scope":"instance","params":[{"type":{"names":["Object"]},"description":"

Functions to call to deliver the result set as it changes

","name":"callbacks"}],"name":"observeChanges","longname":"Mongo.Cursor#observeChanges","kind":"function","___id":"T000002R066874","___s":true,"options":[],"locus":"Anywhere"},"Collection#insert":{"meta":{"range":[15970,16408],"filename":"collection.js","lineno":413,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Insert a document in the collection. Returns its unique _id.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"insert","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["Object"]},"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":["function"]},"optional":true,"description":"

Optional. If present, called with an error object as the first argument and, if no error, the _id as the second.

","name":"callback"}],"longname":"Mongo.Collection#insert","___id":"T000002R068697","___s":true,"options":[],"locus":"Anywhere"},"Collection#update":{"meta":{"range":[16410,17179],"filename":"collection.js","lineno":423,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Modify one or more documents in the collection. Returns the number of affected documents.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"update","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"description":"

Specifies which documents to modify

","name":"selector"},{"type":{"names":["MongoModifier"]},"description":"

Specifies how to modify the documents

","name":"modifier"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"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"}],"longname":"Mongo.Collection#update","___id":"T000002R068698","___s":true,"options":[{"type":{"names":["Boolean"]},"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"}],"locus":"Anywhere"},"Collection#find":{"meta":{"range":[9244,10107],"filename":"collection.js","lineno":251,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Find the documents in a collection that match the selector.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"find","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"optional":true,"description":"

A query describing the documents to find

","name":"selector"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"longname":"Mongo.Collection#find","___id":"T000002R068750","___s":true,"options":[{"type":{"names":["MongoSortSpecifier"]},"description":"

Sort order (default: natural order)

","name":"sort"},{"type":{"names":["Number"]},"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":["MongoFieldSpecifier"]},"description":"

Dictionary of fields to return or exclude.

","name":"fields"},{"type":{"names":["Boolean"]},"description":"

(Client only) Default true; pass false to disable reactivity

","name":"reactive"},{"type":{"names":["function"]},"description":"

Overrides transform on the Collection for this cursor. Pass null to disable transformation.

","name":"transform"}],"locus":"Anywhere"},"Collection#findOne":{"meta":{"range":[10527,11346],"filename":"collection.js","lineno":276,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Finds the first document that matches the selector, as ordered by sort and skip options.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"findOne","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"optional":true,"description":"

A query describing the documents to find

","name":"selector"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"longname":"Mongo.Collection#findOne","___id":"T000002R068754","___s":true,"options":[{"type":{"names":["MongoSortSpecifier"]},"description":"

Sort order (default: natural order)

","name":"sort"},{"type":{"names":["Number"]},"description":"

Number of results to skip at the beginning

","name":"skip"},{"type":{"names":["MongoFieldSpecifier"]},"description":"

Dictionary of fields to return or exclude.

","name":"fields"},{"type":{"names":["Boolean"]},"description":"

(Client only) Default true; pass false to disable reactivity

","name":"reactive"},{"type":{"names":["function"]},"description":"

Overrides transform on the Collection for this cursor. Pass null to disable transformation.

","name":"transform"}],"locus":"Anywhere"},"Collection#remove":{"meta":{"range":[17181,17488],"filename":"collection.js","lineno":437,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Remove documents from the collection","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"remove","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"description":"

Specifies which documents to remove

","name":"selector"},{"type":{"names":["function"]},"optional":true,"description":"

Optional. If present, called with an error object as its argument.

","name":"callback"}],"longname":"Mongo.Collection#remove","___id":"T000002R068781","___s":true,"options":[],"locus":"Anywhere"},"Collection#upsert":{"meta":{"range":[23728,24123],"filename":"collection.js","lineno":599,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417428","name":"Mongo.Collection.prototype.upsert","type":"FunctionExpression","value":"function","paramnames":["selector","modifier","options","callback"]},"vars":{"self":null,"callback":null,"options":null}},"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).","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["MongoSelector"]},"description":"

Specifies which documents to modify

","name":"selector"},{"type":{"names":["MongoModifier"]},"description":"

Specifies how to modify the documents

","name":"modifier"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"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"}],"name":"upsert","longname":"Mongo.Collection#upsert","kind":"function","memberof":"Mongo.Collection","scope":"instance","___id":"T000002R068811","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"

True to modify all matching documents; false to only modify one of the matching documents (the default).

","name":"multi"}],"locus":"Anywhere"},"Collection#allow":{"meta":{"range":[29479,29584],"filename":"collection.js","lineno":748,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417838","name":"Mongo.Collection.prototype.allow","type":"FunctionExpression","value":"function","paramnames":["options"]}},"summary":"Allow users to write directly to this collection from client code, subject to limitations you define.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"allow","longname":"Mongo.Collection#allow","kind":"function","memberof":"Mongo.Collection","scope":"instance","___id":"T000002R068835","___s":true,"options":[{"type":{"names":["function"]},"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":["Array."]},"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":["function"]},"description":"

Overrides transform on the Collection. Pass null to disable transformation.

","name":"transform"}],"locus":"Server"},"Collection#deny":{"meta":{"range":[30215,30318],"filename":"collection.js","lineno":760,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417858","name":"Mongo.Collection.prototype.deny","type":"FunctionExpression","value":"function","paramnames":["options"]}},"summary":"Override `allow` rules.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"deny","longname":"Mongo.Collection#deny","kind":"function","memberof":"Mongo.Collection","scope":"instance","___id":"T000002R068836","___s":true,"options":[{"type":{"names":["function"]},"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":["Array."]},"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":["function"]},"description":"

Overrides transform on the Collection. Pass null to disable transformation.

","name":"transform"}],"locus":"Server"},"Collection":{"meta":{"range":[1485,8485],"filename":"collection.js","lineno":26,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100415830","name":"Mongo.Collection","type":"FunctionExpression","value":"function","paramnames":["name","options"]},"vars":{"self":null,"name":null,"options":null,"options.connection":null,"self._makeNewID":null,"":null,"self._transform":null,"self._connection":null,"options._driver":null,"self._collection":null,"self._name":null,"ok":null}},"summary":"Constructor for a Collection","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"},{"originalTitle":"instancename","title":"instancename","text":"collection","value":"collection"}],"kind":"class","params":[{"type":{"names":["String"]},"description":"

The name of the collection. If null, creates an unmanaged (unsynchronized) local collection.

","name":"name"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"Collection","longname":"Mongo.Collection","memberof":"Mongo","scope":"static","___id":"T000002R068700","___s":true,"options":[{"type":{"names":["Object"]},"description":"

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.

","name":"connection"},{"type":{"names":["String"]},"description":"

The method of generating the _id fields of new documents in this collection. Possible values:

\n\n

The default id generation technique is 'STRING'.

","name":"idGeneration"},{"type":{"names":["function"]},"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"}],"locus":"Anywhere","instancename":"collection"},"ObjectID":{"meta":{"range":[25545,25587],"filename":"collection.js","lineno":644,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417623","name":"Mongo.ObjectID","type":"MemberExpression","value":"LocalCollection._ObjectID","paramnames":[]}},"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).","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"class","params":[{"type":{"names":["String"]},"description":"

Optional. The 24-character hexadecimal contents of the ObjectID to create

","name":"hexString"}],"name":"ObjectID","longname":"Mongo.ObjectID","memberof":"Mongo","scope":"static","___id":"T000002R068825","___s":true,"options":[],"locus":"Anywhere"},"Cursor":{"meta":{"range":[25739,25776],"filename":"collection.js","lineno":651,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417631","name":"Mongo.Cursor","type":"MemberExpression","value":"LocalCollection.Cursor","paramnames":[]}},"summary":"To create a cursor, use find. To access the documents in a cursor, use forEach, map, or fetch.","kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"cursor","value":"cursor"}],"name":"Cursor","longname":"Mongo.Cursor","memberof":"Mongo","scope":"static","___id":"T000002R068826","___s":true,"options":[],"params":[],"instancename":"cursor"}},"Assets":{"comment":"/**\n * @summary The namespace for Assets functions, lives in the bundler.\n * @namespace\n * @name Assets\n */","meta":{"range":[39793,39932],"filename":"bundler.js","lineno":1099,"path":"/Users/sashko/git/meteor/tools","code":{}},"summary":"The namespace for Assets functions, lives in the bundler.","kind":"namespace","name":"Assets","longname":"Assets","___id":"T000002R079094","___s":true,"getText":{"meta":{"range":[40464,40588],"filename":"bundler.js","lineno":1113,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100552304","name":"getText","type":"FunctionExpression","value":"function"}},"summary":"Retrieve the contents of the static server asset as a UTF8-encoded string.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Assets","params":[{"type":{"names":["String"]},"description":"

The path of the asset, relative to the application's private subdirectory.

","name":"assetPath"},{"type":{"names":["function"]},"optional":true,"description":"

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"}],"name":"getText","longname":"Assets.getText","kind":"function","scope":"static","___id":"T000002R079096","___s":true,"options":[],"locus":"Server"},"getBinary":{"meta":{"range":[41116,41245],"filename":"bundler.js","lineno":1124,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100552318","name":"getBinary","type":"FunctionExpression","value":"function"}},"summary":"Retrieve the contents of the static server asset as an [EJSON Binary](#ejson_new_binary).","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Assets","params":[{"type":{"names":["String"]},"description":"

The path of the asset, relative to the application's private subdirectory.

","name":"assetPath"},{"type":{"names":["function"]},"description":"

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"}],"name":"getBinary","longname":"Assets.getBinary","kind":"function","scope":"static","___id":"T000002R079097","___s":true,"options":[],"locus":"Server"}},"Package":{"comment":"/**\n * @global\n * @name Package\n * @summary The Package object in package.js\n * @namespace\n * @locus package.js\n */","meta":{"range":[18303,18443],"filename":"package-source.js","lineno":473,"path":"/Users/sashko/git/meteor/tools","code":{}},"scope":"global","name":"Package","summary":"The Package object in package.js","kind":"namespace","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"longname":"Package","___id":"T000002R082866","___s":true,"locus":"package.js","describe":{"meta":{"range":[19530,20633],"filename":"package-source.js","lineno":499,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100600028","name":"describe","type":"FunctionExpression","value":"function"},"vars":{"":null}},"summary":"Provide basic package information.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"memberof":"Package","params":[{"type":{"names":["Object"]},"name":"options"}],"name":"describe","longname":"Package.describe","kind":"function","scope":"static","___id":"T000002R082868","___s":true,"options":[{"type":{"names":["String"]},"description":"

A concise 1-2 sentence description of the package, required for publication.

","name":"summary"},{"type":{"names":["String"]},"description":"

The semver version for your package. If no version is specified, defaults to 0.0.0. You need to specify a version to publish to the package server.

","name":"version"},{"type":{"names":["String"]},"description":"

Optional name override. By default, the package name comes from the name of its directory.

","name":"name"},{"type":{"names":["String"]},"description":"

Optional Git URL to the source repository.

","name":"git"}],"locus":"package.js"},"onUse":{"meta":{"range":[20928,21289],"filename":"package-source.js","lineno":533,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100600119","name":"onUse","type":"FunctionExpression","value":"function"},"vars":{"fileAndDepLoader":null}},"summary":"Define package dependencies and expose package methods.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"memberof":"Package","params":[{"type":{"names":["function"]},"description":"

A function that takes in the package control 'api' object, which keeps track of dependencies and exports.

","name":"func"}],"name":"onUse","longname":"Package.onUse","kind":"function","scope":"static","___id":"T000002R082873","___s":true,"options":[],"locus":"package.js"},"onTest":{"meta":{"range":[21703,22476],"filename":"package-source.js","lineno":558,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100600158","name":"onTest","type":"FunctionExpression","value":"function"},"vars":{"hasTests":null,"fileAndDepLoader":null}},"summary":"Define dependencies and expose package methods for unit tests.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"memberof":"Package","params":[{"type":{"names":["function"]},"description":"

A function that takes in the package control 'api' object, which keeps track of dependencies and exports.

","name":"func"}],"name":"onTest","longname":"Package.onTest","kind":"function","scope":"static","___id":"T000002R082877","___s":true,"options":[],"locus":"package.js"}},"Template#created":{"comment":"/**\n * @name created\n * @instance\n * @memberOf Template\n * @summary Provide a callback when an instance of a template is created.\n * @locus Client\n */","meta":{"range":[3549,3712],"filename":"template.js","lineno":105,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"created","scope":"instance","memberof":"Template","summary":"Provide a callback when an instance of a template is created.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Template#created","kind":"member","___id":"T000002R003232","___s":true,"locus":"Client"},"Template#rendered":{"comment":"/**\n * @name rendered\n * @instance\n * @memberOf Template\n * @summary Provide a callback when an instance of a template is rendered.\n * @locus Client\n */","meta":{"range":[3837,4002],"filename":"template.js","lineno":118,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"rendered","scope":"instance","memberof":"Template","summary":"Provide a callback when an instance of a template is rendered.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Template#rendered","kind":"member","___id":"T000002R003233","___s":true,"locus":"Client"},"Template#destroyed":{"comment":"/**\n * @name destroyed\n * @instance\n * @memberOf Template\n * @summary Provide a callback when an instance of a template is destroyed.\n * @locus Client\n */","meta":{"range":[4127,4294],"filename":"template.js","lineno":131,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"destroyed","scope":"instance","memberof":"Template","summary":"Provide a callback when an instance of a template is destroyed.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Template#destroyed","kind":"member","___id":"T000002R003234","___s":true,"locus":"Client"},"Blaze":{"TemplateInstance#data":{"comment":"/**\n * @instance\n * @memberOf Blaze.TemplateInstance\n * @name data\n * @summary The data context of this instance's latest invocation.\n * @locus Client\n */","meta":{"range":[3010,3189],"filename":"template.js","lineno":84,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"scope":"instance","memberof":"Blaze.TemplateInstance","name":"data","summary":"The data context of this instance's latest invocation.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#data","kind":"member","___id":"T000002R003252","___s":true,"locus":"Client"},"TemplateInstance#view":{"comment":"/**\n * @name view\n * @memberOf Blaze.TemplateInstance\n * @instance\n * @summary The [View](#blaze_view) object for this invocation of the template.\n * @locus Client\n */","meta":{"range":[4839,5018],"filename":"template.js","lineno":163,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"view","memberof":"Blaze.TemplateInstance","scope":"instance","summary":"The [View](#blaze_view) object for this invocation of the template.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#view","kind":"member","___id":"T000002R003260","___s":true,"locus":"Client"},"TemplateInstance#firstNode":{"comment":"/**\n * @name firstNode\n * @memberOf Blaze.TemplateInstance\n * @instance\n * @summary The first top-level DOM node in this template instance.\n * @locus Client\n */","meta":{"range":[5062,5234],"filename":"template.js","lineno":173,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"firstNode","memberof":"Blaze.TemplateInstance","scope":"instance","summary":"The first top-level DOM node in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#firstNode","kind":"member","___id":"T000002R003263","___s":true,"locus":"Client"},"TemplateInstance#lastNode":{"comment":"/**\n * @name lastNode\n * @memberOf Blaze.TemplateInstance\n * @instance\n * @summary The last top-level DOM node in this template instance.\n * @locus Client\n */","meta":{"range":[5263,5433],"filename":"template.js","lineno":182,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"lastNode","memberof":"Blaze.TemplateInstance","scope":"instance","summary":"The last top-level DOM node in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#lastNode","kind":"member","___id":"T000002R003265","___s":true,"locus":"Client"},"currentView":{"comment":"/**\n * @summary The View corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.\n * @locus Client\n */","meta":{"range":[13709,13733],"filename":"view.js","lineno":398,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046370","name":"Blaze.currentView","type":"Literal","value":"null","paramnames":[]}},"summary":"The View corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"currentView","longname":"Blaze.currentView","kind":"member","memberof":"Blaze","scope":"static","___id":"T000002R003376","___s":true,"locus":"Client"},"With":{"meta":{"range":[504,908],"filename":"builtins.js","lineno":13,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100035866","name":"Blaze.With","type":"FunctionExpression","value":"function","paramnames":["data","contentFunc"]},"vars":{"view":null,"view.dataVar":null,"":null}},"summary":"Constructs a View that renders content with a data context.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object","function"]},"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":["function"]},"description":"

A Function that returns renderable content.

","name":"contentFunc"}],"name":"With","longname":"Blaze.With","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002663","___s":true,"options":[],"locus":"Client"},"If":{"meta":{"range":[1488,2009],"filename":"builtins.js","lineno":39,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100035934","name":"Blaze.If","type":"FunctionExpression","value":"function","paramnames":["conditionFunc","contentFunc","elseFunc","_not"]},"vars":{"conditionVar":null,"view":null,"":null,"view.__conditionVar":null}},"summary":"Constructs a View that renders content conditionally.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"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.

","name":"conditionFunc"},{"type":{"names":["function"]},"description":"

A Function that returns renderable content.

","name":"contentFunc"},{"type":{"names":["function"]},"optional":true,"description":"

Optional. A Function that returns renderable content. If no elseFunc is supplied, no content is shown in the "else" case.

","name":"elseFunc"}],"name":"If","longname":"Blaze.If","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002666","___s":true,"options":[],"locus":"Client"},"Unless":{"meta":{"range":[2556,2694],"filename":"builtins.js","lineno":64,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100036020","name":"Blaze.Unless","type":"FunctionExpression","value":"function","paramnames":["conditionFunc","contentFunc","elseFunc"]}},"summary":"An inverted [`Blaze.If`](#blaze_if).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"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"]},"optional":true,"description":"

Optional. A Function that returns renderable content. If no elseFunc is supplied, no content is shown in the "else" case.

","name":"elseFunc"}],"name":"Unless","longname":"Blaze.Unless","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002671","___s":true,"options":[],"locus":"Client"},"Each":{"meta":{"range":[3207,6975],"filename":"builtins.js","lineno":75,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100036039","name":"Blaze.Each","type":"FunctionExpression","value":"function","paramnames":["argFunc","contentFunc","elseFunc"]},"vars":{"eachView":null,"":null,"eachView.initialSubviews":null,"eachView.numItems":null,"eachView.inElseMode":null,"eachView.stopHandle":null,"eachView.contentFunc":null,"eachView.elseFunc":null,"eachView.argVar":null}},"summary":"Constructs a View that renders `contentFunc` for each item in a sequence.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"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"]},"optional":true,"description":"

Optional. A Function that returns renderable content to display in the case when there are no items to display.

","name":"elseFunc"}],"name":"Each","longname":"Blaze.Each","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002672","___s":true,"options":[],"locus":"Client"},"isTemplate":{"meta":{"range":[1519,1594],"filename":"template.js","lineno":43,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044519","name":"Blaze.isTemplate","type":"FunctionExpression","value":"function","paramnames":["t"]}},"summary":"Returns true if `value` is a template object like `Template.myTemplate`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Any"]},"description":"

The value to test.

","name":"value"}],"name":"isTemplate","longname":"Blaze.isTemplate","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003242","___s":true,"options":[],"locus":"Client"},"TemplateInstance#$":{"meta":{"range":[5688,5902],"filename":"template.js","lineno":197,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044877","name":"Blaze.TemplateInstance.prototype.$","type":"FunctionExpression","value":"function","paramnames":["selector"]},"vars":{"view":null}},"summary":"Find all elements matching `selector` in this template instance, and return them as a JQuery object.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The CSS selector to match, scoped to the template contents.

","name":"selector"}],"name":"$","longname":"Blaze.TemplateInstance#$","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003267","___s":true,"options":[],"locus":"Client"},"TemplateInstance#findAll":{"meta":{"range":[6095,6216],"filename":"template.js","lineno":209,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044912","name":"Blaze.TemplateInstance.prototype.findAll","type":"FunctionExpression","value":"function","paramnames":["selector"]}},"summary":"Find all elements matching `selector` in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The CSS selector to match, scoped to the template contents.

","name":"selector"}],"name":"findAll","longname":"Blaze.TemplateInstance#findAll","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003269","___s":true,"options":[],"locus":"Client"},"TemplateInstance#find":{"meta":{"range":[6408,6532],"filename":"template.js","lineno":218,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044938","name":"Blaze.TemplateInstance.prototype.find","type":"FunctionExpression","value":"function","paramnames":["selector"]},"vars":{"result":null}},"summary":"Find one element matching `selector` in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The CSS selector to match, scoped to the template contents.

","name":"selector"}],"name":"find","longname":"Blaze.TemplateInstance#find","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003270","___s":true,"options":[],"locus":"Client"},"TemplateInstance#autorun":{"meta":{"range":[6775,6865],"filename":"template.js","lineno":228,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044964","name":"Blaze.TemplateInstance.prototype.autorun","type":"FunctionExpression","value":"function","paramnames":["f"]}},"summary":"A version of [Tracker.autorun](#tracker_autorun) that is stopped when the template is destroyed.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

The function to run. It receives one argument: a Tracker.Computation object.

","name":"runFunc"}],"name":"autorun","longname":"Blaze.TemplateInstance#autorun","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003272","___s":true,"options":[],"locus":"Client"},"render":{"meta":{"range":[16631,17688],"filename":"view.js","lineno":480,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046546","name":"Blaze.render","type":"FunctionExpression","value":"function","paramnames":["content","parentElement","nextNode","parentView"]},"vars":{"parentView":null,"nextNode":null,"view":null}},"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).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"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":["DOMNode"]},"description":"

The node that will be the parent of the rendered template. It must be an Element node.

","name":"parentNode"},{"type":{"names":["DOMNode"]},"optional":true,"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"},{"type":{"names":["Blaze.View"]},"optional":true,"description":"

Optional. If provided, it will be set as the rendered View's parentView.

","name":"parentView"}],"name":"render","longname":"Blaze.render","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003386","___s":true,"options":[],"locus":"Client"},"renderWithData":{"meta":{"range":[18961,19310],"filename":"view.js","lineno":531,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046686","name":"Blaze.renderWithData","type":"FunctionExpression","value":"function","paramnames":["content","data","parentElement","nextNode","parentView"]}},"summary":"Renders a template or View to DOM nodes with a data context. Otherwise identical to `Blaze.render`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"description":"

The template (e.g. Template.myTemplate) or View object to render.

","name":"templateOrView"},{"type":{"names":["Object","function"]},"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":["DOMNode"]},"description":"

The node that will be the parent of the rendered template. It must be an Element node.

","name":"parentNode"},{"type":{"names":["DOMNode"]},"optional":true,"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"},{"type":{"names":["Blaze.View"]},"optional":true,"description":"

Optional. If provided, it will be set as the rendered View's parentView.

","name":"parentView"}],"name":"renderWithData","longname":"Blaze.renderWithData","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003392","___s":true,"options":[],"locus":"Client"},"remove":{"meta":{"range":[19545,19863],"filename":"view.js","lineno":543,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046714","name":"Blaze.remove","type":"FunctionExpression","value":"function","paramnames":["view"]},"vars":{"range":null}},"summary":"Removes a rendered View from the DOM, stopping all reactive updates and event listeners on it.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Blaze.View"]},"description":"

The return value from Blaze.render or Blaze.renderWithData.

","name":"renderedView"}],"name":"remove","longname":"Blaze.remove","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003393","___s":true,"options":[],"locus":"Client"},"toHTML":{"meta":{"range":[20084,20266],"filename":"view.js","lineno":560,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046768","name":"Blaze.toHTML","type":"FunctionExpression","value":"function","paramnames":["content","parentView"]},"vars":{"parentView":null}},"summary":"Renders a template or View to a string of HTML.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"description":"

The template (e.g. Template.myTemplate) or View object from which to generate HTML.

","name":"templateOrView"}],"name":"toHTML","longname":"Blaze.toHTML","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003395","___s":true,"options":[],"locus":"Client"},"toHTMLWithData":{"meta":{"range":[20633,20861],"filename":"view.js","lineno":572,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046797","name":"Blaze.toHTMLWithData","type":"FunctionExpression","value":"function","paramnames":["content","data","parentView"]},"vars":{"parentView":null}},"summary":"Renders a template or View to HTML with a data context. Otherwise identical to `Blaze.toHTML`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"description":"

The template (e.g. Template.myTemplate) or View object from which to generate HTML.

","name":"templateOrView"},{"type":{"names":["Object","function"]},"description":"

The data context to use, or a function returning a data context.

","name":"data"}],"name":"toHTMLWithData","longname":"Blaze.toHTMLWithData","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003397","___s":true,"options":[],"locus":"Client"},"getData":{"meta":{"range":[21866,22474],"filename":"view.js","lineno":605,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046928","name":"Blaze.getData","type":"FunctionExpression","value":"function","paramnames":["elementOrView"]},"vars":{"theWith":null,"view":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["DOMElement","Blaze.View"]},"optional":true,"description":"

Optional. An element that was rendered by a Meteor, or a View.

","name":"elementOrView"}],"name":"getData","longname":"Blaze.getData","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003403","___s":true,"options":[],"locus":"Client"},"getView":{"meta":{"range":[23015,23726],"filename":"view.js","lineno":643,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100047052","name":"Blaze.getView","type":"FunctionExpression","value":"function","paramnames":["elementOrView","_viewName"]},"vars":{"viewName":null,"elementOrView":null}},"summary":"Gets either the current View, or the View enclosing the given DOM element.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["DOMElement"]},"optional":true,"description":"

Optional. If specified, the View enclosing element is returned.

","name":"element"}],"name":"getView","longname":"Blaze.getView","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003410","___s":true,"options":[],"locus":"Client"},"Template":{"meta":{"range":[725,1334],"filename":"template.js","lineno":16,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044440","name":"Blaze.Template","type":"FunctionExpression","value":"function","paramnames":["viewName","renderFunction"]},"vars":{"renderFunction":null,"viewName":null,"this.viewName":null,"this.renderFunction":null,"this.__eventMaps":null}},"kind":"class","summary":"Constructor for a Template, which is used to construct Views with particular name and content.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"optional":true,"description":"

Optional. A name for Views constructed by this Template. See view.name.

","name":"viewName"},{"type":{"names":["function"]},"description":"

A function that returns renderable content. This function is used as the renderFunction for Views constructed by this Template.

","name":"renderFunction"}],"name":"Template","longname":"Blaze.Template","memberof":"Blaze","scope":"static","___id":"T000002R003235","___s":true,"options":[],"locus":"Client"},"TemplateInstance":{"meta":{"range":[4559,5459],"filename":"template.js","lineno":153,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044815","name":"Blaze.TemplateInstance","type":"FunctionExpression","value":"function","paramnames":["view"]},"vars":{"view._templateInstance":null,"this.view":null,"this.data":null,"this.firstNode":null,"this.lastNode":null}},"kind":"class","summary":"The class for template instances","params":[{"type":{"names":["Blaze.View"]},"name":"view"}],"tags":[{"originalTitle":"instanceName","title":"instancename","text":"template","value":"template"}],"name":"TemplateInstance","longname":"Blaze.TemplateInstance","memberof":"Blaze","scope":"static","___id":"T000002R003258","___s":true,"options":[],"instancename":"template"},"View":{"meta":{"range":[1982,2788],"filename":"view.js","lineno":43,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045172","name":"Blaze.View","type":"FunctionExpression","value":"function","paramnames":["name","render"]},"vars":{"render":null,"name":null,"this.name":null,"this._render":null,"this._callbacks":null,"this.isCreated":null,"this._isCreatedForExpansion":null,"this.isRendered":null,"this._isAttached":null,"this.isDestroyed":null,"this._isInRender":null,"this.parentView":null,"this._domrange":null,"this.renderCount":null}},"kind":"class","summary":"Constructor for a View, which represents a reactive region of DOM.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"optional":true,"description":"

Optional. A name for this type of View. See view.name.

","name":"name"},{"type":{"names":["function"]},"description":"

A function that returns renderable content. In this function, this is bound to the View.

","name":"renderFunction"}],"name":"View","longname":"Blaze.View","memberof":"Blaze","scope":"static","___id":"T000002R003293","___s":true,"options":[],"locus":"Client"}},"Template":{"instance":{"comment":"/**\n * @name instance\n * @memberOf Template\n * @summary The [template instance](#template_inst) corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.\n * @locus Client\n */","meta":{"range":[7904,8132],"filename":"template.js","lineno":268,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"instance","memberof":"Template","summary":"The [template instance](#template_inst) corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"scope":"static","longname":"Template.instance","kind":"member","___id":"T000002R003286","___s":true,"locus":"Client"},"body":{"comment":"/**\n * @summary The [template object](#templates_api) representing your `` tag.\n * @locus Client\n */","meta":{"range":[1019,1256],"filename":"templating.js","lineno":34,"path":"/Users/sashko/git/meteor/packages/templating","code":{"id":"astnode100525196","name":"Template.body","type":"NewExpression","paramnames":[]}},"summary":"The [template object](#templates_api) representing your `` tag.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"body","longname":"Template.body","kind":"member","memberof":"Template","scope":"static","___id":"T000002R076945","___s":true,"locus":"Client"},"currentData":{"meta":{"range":[8672,8708],"filename":"template.js","lineno":294,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045147","name":"Template.currentData","type":"MemberExpression","value":"Blaze.getData","paramnames":[]}},"summary":"Returns the data context of the current helper, or the data context of the template that declares the current event handler or callback. Establishes a reactive dependency on the result.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"kind":"function","name":"currentData","longname":"Template.currentData","memberof":"Template","scope":"static","___id":"T000002R003290","___s":true,"options":[],"params":[],"locus":"Client"},"parentData":{"meta":{"range":[8921,8960],"filename":"template.js","lineno":302,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045155","name":"Template.parentData","type":"MemberExpression","value":"Blaze._parentData","paramnames":[]}},"summary":"Accesses other data contexts that enclose the current data context.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"kind":"function","params":[{"type":{"names":["Integer"]},"description":"

The number of levels beyond the current data context to look.

","name":"numLevels"}],"name":"parentData","longname":"Template.parentData","memberof":"Template","scope":"static","___id":"T000002R003291","___s":true,"options":[],"locus":"Client"},"registerHelper":{"meta":{"range":[9230,9276],"filename":"template.js","lineno":311,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045163","name":"Template.registerHelper","type":"MemberExpression","value":"Blaze.registerHelper","paramnames":[]}},"summary":"Defines a [helper function](#template_helpers) which can be used from all templates.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"kind":"function","params":[{"type":{"names":["String"]},"description":"

The name of the helper function you are defining.

","name":"name"},{"type":{"names":["function"]},"description":"

The helper function itself.

","name":"function"}],"name":"registerHelper","longname":"Template.registerHelper","memberof":"Template","scope":"static","___id":"T000002R003292","___s":true,"options":[],"locus":"Client"},"meta":{"range":[156,181],"filename":"templating.js","lineno":9,"path":"/Users/sashko/git/meteor/packages/templating","code":{"id":"astnode100525127","name":"Template","type":"MemberExpression","value":"Blaze.Template","paramnames":[]}},"summary":"The class for defining templates","kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"Template.myTemplate","value":"Template.myTemplate"}],"name":"Template","longname":"Template","scope":"global","___id":"T000002R076941","___s":true,"options":[],"params":[],"instancename":"Template.myTemplate"},"MethodInvocation#isSimulation":{"comment":"/**\n * @summary Access inside a method invocation. Boolean value, true if this invocation is a stub.\n * @locus Anywhere\n * @name isSimulation\n * @memberOf MethodInvocation\n * @instance\n */","meta":{"range":[1023,1225],"filename":"livedata_common.js","lineno":26,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"Access inside a method invocation. Boolean value, true if this invocation is a stub.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"isSimulation","memberof":"MethodInvocation","scope":"instance","longname":"MethodInvocation#isSimulation","kind":"member","___id":"T000002R051223","___s":true,"locus":"Anywhere"},"MethodInvocation#userId":{"comment":"/**\n * @summary The id of the user that made this method call, or `null` if no user was logged in.\n * @locus Anywhere\n * @name userId\n * @memberOf MethodInvocation\n * @instance\n */","meta":{"range":[1535,1728],"filename":"livedata_common.js","lineno":43,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"The id of the user that made this method call, or `null` if no user was logged in.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"userId","memberof":"MethodInvocation","scope":"instance","longname":"MethodInvocation#userId","kind":"member","___id":"T000002R051227","___s":true,"locus":"Anywhere"},"MethodInvocation#connection":{"comment":"/**\n * @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.\n * @locus Server\n * @name connection\n * @memberOf MethodInvocation\n * @instance\n */","meta":{"range":[1980,2294],"filename":"livedata_common.js","lineno":58,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"name":"connection","memberof":"MethodInvocation","scope":"instance","longname":"MethodInvocation#connection","kind":"member","___id":"T000002R051230","___s":true,"locus":"Server"},"Subscription#connection":{"comment":"/**\n * @summary Access inside the publish function. The incoming [connection](#meteor_onconnection) for this subscription.\n * @locus Server\n * @name connection\n * @memberOf Subscription\n * @instance\n */","meta":{"range":[27477,27692],"filename":"livedata_server.js","lineno":863,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"Access inside the publish function. The incoming [connection](#meteor_onconnection) for this subscription.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"name":"connection","memberof":"Subscription","scope":"instance","longname":"Subscription#connection","kind":"member","___id":"T000002R052738","___s":true,"locus":"Server"},"Subscription#userId":{"comment":"/**\n * @summary Access inside the publish function. The id of the logged-in user, or `null` if no user is logged in.\n * @locus Server\n * @memberOf Subscription\n * @name userId\n * @instance\n */","meta":{"range":[28731,28936],"filename":"livedata_server.js","lineno":905,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"Access inside the publish function. The id of the logged-in user, or `null` if no user is logged in.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","name":"userId","scope":"instance","longname":"Subscription#userId","kind":"member","___id":"T000002R052750","___s":true,"locus":"Server"},"Tracker":{"active":{"comment":"/**\n * @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.\n * @locus Client\n */","meta":{"range":[418,440],"filename":"tracker.js","lineno":13,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100534662","name":"Tracker.active","type":"Literal","value":"false","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"active","longname":"Tracker.active","kind":"member","memberof":"Tracker","scope":"static","___id":"T000002R077667","___s":true,"locus":"Client"},"currentComputation":{"comment":"/**\n * @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.\n * @locus Client\n */","meta":{"range":[824,857],"filename":"tracker.js","lineno":21,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100534668","name":"Tracker.currentComputation","type":"Literal","value":"null","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"currentComputation","longname":"Tracker.currentComputation","kind":"member","memberof":"Tracker","scope":"static","___id":"T000002R077668","___s":true,"locus":"Client"},"Computation#stopped":{"comment":"/**\n * @summary True if this computation has been stopped.\n * @locus Client\n * @memberOf Tracker.Computation\n * @instance\n * @name stopped\n */","meta":{"range":[4547,4702],"filename":"tracker.js","lineno":132,"path":"/Users/sashko/git/meteor/packages/tracker","code":{}},"summary":"True if this computation has been stopped.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Tracker.Computation","scope":"instance","name":"stopped","longname":"Tracker.Computation#stopped","kind":"member","___id":"T000002R077694","___s":true,"locus":"Client"},"Computation#invalidated":{"comment":"/**\n * @summary True if this computation has been invalidated (and not yet rerun), or if it has been stopped.\n * @locus Client\n * @memberOf Tracker.Computation\n * @instance\n * @name invalidated\n */","meta":{"range":[4784,4994],"filename":"tracker.js","lineno":143,"path":"/Users/sashko/git/meteor/packages/tracker","code":{}},"summary":"True if this computation has been invalidated (and not yet rerun), or if it has been stopped.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Tracker.Computation","scope":"instance","name":"invalidated","longname":"Tracker.Computation#invalidated","kind":"member","___id":"T000002R077696","___s":true,"locus":"Client"},"Computation#firstRun":{"comment":"/**\n * @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.\n * @locus Client\n * @memberOf Tracker.Computation\n * @instance\n * @name firstRun\n */","meta":{"range":[5077,5329],"filename":"tracker.js","lineno":154,"path":"/Users/sashko/git/meteor/packages/tracker","code":{}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Tracker.Computation","scope":"instance","name":"firstRun","longname":"Tracker.Computation#firstRun","kind":"member","___id":"T000002R077698","___s":true,"locus":"Client"},"Computation":{"meta":{"range":[4266,5759],"filename":"tracker.js","lineno":122,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100534917","name":"Tracker.Computation","type":"FunctionExpression","value":"function","paramnames":["f","parent"]},"vars":{"constructingComputation":null,"self":null,"self.stopped":null,"self.invalidated":null,"self.firstRun":null,"self._id":null,"self._onInvalidateCallbacks":null,"self._parent":null,"self._func":null,"self._recomputing":null,"errored":null}},"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.","tags":[{"originalTitle":"instancename","title":"instancename","text":"computation","value":"computation"}],"name":"Computation","longname":"Tracker.Computation","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077691","___s":true,"options":[],"params":[],"instancename":"computation"},"Computation#onInvalidate":{"meta":{"range":[6268,6602],"filename":"tracker.js","lineno":189,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535019","name":"Tracker.Computation.prototype.onInvalidate","type":"FunctionExpression","value":"function","paramnames":["f"]},"vars":{"self":null,"":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

Function to be called on invalidation. Receives one argument, the computation that was invalidated.

","name":"callback"}],"name":"onInvalidate","longname":"Tracker.Computation#onInvalidate","kind":"function","memberof":"Tracker.Computation","scope":"instance","___id":"T000002R077708","___s":true,"options":[],"locus":"Client"},"Computation#invalidate":{"meta":{"range":[6748,7393],"filename":"tracker.js","lineno":210,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535071","name":"Tracker.Computation.prototype.invalidate","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"self":null,"self.invalidated":null,"i":null,"f":null,"":null,"self._onInvalidateCallbacks":null}},"summary":"Invalidates this computation so that it will be rerun.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"invalidate","longname":"Tracker.Computation#invalidate","kind":"function","memberof":"Tracker.Computation","scope":"instance","___id":"T000002R077710","___s":true,"options":[],"params":[],"locus":"Client"},"Computation#stop":{"meta":{"range":[7520,7648],"filename":"tracker.js","lineno":239,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535154","name":"Tracker.Computation.prototype.stop","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"this.stopped":null}},"summary":"Prevents this computation from rerunning.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"stop","longname":"Tracker.Computation#stop","kind":"function","memberof":"Tracker.Computation","scope":"instance","___id":"T000002R077717","___s":true,"options":[],"params":[],"locus":"Client"},"Dependency#depend":{"meta":{"range":[9967,10409],"filename":"tracker.js","lineno":317,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535306","name":"Tracker.Dependency.prototype.depend","type":"FunctionExpression","value":"function","paramnames":["computation"]},"vars":{"computation":null,"self":null,"id":null,"self._dependentsById[undefined]":null,"":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Tracker.Computation"]},"optional":true,"description":"

An optional computation declared to depend on dependency instead of the current computation.

","name":"fromComputation"}],"name":"depend","longname":"Tracker.Dependency#depend","kind":"function","memberof":"Tracker.Dependency","scope":"instance","___id":"T000002R077732","___s":true,"options":[],"locus":"Client"},"Dependency#changed":{"meta":{"range":[10577,10732],"filename":"tracker.js","lineno":342,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535379","name":"Tracker.Dependency.prototype.changed","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"self":null,"id":null}},"summary":"Invalidate all dependent computations immediately and remove them as dependents.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"changed","longname":"Tracker.Dependency#changed","kind":"function","memberof":"Tracker.Dependency","scope":"instance","___id":"T000002R077737","___s":true,"options":[],"params":[],"locus":"Client"},"Dependency#hasDependents":{"meta":{"range":[10951,11101],"filename":"tracker.js","lineno":354,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535410","name":"Tracker.Dependency.prototype.hasDependents","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"self":null,"id":null}},"summary":"True if this Dependency has one or more dependent Computations, which would be invalidated if this Dependency were to change.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"hasDependents","longname":"Tracker.Dependency#hasDependents","kind":"function","memberof":"Tracker.Dependency","scope":"instance","___id":"T000002R077740","___s":true,"options":[],"params":[],"locus":"Client"},"flush":{"meta":{"range":[11280,12945],"filename":"tracker.js","lineno":367,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535436","name":"Tracker.flush","type":"FunctionExpression","value":"function","paramnames":["_opts"]},"vars":{"inFlush":null,"willFlush":null,"throwFirstError":null,"finishedTry":null,"comp":null,"func":null}},"summary":"Process all reactive updates immediately and ensure that all invalidated computations are rerun.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"flush","longname":"Tracker.flush","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077743","___s":true,"options":[],"params":[],"locus":"Client"},"autorun":{"meta":{"range":[13572,13906],"filename":"tracker.js","lineno":438,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535558","name":"Tracker.autorun","type":"FunctionExpression","value":"function","paramnames":["f"]},"vars":{"constructingComputation":null,"c":null,"":null}},"summary":"Run a function now and rerun it later whenever its dependencies change. Returns a Computation object that can be used to stop or observe the rerunning.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

The function to run. It receives one argument: the Computation object that will be returned.

","name":"runFunc"}],"name":"autorun","longname":"Tracker.autorun","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077755","___s":true,"options":[],"locus":"Client"},"nonreactive":{"meta":{"range":[14340,14533],"filename":"tracker.js","lineno":465,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535608","name":"Tracker.nonreactive","type":"FunctionExpression","value":"function","paramnames":["f"]},"vars":{"previous":null}},"summary":"Run a function without tracking dependencies.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

A function to call immediately.

","name":"func"}],"name":"nonreactive","longname":"Tracker.nonreactive","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077758","___s":true,"options":[],"locus":"Client"},"onInvalidate":{"meta":{"range":[14970,15155],"filename":"tracker.js","lineno":482,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535636","name":"Tracker.onInvalidate","type":"FunctionExpression","value":"function","paramnames":["f"]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

A callback function that will be invoked as func(c), where c is the computation on which the callback is registered.

","name":"callback"}],"name":"onInvalidate","longname":"Tracker.onInvalidate","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077760","___s":true,"options":[],"locus":"Client"},"afterFlush":{"meta":{"range":[15566,15652],"filename":"tracker.js","lineno":496,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535661","name":"Tracker.afterFlush","type":"FunctionExpression","value":"function","paramnames":["f"]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

A function to call at flush time.

","name":"callback"}],"name":"afterFlush","longname":"Tracker.afterFlush","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077761","___s":true,"options":[],"locus":"Client"},"Dependency":{"meta":{"range":[9057,9122],"filename":"tracker.js","lineno":297,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535293","name":"Tracker.Dependency","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"this._dependentsById":null}},"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.","kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"dependency","value":"dependency"}],"name":"Dependency","longname":"Tracker.Dependency","memberof":"Tracker","scope":"static","___id":"T000002R077730","___s":true,"options":[],"params":[],"instancename":"dependency"}},"Template#helpers":{"meta":{"range":[7025,7118],"filename":"template.js","lineno":237,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044984","name":"Template.prototype.helpers","type":"FunctionExpression","value":"function","paramnames":["dict"]},"vars":{"k":null,"this[undefined]":null}},"summary":"Specify template helpers available to this template.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object"]},"description":"

Dictionary of helper functions by name.

","name":"helpers"}],"name":"helpers","longname":"Template#helpers","kind":"function","memberof":"Template","scope":"instance","___id":"T000002R003273","___s":true,"options":[],"locus":"Client"},"Template#events":{"meta":{"range":[7278,7901],"filename":"template.js","lineno":247,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045007","name":"Template.prototype.events","type":"FunctionExpression","value":"function","paramnames":["eventMap"]},"vars":{"template":null,"eventMap2":null,"k":null,"eventMap2[undefined]":null,"":null}},"summary":"Specify event handlers for this template.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["EventMap"]},"description":"

Event handlers to associate with this template.

","name":"eventMap"}],"name":"events","longname":"Template#events","kind":"function","memberof":"Template","scope":"instance","___id":"T000002R003276","___s":true,"options":[],"locus":"Client"},"MethodInvocation":{"meta":{"range":[500,2526],"filename":"livedata_common.js","lineno":15,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100273713","name":"MethodInvocation","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"self":null,"this.isSimulation":null,"this._unblock":null,"":null,"this._calledUnblock":null,"this.userId":null,"this._setUserId":null,"this.connection":null,"this.randomSeed":null,"this.randomStream":null}},"summary":"The state for a single invocation of a method, referenced by this\ninside a method definition.","params":[{"type":{"names":["Object"]},"name":"options"}],"tags":[{"originalTitle":"instanceName","title":"instancename","text":"this","value":"this"}],"name":"MethodInvocation","longname":"MethodInvocation","kind":"function","scope":"global","___id":"T000002R051221","___s":true,"options":[],"instancename":"this"},"MethodInvocation#unblock":{"meta":{"range":[2770,2870],"filename":"livedata_common.js","lineno":81,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100273797","name":"unblock","type":"FunctionExpression","value":"function"},"vars":{"self":null,"self._calledUnblock":null}},"summary":"Call inside a method invocation. Allow subsequent method from this client to begin running in a new fiber.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"MethodInvocation","scope":"instance","name":"unblock","longname":"MethodInvocation#unblock","kind":"function","___id":"T000002R051234","___s":true,"options":[],"params":[],"locus":"Server"},"MethodInvocation#setUserId":{"meta":{"range":[3092,3311],"filename":"livedata_common.js","lineno":94,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100273815","name":"setUserId","type":"FunctionExpression","value":"function"},"vars":{"self":null,"self.userId":null}},"summary":"Set the logged in user.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"MethodInvocation","scope":"instance","params":[{"type":{"names":["String","null"]},"description":"

The value that should be returned by userId on this connection.

","name":"userId"}],"name":"setUserId","longname":"MethodInvocation#setUserId","kind":"function","___id":"T000002R051237","___s":true,"options":[],"locus":"Server"},"DDP":{"connect":{"meta":{"range":[60099,60244],"filename":"livedata_connection.js","lineno":1587,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100278567","name":"DDP.connect","type":"FunctionExpression","value":"function","paramnames":["url","options"]},"vars":{"ret":null}},"summary":"Connect to the server of a different Meteor application to subscribe to its document sets and invoke its remote methods.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

The URL of another Meteor application.

","name":"url"}],"name":"connect","longname":"DDP.connect","kind":"function","memberof":"DDP","scope":"static","___id":"T000002R051592","___s":true,"options":[],"locus":"Anywhere"}},"Subscription#error":{"meta":{"range":[35098,35259],"filename":"livedata_server.js","lineno":1074,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290848","name":"error","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Call inside the publish function. Stops this client's subscription, triggering a call on the client to the `onError` callback passed to [`Meteor.subscribe`](#meteor_subscribe), if any. If `error` is not a [`Meteor.Error`](#meteor_error), it will be [sanitized](#meteor_error).","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Error"]},"description":"

The error to pass to the client.

","name":"error"}],"scope":"instance","memberof":"Subscription","name":"error","longname":"Subscription#error","kind":"function","___id":"T000002R052774","___s":true,"options":[],"locus":"Server"},"Subscription#stop":{"meta":{"range":[35755,35903],"filename":"livedata_server.js","lineno":1092,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290873","name":"stop","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Call inside the publish function. Stops this client's subscription; the `onError` callback is *not* invoked on the client.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"scope":"instance","memberof":"Subscription","name":"stop","longname":"Subscription#stop","kind":"function","___id":"T000002R052776","___s":true,"options":[],"params":[],"locus":"Server"},"Subscription#onStop":{"meta":{"range":[36152,36306],"filename":"livedata_server.js","lineno":1106,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290896","name":"onStop","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Call inside the publish function. Registers a callback function to run when the subscription is stopped.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["function"]},"description":"

The callback function

","name":"func"}],"name":"onStop","longname":"Subscription#onStop","kind":"function","___id":"T000002R052778","___s":true,"options":[],"locus":"Server"},"Subscription#added":{"meta":{"range":[37038,37338],"filename":"livedata_server.js","lineno":1131,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290939","name":"added","type":"FunctionExpression","value":"function"},"vars":{"self":null,"id":null,"[undefined]":null}},"summary":"Call inside the publish function. Informs the subscriber that a document has been added to the record set.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["String"]},"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":["Object"]},"description":"

The fields in the new document. If _id is present it is ignored.

","name":"fields"}],"name":"added","longname":"Subscription#added","kind":"function","___id":"T000002R052782","___s":true,"options":[],"locus":"Server"},"Subscription#changed":{"meta":{"range":[37986,38226],"filename":"livedata_server.js","lineno":1149,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290991","name":"changed","type":"FunctionExpression","value":"function"},"vars":{"self":null,"id":null}},"summary":"Call inside the publish function. Informs the subscriber that a document in the record set has been modified.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["String"]},"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":["Object"]},"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"}],"name":"changed","longname":"Subscription#changed","kind":"function","___id":"T000002R052786","___s":true,"options":[],"locus":"Server"},"Subscription#removed":{"meta":{"range":[38601,39009],"filename":"livedata_server.js","lineno":1165,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291030","name":"removed","type":"FunctionExpression","value":"function"},"vars":{"self":null,"id":null}},"summary":"Call inside the publish function. Informs the subscriber that a document has been removed from the record set.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["String"]},"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"}],"name":"removed","longname":"Subscription#removed","kind":"function","___id":"T000002R052789","___s":true,"options":[],"locus":"Server"},"Subscription#ready":{"meta":{"range":[39354,39646],"filename":"livedata_server.js","lineno":1182,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291076","name":"ready","type":"FunctionExpression","value":"function"},"vars":{"self":null,"self._ready":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","name":"ready","longname":"Subscription#ready","kind":"function","___id":"T000002R052792","___s":true,"options":[],"params":[],"locus":"Server"},"EJSON":{"newBinary":{"meta":{"range":[1470,1769],"filename":"base64.js","lineno":70,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100304377","name":"EJSON.newBinary","type":"FunctionExpression","value":"function","paramnames":["len"]},"vars":{"ret":null,"i":null,"ret.$Uint8ArrayPolyfill":null}},"summary":"Allocate a new buffer of binary data that EJSON can serialize.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Number"]},"description":"

The number of bytes of binary data to allocate.

","name":"size"}],"name":"newBinary","longname":"EJSON.newBinary","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053796","___s":true,"options":[],"locus":"Anywhere"},"addType":{"meta":{"range":[1156,1321],"filename":"ejson.js","lineno":24,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100305227","name":"EJSON.addType","type":"FunctionExpression","value":"function","paramnames":["name","factory"]},"vars":{"customTypes[undefined]":null}},"summary":"Add a custom datatype to EJSON.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

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":["function"]},"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"}],"name":"addType","longname":"EJSON.addType","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053877","___s":true,"options":[],"locus":"Anywhere"},"toJSONValue":{"meta":{"range":[5932,6178],"filename":"ejson.js","lineno":193,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100305844","name":"EJSON.toJSONValue","type":"FunctionExpression","value":"function","paramnames":["item"]},"vars":{"changed":null,"item":null}},"summary":"Serialize an EJSON-compatible value into its plain JSON representation.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"

A value to serialize to plain JSON.

","name":"val"}],"name":"toJSONValue","longname":"EJSON.toJSONValue","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053927","___s":true,"options":[],"locus":"Anywhere"},"fromJSONValue":{"meta":{"range":[7910,8166],"filename":"ejson.js","lineno":262,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306042","name":"EJSON.fromJSONValue","type":"FunctionExpression","value":"function","paramnames":["item"]},"vars":{"changed":null,"item":null}},"summary":"Deserialize an EJSON value from its plain JSON representation.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["JSONCompatible"]},"description":"

A value to deserialize into EJSON.

","name":"val"}],"name":"fromJSONValue","longname":"EJSON.fromJSONValue","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053938","___s":true,"options":[],"locus":"Anywhere"},"stringify":{"meta":{"range":[8794,9037],"filename":"ejson.js","lineno":283,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306083","name":"EJSON.stringify","type":"FunctionExpression","value":"function","paramnames":["item","options"]},"vars":{"json":null}},"summary":"Serialize a value to a string.\n\nFor EJSON values, the serialization fully represents the value. For non-EJSON values, serializes the same way as `JSON.stringify`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"

A value to stringify.

","name":"val"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"stringify","longname":"EJSON.stringify","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053941","___s":true,"options":[{"type":{"names":["Boolean","Integer","String"]},"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"]},"description":"

When true, stringifies keys in an object in sorted order.

","name":"canonical"}],"locus":"Anywhere"},"parse":{"meta":{"range":[9227,9404],"filename":"ejson.js","lineno":297,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306125","name":"EJSON.parse","type":"FunctionExpression","value":"function","paramnames":["item"]}},"summary":"Parse a string into an EJSON value. Throws an error if the string is not valid EJSON.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

A string to parse into an EJSON value.

","name":"str"}],"name":"parse","longname":"EJSON.parse","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053943","___s":true,"options":[],"locus":"Anywhere"},"isBinary":{"meta":{"range":[9595,9749],"filename":"ejson.js","lineno":308,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306152","name":"EJSON.isBinary","type":"FunctionExpression","value":"function","paramnames":["obj"]}},"summary":"Returns true if `x` is a buffer of binary data, as returned from [`EJSON.newBinary`](#ejson_new_binary).","params":[{"type":{"names":["Object"]},"description":"

The variable to check.

","name":"x"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"isBinary","longname":"EJSON.isBinary","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053944","___s":true,"options":[],"locus":"Anywhere"},"equals":{"meta":{"range":[10268,12522],"filename":"ejson.js","lineno":321,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306177","name":"EJSON.equals","type":"FunctionExpression","value":"function","paramnames":["a","b","options"]},"vars":{"i":null,"keyOrderSensitive":null,"ret":null,"bKeys":null,"":null}},"summary":"Return true if `a` and `b` are equal to each other. Return false otherwise. Uses the `equals` method on `a` if present, otherwise performs a deep comparison.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"name":"a"},{"type":{"names":["EJSON"]},"name":"b"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"equals","longname":"EJSON.equals","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053945","___s":true,"options":[{"type":{"names":["Boolean"]},"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"}],"locus":"Anywhere"},"clone":{"meta":{"range":[12632,13898],"filename":"ejson.js","lineno":407,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306564","name":"EJSON.clone","type":"FunctionExpression","value":"function","paramnames":["v"]},"vars":{"ret":null,"i":null,"ret[undefined]":null,"":null}},"summary":"Return a deep copy of `val`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"

A value to copy.

","name":"val"}],"name":"clone","longname":"EJSON.clone","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053956","___s":true,"options":[],"locus":"Anywhere"}},"Email":{"send":{"meta":{"range":[4584,5279],"filename":"email.js","lineno":141,"path":"/Users/sashko/git/meteor/packages/email","code":{"id":"astnode100308942","name":"Email.send","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"i":null,"mc":null,"":null,"pool":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"send","longname":"Email.send","kind":"function","memberof":"Email","scope":"static","___id":"T000002R054178","___s":true,"options":[{"type":{"names":["String"]},"description":"

"From:" address (required)

","name":"from"},{"type":{"names":["String","Array."]},"description":"

"To:", "Cc:", "Bcc:", and "Reply-To:" addresses

","name":"to, cc, bcc, replyTo"},{"type":{"names":["String"]},"optional":true,"description":"

"Subject:" line

","name":"subject"},{"type":{"names":["String"]},"optional":true,"description":"

Mail body (in plain text or HTML)

","name":"text, html"},{"type":{"names":["Object"]},"optional":true,"description":"

Dictionary of custom headers

","name":"headers"}],"locus":"Server"}},"HTTP":{"call":{"meta":{"range":[1471,6226],"filename":"httpcall_client.js","lineno":17,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345042","name":"HTTP.call","type":"FunctionExpression","value":"function","paramnames":["method","url","options","callback"]},"vars":{"callback":null,"options":null,"method":null,"headers":null,"content":null,"headers['Content-Type']":null,"params_for_url":null,"params_for_body":null,"url":null,"username":null,"password":null,"colonLoc":null,"":null,"xhr":null,"k":null,"timed_out":null,"timer":null,"xhr.onreadystatechange":null}},"summary":"Perform an outbound HTTP request.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

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":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. If passed, the method runs asynchronously, instead of synchronously, and calls asyncCallback. On the client, this callback is required.

","name":"asyncCallback"}],"name":"call","longname":"HTTP.call","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062535","___s":true,"options":[{"type":{"names":["String"]},"description":"

String to use as the HTTP request body.

","name":"content"},{"type":{"names":["Object"]},"description":"

JSON-able object to stringify and use as the HTTP request body. Overwrites content.

","name":"data"},{"type":{"names":["String"]},"description":"

Query string to go in the URL. Overwrites any query string in url.

","name":"query"},{"type":{"names":["Object"]},"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":["String"]},"description":"

HTTP basic authentication string of the form "username:password"

","name":"auth"},{"type":{"names":["Object"]},"description":"

Dictionary of strings, headers to add to the HTTP request.

","name":"headers"},{"type":{"names":["Number"]},"description":"

Maximum time in milliseconds to wait for the request before failing. There is no timeout by default.

","name":"timeout"},{"type":{"names":["Boolean"]},"description":"

If true, transparently follow HTTP redirects. Cannot be set to false on the client. Default true.

","name":"followRedirects"}],"locus":"Anywhere"},"get":{"meta":{"range":[1479,1588],"filename":"httpcall_common.js","lineno":44,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345685","name":"HTTP.get","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Send an HTTP `GET` request. Equivalent to calling [`HTTP.call`](#http_call) with \"GET\" as the first argument.","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"get","longname":"HTTP.get","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062589","___s":true,"options":[],"locus":"Anywhere"},"post":{"meta":{"range":[2007,2118],"filename":"httpcall_common.js","lineno":55,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345710","name":"HTTP.post","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Send an HTTP `POST` request. Equivalent to calling [`HTTP.call`](#http_call) with \"POST\" as the first argument.","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"post","longname":"HTTP.post","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062590","___s":true,"options":[],"locus":"Anywhere"},"put":{"meta":{"range":[2535,2644],"filename":"httpcall_common.js","lineno":66,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345735","name":"HTTP.put","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Send an HTTP `PUT` request. Equivalent to calling [`HTTP.call`](#http_call) with \"PUT\" as the first argument.","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"put","longname":"HTTP.put","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062591","___s":true,"options":[],"locus":"Anywhere"},"del":{"meta":{"range":[3135,3247],"filename":"httpcall_common.js","lineno":77,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345760","name":"HTTP.del","type":"FunctionExpression","value":"function","paramnames":[]}},"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`)","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"del","longname":"HTTP.del","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062592","___s":true,"options":[],"locus":"Anywhere"}},"ReactiveVar#get":{"meta":{"range":[2724,2837],"filename":"reactive-var.js","lineno":62,"path":"/Users/sashko/git/meteor/packages/reactive-var","code":{"id":"astnode100461309","name":"ReactiveVar.prototype.get","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Returns the current value of the ReactiveVar, establishing a reactive dependency.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"get","longname":"ReactiveVar#get","kind":"function","memberof":"ReactiveVar","scope":"instance","___id":"T000002R072876","___s":true,"options":[],"params":[],"locus":"Client"},"ReactiveVar#set":{"meta":{"range":[3040,3290],"filename":"reactive-var.js","lineno":74,"path":"/Users/sashko/git/meteor/packages/reactive-var","code":{"id":"astnode100461333","name":"ReactiveVar.prototype.set","type":"FunctionExpression","value":"function","paramnames":["newValue"]},"vars":{"oldValue":null,"this.curValue":null}},"summary":"Sets the current value of the ReactiveVar, invalidating the Computations that called `get` if `newValue` is different from the old value.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Any"]},"name":"newValue"}],"name":"set","longname":"ReactiveVar#set","kind":"function","memberof":"ReactiveVar","scope":"instance","___id":"T000002R072877","___s":true,"options":[],"locus":"Client"},"Session":{"set":{"meta":{"range":[126,546],"filename":"session.js","lineno":6,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"set","summary":"Set a variable in the session. Notify any listeners that the value has changed (eg: redraw templates, and rerun any [`Tracker.autorun`](#tracker_autorun) computations, that called [`Session.get`](#session_get) on this `key`.)","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The key to set, eg, selectedItem

","name":"key"},{"type":{"names":["EJSONable","undefined"]},"description":"

The new value for key

","name":"value"}],"scope":"static","longname":"Session.set","___id":"T000002R073023","___s":true,"options":[],"locus":"Client"},"setDefault":{"meta":{"range":[548,866],"filename":"session.js","lineno":15,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"setDefault","summary":"Set a variable in the session if it is undefined. Otherwise works exactly the same as [`Session.set`](#session_set).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The key to set, eg, selectedItem

","name":"key"},{"type":{"names":["EJSONable","undefined"]},"description":"

The new value for key

","name":"value"}],"scope":"static","longname":"Session.setDefault","___id":"T000002R073024","___s":true,"options":[],"locus":"Client"},"get":{"meta":{"range":[868,1359],"filename":"session.js","lineno":24,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"get","summary":"Get the value of a session variable. If inside a [reactive computation](#reactivity), invalidate the computation the next time the value of the variable is changed by [`Session.set`](#session_set). This returns a clone of the session value, so if it's an object or an array, mutating the returned value has no effect on the value stored in the session.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The name of the session variable to return

","name":"key"}],"scope":"static","longname":"Session.get","___id":"T000002R073025","___s":true,"options":[],"locus":"Client"},"equals":{"meta":{"range":[1361,1770],"filename":"session.js","lineno":32,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"equals","summary":"Test if a session variable is equal to a value. If inside a [reactive computation](#reactivity), invalidate the computation the next time the variable changes to or from the value.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The name of the session variable to test

","name":"key"},{"type":{"names":["String","Number","Boolean","null","undefined"]},"description":"

The value to test against

","name":"value"}],"scope":"static","longname":"Session.equals","___id":"T000002R073026","___s":true,"options":[],"locus":"Client"}},"Subscription":{"meta":{"range":[27224,27324],"filename":"livedata_server.js","lineno":853,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"The server's side of a subscription","kind":"class","name":"Subscription","tags":[{"originalTitle":"instanceName","title":"instancename","text":"this","value":"this"}],"longname":"Subscription","___id":"T000002R052734","___s":true,"options":[],"params":[],"instancename":"this"},"ReactiveVar":{"meta":{"range":[1971,2247],"filename":"reactive-var.js","lineno":37,"path":"/Users/sashko/git/meteor/packages/reactive-var","code":{"id":"astnode100461231","name":"ReactiveVar","type":"FunctionExpression","value":"function","paramnames":["initialValue","equalsFunc"]},"vars":{"this.curValue":null,"this.equalsFunc":null,"this.dep":null}},"kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"reactiveVar","value":"reactiveVar"},{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"summary":"Constructor for a ReactiveVar, which represents a single reactive variable.","params":[{"type":{"names":["Any"]},"description":"

The initial value to set. equalsFunc is ignored when setting the initial value.

","name":"initialValue"},{"type":{"names":["function"]},"optional":true,"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"}],"name":"ReactiveVar","longname":"ReactiveVar","scope":"global","___id":"T000002R072869","___s":true,"options":[],"instancename":"reactiveVar","locus":"Client"},"PackageAPI":{"meta":{"range":[35130,35271],"filename":"package-source.js","lineno":913,"path":"/Users/sashko/git/meteor/tools","code":{}},"kind":"class","name":"PackageAPI","tags":[{"originalTitle":"instanceName","title":"instancename","text":"api","value":"api"}],"summary":"The API object passed into the Packages.onUse function.","longname":"PackageAPI","___id":"T000002R082938","___s":true,"options":[],"params":[],"instancename":"api"}}; \ No newline at end of file +DocsData = {"Accounts":{"comment":"/**\n * @namespace Accounts\n * @summary The namespace for all accounts-related methods.\n */","meta":{"range":[0,90],"filename":"accounts_common.js","lineno":1,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{}},"kind":"namespace","name":"Accounts","summary":"The namespace for all accounts-related methods.","longname":"Accounts","___id":"T000002R000052","___s":true,"ui":{"comment":"/**\n * @summary Accounts UI\n * @namespace\n * @memberOf Accounts\n */","meta":{"range":[68,84],"filename":"accounts_ui.js","lineno":6,"path":"/Users/sashko/git/meteor/packages/accounts-ui-unstyled","code":{"id":"astnode100017176","name":"Accounts.ui","type":"ObjectExpression","value":"{}","paramnames":[]}},"summary":"Accounts UI","kind":"namespace","memberof":"Accounts","name":"ui","longname":"Accounts.ui","scope":"static","___id":"T000002R001237","___s":true,"config":{"meta":{"range":[1184,3840],"filename":"accounts_ui.js","lineno":25,"path":"/Users/sashko/git/meteor/packages/accounts-ui-unstyled","code":{"id":"astnode100017196","name":"Accounts.ui.config","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"VALID_KEYS":null,"":null,"Accounts.ui._options.passwordSignupFields":null}},"summary":"Configure the behavior of [`{{> loginButtons}}`](#accountsui).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"config","longname":"Accounts.ui.config","kind":"function","memberof":"Accounts.ui","scope":"static","___id":"T000002R001242","___s":true,"options":[{"type":{"names":["Object"]},"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.

","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":["String"]},"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).

","name":"passwordSignupFields"}],"locus":"Client"}},"emailTemplates":{"comment":"/**\n * @summary Options to customize emails sent from the Accounts system.\n * @locus Anywhere\n */","meta":{"range":[98,1733],"filename":"email_templates.js","lineno":5,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100008131","name":"Accounts.emailTemplates","type":"ObjectExpression","value":"{\"from\":\"Meteor Accounts \",\"siteName\":\"\",\"resetPassword\":\"\",\"verifyEmail\":\"\",\"enrollAccount\":\"\"}","paramnames":[]}},"summary":"Options to customize emails sent from the Accounts system.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"emailTemplates","longname":"Accounts.emailTemplates","kind":"member","memberof":"Accounts","scope":"static","___id":"T000002R000669","___s":true,"locus":"Anywhere"},"config":{"meta":{"range":[3341,5573],"filename":"accounts_common.js","lineno":55,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000690","name":"Accounts.config","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"__meteor_runtime_config__.accountsConfigCalled":null,"options":null,"VALID_KEYS":null,"":null}},"summary":"Set global accounts options.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"config","longname":"Accounts.config","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000059","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"

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.

","name":"forbidClientAccountCreation"},{"type":{"names":["String","function"]},"description":"

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' }).

","name":"restrictCreationByEmailDomain"},{"type":{"names":["Number"]},"description":"

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.

","name":"loginExpirationInDays"},{"type":{"names":["String"]},"description":"

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.

","name":"oauthSecretKey"}],"locus":"Anywhere"},"validateLoginAttempt":{"meta":{"range":[1621,1715],"filename":"accounts_server.js","lineno":51,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100001146","name":"Accounts.validateLoginAttempt","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Validate login attempts.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

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"}],"name":"validateLoginAttempt","longname":"Accounts.validateLoginAttempt","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000092","___s":true,"options":[],"locus":"Server"},"onLogin":{"meta":{"range":[1898,1973],"filename":"accounts_server.js","lineno":60,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100001160","name":"Accounts.onLogin","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Register a callback to be called after a login attempt succeeds.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

The callback to be called when login is successful.

","name":"func"}],"name":"onLogin","longname":"Accounts.onLogin","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000093","___s":true,"options":[],"locus":"Server"},"onLoginFailure":{"meta":{"range":[2155,2244],"filename":"accounts_server.js","lineno":69,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100001174","name":"Accounts.onLoginFailure","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Register a callback to be called after a login attempt fails.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

The callback to be called after the login has failed.

","name":"func"}],"name":"onLoginFailure","longname":"Accounts.onLoginFailure","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000094","___s":true,"options":[],"locus":"Server"},"onCreateUser":{"meta":{"range":[32747,32906],"filename":"accounts_server.js","lineno":986,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100003188","name":"Accounts.onCreateUser","type":"FunctionExpression","value":"function","paramnames":["func"]},"vars":{"onCreateUserHook":null}},"summary":"Customize new user creation.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

Called whenever a new user is created. Return the new user object, or throw an Error to abort the creation.

","name":"func"}],"name":"onCreateUser","longname":"Accounts.onCreateUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000300","___s":true,"options":[],"locus":"Server"},"validateNewUser":{"meta":{"range":[35595,35676],"filename":"accounts_server.js","lineno":1066,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100003411","name":"Accounts.validateNewUser","type":"FunctionExpression","value":"function","paramnames":["func"]}},"summary":"Set restrictions on new user creation.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"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"}],"name":"validateNewUser","longname":"Accounts.validateNewUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000316","___s":true,"options":[],"locus":"Server"},"createUser":{"meta":{"range":[3912,4457],"filename":"password_client.js","lineno":108,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010072","name":"Accounts.createUser","type":"FunctionExpression","value":"function","paramnames":["options","callback"]},"vars":{"options":null,"options.password":null}},"summary":"Create a new user.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Object"]},"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Client only, optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"createUser","longname":"Accounts.createUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000759","___s":true,"options":[{"type":{"names":["String"]},"description":"

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":["Object"]},"description":"

The user's profile, typically including the name field.

","name":"profile"}],"locus":"Anywhere"},"changePassword":{"meta":{"range":[5240,6773],"filename":"password_client.js","lineno":145,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010139","name":"Accounts.changePassword","type":"FunctionExpression","value":"function","paramnames":["oldPassword","newPassword","callback"]},"vars":{"":null}},"summary":"Change the current user's password. Must be logged in.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"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":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"changePassword","longname":"Accounts.changePassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000765","___s":true,"options":[],"locus":"Client"},"forgotPassword":{"meta":{"range":[7284,7476],"filename":"password_client.js","lineno":206,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010280","name":"Accounts.forgotPassword","type":"FunctionExpression","value":"function","paramnames":["options","callback"]}},"summary":"Request a forgot password email.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object"]},"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"forgotPassword","longname":"Accounts.forgotPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000770","___s":true,"options":[{"type":{"names":["String"]},"description":"

The email address to send a password reset link.

","name":"email"}],"locus":"Client"},"resetPassword":{"meta":{"range":[8168,8544],"filename":"password_client.js","lineno":226,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010308","name":"Accounts.resetPassword","type":"FunctionExpression","value":"function","paramnames":["token","newPassword","callback"]}},"summary":"Reset the password for a user using a token received in email. Logs the user in afterwards.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

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":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"resetPassword","longname":"Accounts.resetPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000771","___s":true,"options":[],"locus":"Client"},"verifyEmail":{"meta":{"range":[9058,9288],"filename":"password_client.js","lineno":253,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100010358","name":"Accounts.verifyEmail","type":"FunctionExpression","value":"function","paramnames":["token","callback"]}},"summary":"Marks the user's email address as verified. Logs the user in afterwards.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The token retrieved from the verification URL.

","name":"token"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"verifyEmail","longname":"Accounts.verifyEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000775","___s":true,"options":[],"locus":"Client"},"setPassword":{"meta":{"range":[10469,10842],"filename":"password_server.js","lineno":326,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011237","name":"Accounts.setPassword","type":"FunctionExpression","value":"function","paramnames":["userId","newPlaintextPassword"]},"vars":{"user":null}},"summary":"Forcibly change the password for a user.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to update.

","name":"userId"},{"type":{"names":["String"]},"description":"

A new password for the user.

","name":"newPassword"}],"name":"setPassword","longname":"Accounts.setPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000852","___s":true,"options":[],"locus":"Server"},"sendResetPasswordEmail":{"meta":{"range":[11744,13104],"filename":"password_server.js","lineno":364,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011341","name":"Accounts.sendResetPasswordEmail","type":"FunctionExpression","value":"function","paramnames":["userId","email"]},"vars":{"user":null,"email":null,"token":null,"when":null,"tokenRecord":null,".reset":null,"resetPasswordUrl":null,"options":null,"options.html":null}},"summary":"Send an email with a link the user can use to reset their password.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to send email to.

","name":"userId"},{"type":{"names":["String"]},"optional":true,"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.

","name":"email"}],"name":"sendResetPasswordEmail","longname":"Accounts.sendResetPasswordEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000863","___s":true,"options":[],"locus":"Server"},"sendEnrollmentEmail":{"meta":{"range":[13875,15304],"filename":"password_server.js","lineno":419,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011536","name":"Accounts.sendEnrollmentEmail","type":"FunctionExpression","value":"function","paramnames":["userId","email"]},"vars":{"user":null,"email":null,"token":null,"when":null,"tokenRecord":null,".reset":null,"enrollAccountUrl":null,"options":null,"options.html":null}},"summary":"Send an email with a link the user can use to set their initial password.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to send email to.

","name":"userId"},{"type":{"names":["String"]},"optional":true,"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.

","name":"email"}],"name":"sendEnrollmentEmail","longname":"Accounts.sendEnrollmentEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000882","___s":true,"options":[],"locus":"Server"},"sendVerificationEmail":{"meta":{"range":[18249,19994],"filename":"password_server.js","lineno":548,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100011948","name":"Accounts.sendVerificationEmail","type":"FunctionExpression","value":"function","paramnames":["userId","address"]},"vars":{"user":null,"email":null,"":null,"address":null,"tokenRecord":null,"user.services.email.verificationTokens":null,"verifyEmailUrl":null,"options":null,"options.html":null}},"summary":"Send an email with a link the user can use verify their email address.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"description":"

The id of the user to send email to.

","name":"userId"},{"type":{"names":["String"]},"optional":true,"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.

","name":"email"}],"name":"sendVerificationEmail","longname":"Accounts.sendVerificationEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000924","___s":true,"options":[],"locus":"Server"}},"Meteor":{"comment":"/**\n * @summary The Meteor namespace\n * @namespace Meteor\n */","meta":{"range":[0,61],"filename":"client_environment.js","lineno":1,"path":"/Users/sashko/git/meteor/packages/meteor","code":{}},"summary":"The Meteor namespace","kind":"namespace","name":"Meteor","longname":"Meteor","___id":"T000002R066137","___s":true,"users":{"comment":"/**\n * @summary A [Mongo.Collection](#collections) containing user documents.\n * @locus Anywhere\n */","meta":{"range":[6937,7087],"filename":"accounts_common.js","lineno":140,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000887","name":"Meteor.users","type":"NewExpression","paramnames":[]}},"summary":"A [Mongo.Collection](#collections) containing user documents.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"users","longname":"Meteor.users","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R000066","___s":true,"locus":"Anywhere"},"isClient":{"comment":"/**\n * @summary Boolean variable. True if running in client environment.\n * @locus Anywhere\n * @static\n */","meta":{"range":[194,208],"filename":"client_environment.js","lineno":12,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387447","name":"isClient","type":"Literal","value":"true"}},"summary":"Boolean variable. True if running in client environment.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"scope":"static","name":"isClient","longname":"Meteor.isClient","kind":"member","memberof":"Meteor","___id":"T000002R066139","___s":true,"locus":"Anywhere"},"isServer":{"comment":"/**\n * @summary Boolean variable. True if running in server environment.\n * @locus Anywhere\n * @static\n */","meta":{"range":[331,346],"filename":"client_environment.js","lineno":19,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387449","name":"isServer","type":"Literal","value":"false"}},"summary":"Boolean variable. True if running in server environment.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"scope":"static","name":"isServer","longname":"Meteor.isServer","kind":"member","memberof":"Meteor","___id":"T000002R066140","___s":true,"locus":"Anywhere"},"settings":{"comment":"/**\n * @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.\n * @locus Anywhere\n */","meta":{"range":[1181,1254],"filename":"client_environment.js","lineno":28,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387462","name":"Meteor.settings","type":"ObjectExpression","value":"{\"undefined\":\"\"}","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"settings","longname":"Meteor.settings","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R066141","___s":true,"locus":"Anywhere"},"isCordova":{"comment":"/**\n * @summary Boolean variable. True if running in a Cordova mobile environment.\n * @locus Anywhere\n */","meta":{"range":[107,130],"filename":"cordova_environment.js","lineno":5,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100387499","name":"Meteor.isCordova","type":"Literal","value":"true","paramnames":[]}},"summary":"Boolean variable. True if running in a Cordova mobile environment.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"isCordova","longname":"Meteor.isCordova","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R066143","___s":true,"locus":"Anywhere"},"release":{"comment":"/**\n * @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.\n * @locus Anywhere\n */","meta":{"range":[431,487],"filename":"helpers.js","lineno":10,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100389857","name":"Meteor.release","type":"MemberExpression","value":"__meteor_runtime_config__.meteorRelease","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"release","longname":"Meteor.release","kind":"member","memberof":"Meteor","scope":"static","___id":"T000002R066301","___s":true,"locus":"Anywhere"},"userId":{"meta":{"range":[193,263],"filename":"accounts_client.js","lineno":11,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000002","name":"Meteor.userId","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Get the current user id, or `null` if no user is logged in. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere but publish functions","value":"Anywhere but publish functions"}],"name":"userId","longname":"Meteor.userId","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000002","___s":true,"options":[],"params":[],"locus":"Anywhere but publish functions"},"loggingIn":{"meta":{"range":[829,909],"filename":"accounts_client.js","lineno":31,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000049","name":"Meteor.loggingIn","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"True if a login method (such as `Meteor.loginWithPassword`, `Meteor.loginWithFacebook`, or `Accounts.createUser`) is currently in progress. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"loggingIn","longname":"Meteor.loggingIn","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000007","___s":true,"options":[],"params":[],"locus":"Client"},"user":{"meta":{"range":[1103,1235],"filename":"accounts_client.js","lineno":42,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000063","name":"Meteor.user","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"userId":null}},"summary":"Get the current user record, or `null` if no user is logged in. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere but publish functions","value":"Anywhere but publish functions"}],"name":"user","longname":"Meteor.user","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000008","___s":true,"options":[],"params":[],"locus":"Anywhere but publish functions"},"logout":{"meta":{"range":[8760,9017],"filename":"accounts_client.js","lineno":226,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000423","name":"Meteor.logout","type":"FunctionExpression","value":"function","paramnames":["callback"]},"vars":{"":null}},"summary":"Log the user out.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"logout","longname":"Meteor.logout","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000039","___s":true,"options":[],"locus":"Client"},"logoutOtherClients":{"meta":{"range":[9302,10695],"filename":"accounts_client.js","lineno":242,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000465","name":"Meteor.logoutOtherClients","type":"FunctionExpression","value":"function","paramnames":["callback"]},"vars":{"":null}},"summary":"Log out other clients logged in as the current user, but does not log out the client that calls this function.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"logoutOtherClients","longname":"Meteor.logoutOtherClients","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000041","___s":true,"options":[],"locus":"Client"},"loginWithPassword":{"meta":{"range":[725,2207],"filename":"password_client.js","lineno":18,"path":"/Users/sashko/git/meteor/packages/accounts-password","code":{"id":"astnode100009879","name":"Meteor.loginWithPassword","type":"FunctionExpression","value":"function","paramnames":["selector","password","callback"]},"vars":{"selector":null,"":null}},"summary":"Log the user in with a password.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object","String"]},"description":"

Either a string interpreted as a username or an email; or an object with a single key: email, username or id.

","name":"user"},{"type":{"names":["String"]},"description":"

The user's password.

","name":"password"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. Called with no arguments on success, or with a single Error argument on failure.

","name":"callback"}],"name":"loginWithPassword","longname":"Meteor.loginWithPassword","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000736","___s":true,"options":[],"locus":"Client"},"subscribe":{"meta":{"range":[19053,23334],"filename":"livedata_connection.js","lineno":471,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100275342","name":"subscribe","type":"FunctionExpression","value":"function"},"vars":{"self":null,"params":null,"callbacks":null,"lastParam":null,"callbacks.onReady":null,"existing":null,"":null,"id":null,"existing.inactive":null,"existing.readyCallback":null,"existing.errorCallback":null,"self._subscriptions[undefined]":null,"handle":null}},"memberof":"Meteor","summary":"Subscribe to a record set. Returns a handle that provides `stop()` and `ready()` methods.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

Name of the subscription. Matches the name of the server's publish() call.

","name":"name"},{"type":{"names":["Any"]},"optional":true,"description":"

Optional arguments passed to publisher function on server.

","name":"arg1, arg2..."},{"type":{"names":["function","Object"]},"optional":true,"description":"

Optional. May include onError and onReady callbacks. If a function is passed instead of an object, it is interpreted as an onReady callback.

","name":"callbacks"}],"name":"subscribe","longname":"Meteor.subscribe","kind":"function","scope":"static","___id":"T000002R051354","___s":true,"options":[],"locus":"Client"},"call":{"meta":{"range":[24767,25144],"filename":"livedata_connection.js","lineno":637,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100275864","name":"call","type":"FunctionExpression","value":"function"},"vars":{"args":null,"callback":null}},"memberof":"Meteor","summary":"Invokes a method passing any number of arguments.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

Name of method to invoke

","name":"name"},{"type":{"names":["EJSONable"]},"optional":true,"description":"

Optional method arguments

","name":"arg1, arg2..."},{"type":{"names":["function"]},"optional":true,"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"}],"name":"call","longname":"Meteor.call","kind":"function","scope":"static","___id":"T000002R051404","___s":true,"options":[],"locus":"Anywhere"},"apply":{"meta":{"range":[27414,34762],"filename":"livedata_connection.js","lineno":678,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100275911","name":"apply","type":"FunctionExpression","value":"function"},"vars":{"self":null,"callback":null,"options":null,"args":null,"methodId":null,"":null,"enclosing":null,"alreadyInSimulation":null,"randomSeed":null,"randomSeedGenerator":null,"stub":null,"setUserId":null,"invocation":null,"stubReturnValue":null,"exception":null,"future":null,"message":null,"message.randomSeed":null,"methodInvoker":null}},"memberof":"Meteor","summary":"Invoke a method passing an array of arguments.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

Name of method to invoke

","name":"name"},{"type":{"names":["Array."]},"description":"

Method arguments

","name":"args"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback; same semantics as in Meteor.call.

","name":"asyncCallback"}],"name":"apply","longname":"Meteor.apply","kind":"function","scope":"static","___id":"T000002R051407","___s":true,"options":[{"type":{"names":["Boolean"]},"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":["function"]},"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"}],"locus":"Anywhere"},"status":{"meta":{"range":[37838,37967],"filename":"livedata_connection.js","lineno":963,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100276624","name":"status","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Get the current connection status. A reactive data source.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Meteor","name":"status","longname":"Meteor.status","kind":"function","scope":"static","___id":"T000002R051473","___s":true,"options":[],"params":[],"locus":"Client"},"reconnect":{"meta":{"range":[38189,38324],"filename":"livedata_connection.js","lineno":975,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100276644","name":"reconnect","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Meteor","name":"reconnect","longname":"Meteor.reconnect","kind":"function","scope":"static","___id":"T000002R051475","___s":true,"options":[],"params":[],"locus":"Client"},"disconnect":{"meta":{"range":[38435,38572],"filename":"livedata_connection.js","lineno":985,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100276664","name":"disconnect","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Disconnect the client from the server.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Meteor","name":"disconnect","longname":"Meteor.disconnect","kind":"function","scope":"static","___id":"T000002R051477","___s":true,"options":[],"params":[],"locus":"Client"},"onConnection":{"meta":{"range":[42780,42881],"filename":"livedata_server.js","lineno":1298,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291393","name":"onConnection","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Register a callback to be called when a new DDP connection is made to the server.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["function"]},"description":"

The function to call when a new DDP connection is established.

","name":"callback"}],"memberof":"Meteor","name":"onConnection","longname":"Meteor.onConnection","kind":"function","scope":"static","___id":"T000002R052814","___s":true,"options":[],"locus":"Server"},"publish":{"meta":{"range":[45712,47678],"filename":"livedata_server.js","lineno":1370,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291562","name":"publish","type":"FunctionExpression","value":"function"},"vars":{"self":null,"options":null,"self.warned_about_autopublish":null,"self.publish_handlers[undefined]":null,"":null}},"summary":"Publish a record set.","memberof":"Meteor","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["String"]},"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":["function"]},"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"}],"name":"publish","longname":"Meteor.publish","kind":"function","scope":"static","___id":"T000002R052825","___s":true,"options":[],"locus":"Server"},"methods":{"meta":{"range":[48062,48324],"filename":"livedata_server.js","lineno":1435,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291722","name":"methods","type":"FunctionExpression","value":"function"},"vars":{"self":null,"":null}},"summary":"Defines functions that can be invoked over the network by clients.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Object"]},"description":"

Dictionary whose keys are method names and values are functions.

","name":"methods"}],"memberof":"Meteor","name":"methods","longname":"Meteor.methods","kind":"function","scope":"static","___id":"T000002R052832","___s":true,"options":[],"locus":"Anywhere"},"startup":{"meta":{"range":[740,1107],"filename":"startup_client.js","lineno":28,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100391831","name":"Meteor.startup","type":"FunctionExpression","value":"function","paramnames":["cb"]},"vars":{"doScroll":null,"":null}},"summary":"Run code when a client or a server starts.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["function"]},"description":"

A function to run on startup.

","name":"func"}],"name":"startup","longname":"Meteor.startup","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R066499","___s":true,"options":[],"locus":"Anywhere"},"setTimeout":{"meta":{"range":[959,1072],"filename":"timers.js","lineno":28,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100391994","name":"setTimeout","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Call a function in the future after waiting for a specified delay.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["function"]},"description":"

The function to run

","name":"func"},{"type":{"names":["Number"]},"description":"

Number of milliseconds to wait before calling function

","name":"delay"}],"name":"setTimeout","longname":"Meteor.setTimeout","kind":"function","scope":"static","___id":"T000002R066505","___s":true,"options":[],"locus":"Anywhere"},"setInterval":{"meta":{"range":[1341,1457],"filename":"timers.js","lineno":39,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392007","name":"setInterval","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Call a function repeatedly, with a time delay between calls.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["function"]},"description":"

The function to run

","name":"func"},{"type":{"names":["Number"]},"description":"

Number of milliseconds to wait between each function call.

","name":"delay"}],"name":"setInterval","longname":"Meteor.setInterval","kind":"function","scope":"static","___id":"T000002R066506","___s":true,"options":[],"locus":"Anywhere"},"clearInterval":{"meta":{"range":[1667,1728],"filename":"timers.js","lineno":49,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392020","name":"clearInterval","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Cancel a repeating function call scheduled by `Meteor.setInterval`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Number"]},"description":"

The handle returned by Meteor.setInterval

","name":"id"}],"name":"clearInterval","longname":"Meteor.clearInterval","kind":"function","scope":"static","___id":"T000002R066507","___s":true,"options":[],"locus":"Anywhere"},"clearTimeout":{"meta":{"range":[1926,1985],"filename":"timers.js","lineno":59,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392028","name":"clearTimeout","type":"FunctionExpression","value":"function"}},"memberof":"Meteor","summary":"Cancel a function call scheduled by `Meteor.setTimeout`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Number"]},"description":"

The handle returned by Meteor.setTimeout

","name":"id"}],"name":"clearTimeout","longname":"Meteor.clearTimeout","kind":"function","scope":"static","___id":"T000002R066508","___s":true,"options":[],"locus":"Anywhere"},"absoluteUrl":{"meta":{"range":[769,1903],"filename":"url_common.js","lineno":10,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100392140","name":"Meteor.absoluteUrl","type":"FunctionExpression","value":"function","paramnames":["path","options"]},"vars":{"options":null,"path":null,"url":null}},"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 bundle`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"optional":true,"description":"

A path to append to the root URL. Do not include a leading "/".

","name":"path"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"absoluteUrl","longname":"Meteor.absoluteUrl","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R066515","___s":true,"options":[{"type":{"names":["Boolean"]},"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":["String"]},"description":"

Override the default ROOT_URL from the server environment. For example: "http://foo.example.com"

","name":"rootUrl"}],"locus":"Anywhere"},"Error":{"meta":{"range":[1911,3068],"filename":"errors.js","lineno":53,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100388767","name":"Meteor.Error","type":"CallExpression","paramnames":[]}},"summary":"This class represents a symbolic error thrown by a method.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"class","params":[{"type":{"names":["Number"]},"description":"

A numeric error code, likely similar to an HTTP code (eg, 404, 500).

","name":"error"},{"type":{"names":["String"]},"optional":true,"description":"

Optional. A short human-readable summary of the error, like 'Not Found'.

","name":"reason"},{"type":{"names":["String"]},"optional":true,"description":"

Optional. Additional information about the error, like a textual stack trace.

","name":"details"}],"name":"Error","longname":"Meteor.Error","memberof":"Meteor","scope":"static","___id":"T000002R066215","___s":true,"options":[],"locus":"Anywhere"}},"Mongo":{"comment":"/**\n * @summary Namespace for MongoDB-related items\n * @namespace\n */","meta":{"range":[208,218],"filename":"collection.js","lineno":8,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100415826","name":"Mongo","type":"ObjectExpression","value":"{}","paramnames":[]}},"summary":"Namespace for MongoDB-related items","kind":"namespace","name":"Mongo","longname":"Mongo","scope":"global","___id":"T000002R068699","___s":true,"Cursor#forEach":{"meta":{"range":[4879,5293],"filename":"minimongo.js","lineno":147,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Call `callback` once for each matching document, sequentially and synchronously.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"forEach","scope":"instance","memberof":"Mongo.Cursor","params":[{"type":{"names":["function"]},"description":"

Function to call. It will be called with three arguments: the document, a 0-based index, and cursor itself.

","name":"callback"},{"type":{"names":["Any"]},"optional":true,"description":"

An object which will be the value of this inside callback.

","name":"thisArg"}],"longname":"Mongo.Cursor#forEach","___id":"T000002R066837","___s":true,"options":[],"locus":"Anywhere"},"Cursor#map":{"meta":{"range":[6047,6436],"filename":"minimongo.js","lineno":188,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Map callback over all matching documents. Returns an Array.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"map","scope":"instance","memberof":"Mongo.Cursor","params":[{"type":{"names":["function"]},"description":"

Function to call. It will be called with three arguments: the document, a 0-based index, and cursor itself.

","name":"callback"},{"type":{"names":["Any"]},"optional":true,"description":"

An object which will be the value of this inside callback.

","name":"thisArg"}],"longname":"Mongo.Cursor#map","___id":"T000002R066850","___s":true,"options":[],"locus":"Anywhere"},"Cursor#fetch":{"meta":{"range":[6661,6799],"filename":"minimongo.js","lineno":206,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Return all matching documents as an Array.","memberof":"Mongo.Cursor","kind":"function","name":"fetch","scope":"instance","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"longname":"Mongo.Cursor#fetch","___id":"T000002R066854","___s":true,"options":[],"params":[],"locus":"Anywhere"},"Cursor#count":{"meta":{"range":[6965,7112],"filename":"minimongo.js","lineno":222,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Returns the number of documents that match a query.","memberof":"Mongo.Cursor","kind":"function","name":"count","scope":"instance","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"longname":"Mongo.Cursor#count","___id":"T000002R066858","___s":true,"options":[],"params":[],"locus":"Anywhere"},"Cursor#observe":{"meta":{"range":[9823,9947],"filename":"minimongo.js","lineno":304,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{"id":"astnode100397156","name":"observe","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Watch a query. Receive callbacks as the result set changes.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"memberof":"Mongo.Cursor","scope":"instance","params":[{"type":{"names":["Object"]},"description":"

Functions to call to deliver the result set as it changes

","name":"callbacks"}],"name":"observe","longname":"Mongo.Cursor#observe","kind":"function","___id":"T000002R066872","___s":true,"options":[],"locus":"Anywhere"},"Cursor#observeChanges":{"meta":{"range":[10277,14230],"filename":"minimongo.js","lineno":316,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{"id":"astnode100397171","name":"observeChanges","type":"FunctionExpression","value":"function"},"vars":{"self":null,"ordered":null,"query":null,"qid":null,"self.collection.queries[undefined]":null,"query.results":null,"query.resultsSnapshot":null,"wrapCallback":null,"":null,"query.added":null,"query.changed":null,"query.removed":null,"query.addedBefore":null,"query.movedBefore":null,"each":null,"handle":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"memberof":"Mongo.Cursor","scope":"instance","params":[{"type":{"names":["Object"]},"description":"

Functions to call to deliver the result set as it changes

","name":"callbacks"}],"name":"observeChanges","longname":"Mongo.Cursor#observeChanges","kind":"function","___id":"T000002R066874","___s":true,"options":[],"locus":"Anywhere"},"Collection#insert":{"meta":{"range":[15970,16408],"filename":"collection.js","lineno":413,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Insert a document in the collection. Returns its unique _id.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"insert","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["Object"]},"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":["function"]},"optional":true,"description":"

Optional. If present, called with an error object as the first argument and, if no error, the _id as the second.

","name":"callback"}],"longname":"Mongo.Collection#insert","___id":"T000002R068697","___s":true,"options":[],"locus":"Anywhere"},"Collection#update":{"meta":{"range":[16410,17179],"filename":"collection.js","lineno":423,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Modify one or more documents in the collection. Returns the number of affected documents.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"update","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"description":"

Specifies which documents to modify

","name":"selector"},{"type":{"names":["MongoModifier"]},"description":"

Specifies how to modify the documents

","name":"modifier"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"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"}],"longname":"Mongo.Collection#update","___id":"T000002R068698","___s":true,"options":[{"type":{"names":["Boolean"]},"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"}],"locus":"Anywhere"},"Collection#find":{"meta":{"range":[9244,10107],"filename":"collection.js","lineno":251,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Find the documents in a collection that match the selector.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"find","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"optional":true,"description":"

A query describing the documents to find

","name":"selector"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"longname":"Mongo.Collection#find","___id":"T000002R068750","___s":true,"options":[{"type":{"names":["MongoSortSpecifier"]},"description":"

Sort order (default: natural order)

","name":"sort"},{"type":{"names":["Number"]},"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":["MongoFieldSpecifier"]},"description":"

Dictionary of fields to return or exclude.

","name":"fields"},{"type":{"names":["Boolean"]},"description":"

(Client only) Default true; pass false to disable reactivity

","name":"reactive"},{"type":{"names":["function"]},"description":"

Overrides transform on the Collection for this cursor. Pass null to disable transformation.

","name":"transform"}],"locus":"Anywhere"},"Collection#findOne":{"meta":{"range":[10527,11346],"filename":"collection.js","lineno":276,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Finds the first document that matches the selector, as ordered by sort and skip options.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"findOne","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"optional":true,"description":"

A query describing the documents to find

","name":"selector"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"longname":"Mongo.Collection#findOne","___id":"T000002R068754","___s":true,"options":[{"type":{"names":["MongoSortSpecifier"]},"description":"

Sort order (default: natural order)

","name":"sort"},{"type":{"names":["Number"]},"description":"

Number of results to skip at the beginning

","name":"skip"},{"type":{"names":["MongoFieldSpecifier"]},"description":"

Dictionary of fields to return or exclude.

","name":"fields"},{"type":{"names":["Boolean"]},"description":"

(Client only) Default true; pass false to disable reactivity

","name":"reactive"},{"type":{"names":["function"]},"description":"

Overrides transform on the Collection for this cursor. Pass null to disable transformation.

","name":"transform"}],"locus":"Anywhere"},"Collection#remove":{"meta":{"range":[17181,17488],"filename":"collection.js","lineno":437,"path":"/Users/sashko/git/meteor/packages/mongo","code":{}},"summary":"Remove documents from the collection","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"remove","memberof":"Mongo.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"description":"

Specifies which documents to remove

","name":"selector"},{"type":{"names":["function"]},"optional":true,"description":"

Optional. If present, called with an error object as its argument.

","name":"callback"}],"longname":"Mongo.Collection#remove","___id":"T000002R068781","___s":true,"options":[],"locus":"Anywhere"},"Collection#upsert":{"meta":{"range":[23728,24123],"filename":"collection.js","lineno":599,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417428","name":"Mongo.Collection.prototype.upsert","type":"FunctionExpression","value":"function","paramnames":["selector","modifier","options","callback"]},"vars":{"self":null,"callback":null,"options":null}},"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).","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["MongoSelector"]},"description":"

Specifies which documents to modify

","name":"selector"},{"type":{"names":["MongoModifier"]},"description":"

Specifies how to modify the documents

","name":"modifier"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"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"}],"name":"upsert","longname":"Mongo.Collection#upsert","kind":"function","memberof":"Mongo.Collection","scope":"instance","___id":"T000002R068811","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"

True to modify all matching documents; false to only modify one of the matching documents (the default).

","name":"multi"}],"locus":"Anywhere"},"Collection#allow":{"meta":{"range":[29479,29584],"filename":"collection.js","lineno":748,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417838","name":"Mongo.Collection.prototype.allow","type":"FunctionExpression","value":"function","paramnames":["options"]}},"summary":"Allow users to write directly to this collection from client code, subject to limitations you define.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"allow","longname":"Mongo.Collection#allow","kind":"function","memberof":"Mongo.Collection","scope":"instance","___id":"T000002R068835","___s":true,"options":[{"type":{"names":["function"]},"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":["Array."]},"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":["function"]},"description":"

Overrides transform on the Collection. Pass null to disable transformation.

","name":"transform"}],"locus":"Server"},"Collection#deny":{"meta":{"range":[30215,30318],"filename":"collection.js","lineno":760,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417858","name":"Mongo.Collection.prototype.deny","type":"FunctionExpression","value":"function","paramnames":["options"]}},"summary":"Override `allow` rules.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"deny","longname":"Mongo.Collection#deny","kind":"function","memberof":"Mongo.Collection","scope":"instance","___id":"T000002R068836","___s":true,"options":[{"type":{"names":["function"]},"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":["Array."]},"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":["function"]},"description":"

Overrides transform on the Collection. Pass null to disable transformation.

","name":"transform"}],"locus":"Server"},"Collection":{"meta":{"range":[1485,8485],"filename":"collection.js","lineno":26,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100415830","name":"Mongo.Collection","type":"FunctionExpression","value":"function","paramnames":["name","options"]},"vars":{"self":null,"name":null,"options":null,"options.connection":null,"self._makeNewID":null,"":null,"self._transform":null,"self._connection":null,"options._driver":null,"self._collection":null,"self._name":null,"ok":null}},"summary":"Constructor for a Collection","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"},{"originalTitle":"instancename","title":"instancename","text":"collection","value":"collection"}],"kind":"class","params":[{"type":{"names":["String"]},"description":"

The name of the collection. If null, creates an unmanaged (unsynchronized) local collection.

","name":"name"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"Collection","longname":"Mongo.Collection","memberof":"Mongo","scope":"static","___id":"T000002R068700","___s":true,"options":[{"type":{"names":["Object"]},"description":"

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.

","name":"connection"},{"type":{"names":["String"]},"description":"

The method of generating the _id fields of new documents in this collection. Possible values:

\n\n

The default id generation technique is 'STRING'.

","name":"idGeneration"},{"type":{"names":["function"]},"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"}],"locus":"Anywhere","instancename":"collection"},"ObjectID":{"meta":{"range":[25545,25587],"filename":"collection.js","lineno":644,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417623","name":"Mongo.ObjectID","type":"MemberExpression","value":"LocalCollection._ObjectID","paramnames":[]}},"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).","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"class","params":[{"type":{"names":["String"]},"description":"

Optional. The 24-character hexadecimal contents of the ObjectID to create

","name":"hexString"}],"name":"ObjectID","longname":"Mongo.ObjectID","memberof":"Mongo","scope":"static","___id":"T000002R068825","___s":true,"options":[],"locus":"Anywhere"},"Cursor":{"meta":{"range":[25739,25776],"filename":"collection.js","lineno":651,"path":"/Users/sashko/git/meteor/packages/mongo","code":{"id":"astnode100417631","name":"Mongo.Cursor","type":"MemberExpression","value":"LocalCollection.Cursor","paramnames":[]}},"summary":"To create a cursor, use find. To access the documents in a cursor, use forEach, map, or fetch.","kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"cursor","value":"cursor"}],"name":"Cursor","longname":"Mongo.Cursor","memberof":"Mongo","scope":"static","___id":"T000002R068826","___s":true,"options":[],"params":[],"instancename":"cursor"}},"Assets":{"comment":"/**\n * @summary The namespace for Assets functions, lives in the bundler.\n * @namespace\n * @name Assets\n */","meta":{"range":[39793,39932],"filename":"bundler.js","lineno":1099,"path":"/Users/sashko/git/meteor/tools","code":{}},"summary":"The namespace for Assets functions, lives in the bundler.","kind":"namespace","name":"Assets","longname":"Assets","___id":"T000002R079094","___s":true,"getText":{"meta":{"range":[40464,40588],"filename":"bundler.js","lineno":1113,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100552304","name":"getText","type":"FunctionExpression","value":"function"}},"summary":"Retrieve the contents of the static server asset as a UTF8-encoded string.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Assets","params":[{"type":{"names":["String"]},"description":"

The path of the asset, relative to the application's private subdirectory.

","name":"assetPath"},{"type":{"names":["function"]},"optional":true,"description":"

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"}],"name":"getText","longname":"Assets.getText","kind":"function","scope":"static","___id":"T000002R079096","___s":true,"options":[],"locus":"Server"},"getBinary":{"meta":{"range":[41116,41245],"filename":"bundler.js","lineno":1124,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100552318","name":"getBinary","type":"FunctionExpression","value":"function"}},"summary":"Retrieve the contents of the static server asset as an [EJSON Binary](#ejson_new_binary).","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Assets","params":[{"type":{"names":["String"]},"description":"

The path of the asset, relative to the application's private subdirectory.

","name":"assetPath"},{"type":{"names":["function"]},"description":"

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"}],"name":"getBinary","longname":"Assets.getBinary","kind":"function","scope":"static","___id":"T000002R079097","___s":true,"options":[],"locus":"Server"}},"Package":{"comment":"/**\n * @global\n * @name Package\n * @summary The Package object in package.js\n * @namespace\n * @locus package.js\n */","meta":{"range":[18303,18443],"filename":"package-source.js","lineno":473,"path":"/Users/sashko/git/meteor/tools","code":{}},"scope":"global","name":"Package","summary":"The Package object in package.js","kind":"namespace","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"longname":"Package","___id":"T000002R082866","___s":true,"locus":"package.js","describe":{"meta":{"range":[19530,20633],"filename":"package-source.js","lineno":499,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100600028","name":"describe","type":"FunctionExpression","value":"function"},"vars":{"":null}},"summary":"Provide basic package information.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"memberof":"Package","params":[{"type":{"names":["Object"]},"name":"options"}],"name":"describe","longname":"Package.describe","kind":"function","scope":"static","___id":"T000002R082868","___s":true,"options":[{"type":{"names":["String"]},"description":"

A concise 1-2 sentence description of the package, required for publication.

","name":"summary"},{"type":{"names":["String"]},"description":"

The semver version for your package. If no version is specified, defaults to 0.0.0. You need to specify a version to publish to the package server.

","name":"version"},{"type":{"names":["String"]},"description":"

Optional name override. By default, the package name comes from the name of its directory.

","name":"name"},{"type":{"names":["String"]},"description":"

Optional Git URL to the source repository.

","name":"git"}],"locus":"package.js"},"onUse":{"meta":{"range":[20928,21289],"filename":"package-source.js","lineno":533,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100600119","name":"onUse","type":"FunctionExpression","value":"function"},"vars":{"fileAndDepLoader":null}},"summary":"Define package dependencies and expose package methods.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"memberof":"Package","params":[{"type":{"names":["function"]},"description":"

A function that takes in the package control 'api' object, which keeps track of dependencies and exports.

","name":"func"}],"name":"onUse","longname":"Package.onUse","kind":"function","scope":"static","___id":"T000002R082873","___s":true,"options":[],"locus":"package.js"},"onTest":{"meta":{"range":[21703,22476],"filename":"package-source.js","lineno":558,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100600158","name":"onTest","type":"FunctionExpression","value":"function"},"vars":{"hasTests":null,"fileAndDepLoader":null}},"summary":"Define dependencies and expose package methods for unit tests.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"memberof":"Package","params":[{"type":{"names":["function"]},"description":"

A function that takes in the package control 'api' object, which keeps track of dependencies and exports.

","name":"func"}],"name":"onTest","longname":"Package.onTest","kind":"function","scope":"static","___id":"T000002R082877","___s":true,"options":[],"locus":"package.js"}},"Template#created":{"comment":"/**\n * @name created\n * @instance\n * @memberOf Template\n * @summary Provide a callback when an instance of a template is created.\n * @locus Client\n */","meta":{"range":[3549,3712],"filename":"template.js","lineno":105,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"created","scope":"instance","memberof":"Template","summary":"Provide a callback when an instance of a template is created.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Template#created","kind":"member","___id":"T000002R003232","___s":true,"locus":"Client"},"Template#rendered":{"comment":"/**\n * @name rendered\n * @instance\n * @memberOf Template\n * @summary Provide a callback when an instance of a template is rendered.\n * @locus Client\n */","meta":{"range":[3837,4002],"filename":"template.js","lineno":118,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"rendered","scope":"instance","memberof":"Template","summary":"Provide a callback when an instance of a template is rendered.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Template#rendered","kind":"member","___id":"T000002R003233","___s":true,"locus":"Client"},"Template#destroyed":{"comment":"/**\n * @name destroyed\n * @instance\n * @memberOf Template\n * @summary Provide a callback when an instance of a template is destroyed.\n * @locus Client\n */","meta":{"range":[4127,4294],"filename":"template.js","lineno":131,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"destroyed","scope":"instance","memberof":"Template","summary":"Provide a callback when an instance of a template is destroyed.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Template#destroyed","kind":"member","___id":"T000002R003234","___s":true,"locus":"Client"},"Blaze":{"TemplateInstance#data":{"comment":"/**\n * @instance\n * @memberOf Blaze.TemplateInstance\n * @name data\n * @summary The data context of this instance's latest invocation.\n * @locus Client\n */","meta":{"range":[3010,3189],"filename":"template.js","lineno":84,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"scope":"instance","memberof":"Blaze.TemplateInstance","name":"data","summary":"The data context of this instance's latest invocation.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#data","kind":"member","___id":"T000002R003252","___s":true,"locus":"Client"},"TemplateInstance#view":{"comment":"/**\n * @name view\n * @memberOf Blaze.TemplateInstance\n * @instance\n * @summary The [View](#blaze_view) object for this invocation of the template.\n * @locus Client\n */","meta":{"range":[4839,5018],"filename":"template.js","lineno":163,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"view","memberof":"Blaze.TemplateInstance","scope":"instance","summary":"The [View](#blaze_view) object for this invocation of the template.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#view","kind":"member","___id":"T000002R003260","___s":true,"locus":"Client"},"TemplateInstance#firstNode":{"comment":"/**\n * @name firstNode\n * @memberOf Blaze.TemplateInstance\n * @instance\n * @summary The first top-level DOM node in this template instance.\n * @locus Client\n */","meta":{"range":[5062,5234],"filename":"template.js","lineno":173,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"firstNode","memberof":"Blaze.TemplateInstance","scope":"instance","summary":"The first top-level DOM node in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#firstNode","kind":"member","___id":"T000002R003263","___s":true,"locus":"Client"},"TemplateInstance#lastNode":{"comment":"/**\n * @name lastNode\n * @memberOf Blaze.TemplateInstance\n * @instance\n * @summary The last top-level DOM node in this template instance.\n * @locus Client\n */","meta":{"range":[5263,5433],"filename":"template.js","lineno":182,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"lastNode","memberof":"Blaze.TemplateInstance","scope":"instance","summary":"The last top-level DOM node in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"longname":"Blaze.TemplateInstance#lastNode","kind":"member","___id":"T000002R003265","___s":true,"locus":"Client"},"currentView":{"comment":"/**\n * @summary The View corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.\n * @locus Client\n */","meta":{"range":[13709,13733],"filename":"view.js","lineno":398,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046370","name":"Blaze.currentView","type":"Literal","value":"null","paramnames":[]}},"summary":"The View corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"currentView","longname":"Blaze.currentView","kind":"member","memberof":"Blaze","scope":"static","___id":"T000002R003376","___s":true,"locus":"Client"},"With":{"meta":{"range":[504,908],"filename":"builtins.js","lineno":13,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100035866","name":"Blaze.With","type":"FunctionExpression","value":"function","paramnames":["data","contentFunc"]},"vars":{"view":null,"view.dataVar":null,"":null}},"summary":"Constructs a View that renders content with a data context.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object","function"]},"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":["function"]},"description":"

A Function that returns renderable content.

","name":"contentFunc"}],"name":"With","longname":"Blaze.With","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002663","___s":true,"options":[],"locus":"Client"},"If":{"meta":{"range":[1488,2009],"filename":"builtins.js","lineno":39,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100035934","name":"Blaze.If","type":"FunctionExpression","value":"function","paramnames":["conditionFunc","contentFunc","elseFunc","_not"]},"vars":{"conditionVar":null,"view":null,"":null,"view.__conditionVar":null}},"summary":"Constructs a View that renders content conditionally.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"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.

","name":"conditionFunc"},{"type":{"names":["function"]},"description":"

A Function that returns renderable content.

","name":"contentFunc"},{"type":{"names":["function"]},"optional":true,"description":"

Optional. A Function that returns renderable content. If no elseFunc is supplied, no content is shown in the "else" case.

","name":"elseFunc"}],"name":"If","longname":"Blaze.If","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002666","___s":true,"options":[],"locus":"Client"},"Unless":{"meta":{"range":[2556,2694],"filename":"builtins.js","lineno":64,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100036020","name":"Blaze.Unless","type":"FunctionExpression","value":"function","paramnames":["conditionFunc","contentFunc","elseFunc"]}},"summary":"An inverted [`Blaze.If`](#blaze_if).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"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"]},"optional":true,"description":"

Optional. A Function that returns renderable content. If no elseFunc is supplied, no content is shown in the "else" case.

","name":"elseFunc"}],"name":"Unless","longname":"Blaze.Unless","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002671","___s":true,"options":[],"locus":"Client"},"Each":{"meta":{"range":[3207,6975],"filename":"builtins.js","lineno":75,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100036039","name":"Blaze.Each","type":"FunctionExpression","value":"function","paramnames":["argFunc","contentFunc","elseFunc"]},"vars":{"eachView":null,"":null,"eachView.initialSubviews":null,"eachView.numItems":null,"eachView.inElseMode":null,"eachView.stopHandle":null,"eachView.contentFunc":null,"eachView.elseFunc":null,"eachView.argVar":null}},"summary":"Constructs a View that renders `contentFunc` for each item in a sequence.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"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"]},"optional":true,"description":"

Optional. A Function that returns renderable content to display in the case when there are no items to display.

","name":"elseFunc"}],"name":"Each","longname":"Blaze.Each","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R002672","___s":true,"options":[],"locus":"Client"},"isTemplate":{"meta":{"range":[1519,1594],"filename":"template.js","lineno":43,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044519","name":"Blaze.isTemplate","type":"FunctionExpression","value":"function","paramnames":["t"]}},"summary":"Returns true if `value` is a template object like `Template.myTemplate`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Any"]},"description":"

The value to test.

","name":"value"}],"name":"isTemplate","longname":"Blaze.isTemplate","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003242","___s":true,"options":[],"locus":"Client"},"TemplateInstance#$":{"meta":{"range":[5688,5902],"filename":"template.js","lineno":197,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044877","name":"Blaze.TemplateInstance.prototype.$","type":"FunctionExpression","value":"function","paramnames":["selector"]},"vars":{"view":null}},"summary":"Find all elements matching `selector` in this template instance, and return them as a JQuery object.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The CSS selector to match, scoped to the template contents.

","name":"selector"}],"name":"$","longname":"Blaze.TemplateInstance#$","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003267","___s":true,"options":[],"locus":"Client"},"TemplateInstance#findAll":{"meta":{"range":[6095,6216],"filename":"template.js","lineno":209,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044912","name":"Blaze.TemplateInstance.prototype.findAll","type":"FunctionExpression","value":"function","paramnames":["selector"]}},"summary":"Find all elements matching `selector` in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The CSS selector to match, scoped to the template contents.

","name":"selector"}],"name":"findAll","longname":"Blaze.TemplateInstance#findAll","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003269","___s":true,"options":[],"locus":"Client"},"TemplateInstance#find":{"meta":{"range":[6408,6532],"filename":"template.js","lineno":218,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044938","name":"Blaze.TemplateInstance.prototype.find","type":"FunctionExpression","value":"function","paramnames":["selector"]},"vars":{"result":null}},"summary":"Find one element matching `selector` in this template instance.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The CSS selector to match, scoped to the template contents.

","name":"selector"}],"name":"find","longname":"Blaze.TemplateInstance#find","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003270","___s":true,"options":[],"locus":"Client"},"TemplateInstance#autorun":{"meta":{"range":[6775,6865],"filename":"template.js","lineno":228,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044964","name":"Blaze.TemplateInstance.prototype.autorun","type":"FunctionExpression","value":"function","paramnames":["f"]}},"summary":"A version of [Tracker.autorun](#tracker_autorun) that is stopped when the template is destroyed.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

The function to run. It receives one argument: a Tracker.Computation object.

","name":"runFunc"}],"name":"autorun","longname":"Blaze.TemplateInstance#autorun","kind":"function","memberof":"Blaze.TemplateInstance","scope":"instance","___id":"T000002R003272","___s":true,"options":[],"locus":"Client"},"render":{"meta":{"range":[16631,17688],"filename":"view.js","lineno":480,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046546","name":"Blaze.render","type":"FunctionExpression","value":"function","paramnames":["content","parentElement","nextNode","parentView"]},"vars":{"parentView":null,"nextNode":null,"view":null}},"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).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"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":["DOMNode"]},"description":"

The node that will be the parent of the rendered template. It must be an Element node.

","name":"parentNode"},{"type":{"names":["DOMNode"]},"optional":true,"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"},{"type":{"names":["Blaze.View"]},"optional":true,"description":"

Optional. If provided, it will be set as the rendered View's parentView.

","name":"parentView"}],"name":"render","longname":"Blaze.render","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003386","___s":true,"options":[],"locus":"Client"},"renderWithData":{"meta":{"range":[18961,19310],"filename":"view.js","lineno":531,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046686","name":"Blaze.renderWithData","type":"FunctionExpression","value":"function","paramnames":["content","data","parentElement","nextNode","parentView"]}},"summary":"Renders a template or View to DOM nodes with a data context. Otherwise identical to `Blaze.render`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"description":"

The template (e.g. Template.myTemplate) or View object to render.

","name":"templateOrView"},{"type":{"names":["Object","function"]},"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":["DOMNode"]},"description":"

The node that will be the parent of the rendered template. It must be an Element node.

","name":"parentNode"},{"type":{"names":["DOMNode"]},"optional":true,"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"},{"type":{"names":["Blaze.View"]},"optional":true,"description":"

Optional. If provided, it will be set as the rendered View's parentView.

","name":"parentView"}],"name":"renderWithData","longname":"Blaze.renderWithData","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003392","___s":true,"options":[],"locus":"Client"},"remove":{"meta":{"range":[19545,19863],"filename":"view.js","lineno":543,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046714","name":"Blaze.remove","type":"FunctionExpression","value":"function","paramnames":["view"]},"vars":{"range":null}},"summary":"Removes a rendered View from the DOM, stopping all reactive updates and event listeners on it.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Blaze.View"]},"description":"

The return value from Blaze.render or Blaze.renderWithData.

","name":"renderedView"}],"name":"remove","longname":"Blaze.remove","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003393","___s":true,"options":[],"locus":"Client"},"toHTML":{"meta":{"range":[20084,20266],"filename":"view.js","lineno":560,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046768","name":"Blaze.toHTML","type":"FunctionExpression","value":"function","paramnames":["content","parentView"]},"vars":{"parentView":null}},"summary":"Renders a template or View to a string of HTML.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"description":"

The template (e.g. Template.myTemplate) or View object from which to generate HTML.

","name":"templateOrView"}],"name":"toHTML","longname":"Blaze.toHTML","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003395","___s":true,"options":[],"locus":"Client"},"toHTMLWithData":{"meta":{"range":[20633,20861],"filename":"view.js","lineno":572,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046797","name":"Blaze.toHTMLWithData","type":"FunctionExpression","value":"function","paramnames":["content","data","parentView"]},"vars":{"parentView":null}},"summary":"Renders a template or View to HTML with a data context. Otherwise identical to `Blaze.toHTML`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Template","Blaze.View"]},"description":"

The template (e.g. Template.myTemplate) or View object from which to generate HTML.

","name":"templateOrView"},{"type":{"names":["Object","function"]},"description":"

The data context to use, or a function returning a data context.

","name":"data"}],"name":"toHTMLWithData","longname":"Blaze.toHTMLWithData","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003397","___s":true,"options":[],"locus":"Client"},"getData":{"meta":{"range":[21866,22474],"filename":"view.js","lineno":605,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100046928","name":"Blaze.getData","type":"FunctionExpression","value":"function","paramnames":["elementOrView"]},"vars":{"theWith":null,"view":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["DOMElement","Blaze.View"]},"optional":true,"description":"

Optional. An element that was rendered by a Meteor, or a View.

","name":"elementOrView"}],"name":"getData","longname":"Blaze.getData","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003403","___s":true,"options":[],"locus":"Client"},"getView":{"meta":{"range":[23015,23726],"filename":"view.js","lineno":643,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100047052","name":"Blaze.getView","type":"FunctionExpression","value":"function","paramnames":["elementOrView","_viewName"]},"vars":{"viewName":null,"elementOrView":null}},"summary":"Gets either the current View, or the View enclosing the given DOM element.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["DOMElement"]},"optional":true,"description":"

Optional. If specified, the View enclosing element is returned.

","name":"element"}],"name":"getView","longname":"Blaze.getView","kind":"function","memberof":"Blaze","scope":"static","___id":"T000002R003410","___s":true,"options":[],"locus":"Client"},"Template":{"meta":{"range":[725,1334],"filename":"template.js","lineno":16,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044440","name":"Blaze.Template","type":"FunctionExpression","value":"function","paramnames":["viewName","renderFunction"]},"vars":{"renderFunction":null,"viewName":null,"this.viewName":null,"this.renderFunction":null,"this.__eventMaps":null}},"kind":"class","summary":"Constructor for a Template, which is used to construct Views with particular name and content.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"optional":true,"description":"

Optional. A name for Views constructed by this Template. See view.name.

","name":"viewName"},{"type":{"names":["function"]},"description":"

A function that returns renderable content. This function is used as the renderFunction for Views constructed by this Template.

","name":"renderFunction"}],"name":"Template","longname":"Blaze.Template","memberof":"Blaze","scope":"static","___id":"T000002R003235","___s":true,"options":[],"locus":"Client"},"TemplateInstance":{"meta":{"range":[4559,5459],"filename":"template.js","lineno":153,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044815","name":"Blaze.TemplateInstance","type":"FunctionExpression","value":"function","paramnames":["view"]},"vars":{"view._templateInstance":null,"this.view":null,"this.data":null,"this.firstNode":null,"this.lastNode":null}},"kind":"class","summary":"The class for template instances","params":[{"type":{"names":["Blaze.View"]},"name":"view"}],"tags":[{"originalTitle":"instanceName","title":"instancename","text":"template","value":"template"}],"name":"TemplateInstance","longname":"Blaze.TemplateInstance","memberof":"Blaze","scope":"static","___id":"T000002R003258","___s":true,"options":[],"instancename":"template"},"View":{"meta":{"range":[1982,2788],"filename":"view.js","lineno":43,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045172","name":"Blaze.View","type":"FunctionExpression","value":"function","paramnames":["name","render"]},"vars":{"render":null,"name":null,"this.name":null,"this._render":null,"this._callbacks":null,"this.isCreated":null,"this._isCreatedForExpansion":null,"this.isRendered":null,"this._isAttached":null,"this.isDestroyed":null,"this._isInRender":null,"this.parentView":null,"this._domrange":null,"this.renderCount":null}},"kind":"class","summary":"Constructor for a View, which represents a reactive region of DOM.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"optional":true,"description":"

Optional. A name for this type of View. See view.name.

","name":"name"},{"type":{"names":["function"]},"description":"

A function that returns renderable content. In this function, this is bound to the View.

","name":"renderFunction"}],"name":"View","longname":"Blaze.View","memberof":"Blaze","scope":"static","___id":"T000002R003293","___s":true,"options":[],"locus":"Client"}},"Template":{"instance":{"comment":"/**\n * @name instance\n * @memberOf Template\n * @summary The [template instance](#template_inst) corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.\n * @locus Client\n */","meta":{"range":[7904,8132],"filename":"template.js","lineno":268,"path":"/Users/sashko/git/meteor/packages/blaze","code":{}},"name":"instance","memberof":"Template","summary":"The [template instance](#template_inst) corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"scope":"static","longname":"Template.instance","kind":"member","___id":"T000002R003286","___s":true,"locus":"Client"},"body":{"comment":"/**\n * @summary The [template object](#templates_api) representing your `` tag.\n * @locus Client\n */","meta":{"range":[1019,1256],"filename":"templating.js","lineno":34,"path":"/Users/sashko/git/meteor/packages/templating","code":{"id":"astnode100525196","name":"Template.body","type":"NewExpression","paramnames":[]}},"summary":"The [template object](#templates_api) representing your `` tag.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"body","longname":"Template.body","kind":"member","memberof":"Template","scope":"static","___id":"T000002R076945","___s":true,"locus":"Client"},"currentData":{"meta":{"range":[8672,8708],"filename":"template.js","lineno":294,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045147","name":"Template.currentData","type":"MemberExpression","value":"Blaze.getData","paramnames":[]}},"summary":"Returns the data context of the current helper, or the data context of the template that declares the current event handler or callback. Establishes a reactive dependency on the result.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"kind":"function","name":"currentData","longname":"Template.currentData","memberof":"Template","scope":"static","___id":"T000002R003290","___s":true,"options":[],"params":[],"locus":"Client"},"parentData":{"meta":{"range":[8921,8960],"filename":"template.js","lineno":302,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045155","name":"Template.parentData","type":"MemberExpression","value":"Blaze._parentData","paramnames":[]}},"summary":"Accesses other data contexts that enclose the current data context.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"kind":"function","params":[{"type":{"names":["Integer"]},"description":"

The number of levels beyond the current data context to look.

","name":"numLevels"}],"name":"parentData","longname":"Template.parentData","memberof":"Template","scope":"static","___id":"T000002R003291","___s":true,"options":[],"locus":"Client"},"registerHelper":{"meta":{"range":[9230,9276],"filename":"template.js","lineno":311,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045163","name":"Template.registerHelper","type":"MemberExpression","value":"Blaze.registerHelper","paramnames":[]}},"summary":"Defines a [helper function](#template_helpers) which can be used from all templates.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"kind":"function","params":[{"type":{"names":["String"]},"description":"

The name of the helper function you are defining.

","name":"name"},{"type":{"names":["function"]},"description":"

The helper function itself.

","name":"function"}],"name":"registerHelper","longname":"Template.registerHelper","memberof":"Template","scope":"static","___id":"T000002R003292","___s":true,"options":[],"locus":"Client"},"meta":{"range":[156,181],"filename":"templating.js","lineno":9,"path":"/Users/sashko/git/meteor/packages/templating","code":{"id":"astnode100525127","name":"Template","type":"MemberExpression","value":"Blaze.Template","paramnames":[]}},"summary":"The class for defining templates","kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"Template.myTemplate","value":"Template.myTemplate"}],"name":"Template","longname":"Template","scope":"global","___id":"T000002R076941","___s":true,"options":[],"params":[],"instancename":"Template.myTemplate"},"MethodInvocation#isSimulation":{"comment":"/**\n * @summary Access inside a method invocation. Boolean value, true if this invocation is a stub.\n * @locus Anywhere\n * @name isSimulation\n * @memberOf MethodInvocation\n * @instance\n */","meta":{"range":[1023,1225],"filename":"livedata_common.js","lineno":26,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"Access inside a method invocation. Boolean value, true if this invocation is a stub.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"isSimulation","memberof":"MethodInvocation","scope":"instance","longname":"MethodInvocation#isSimulation","kind":"member","___id":"T000002R051223","___s":true,"locus":"Anywhere"},"MethodInvocation#userId":{"comment":"/**\n * @summary The id of the user that made this method call, or `null` if no user was logged in.\n * @locus Anywhere\n * @name userId\n * @memberOf MethodInvocation\n * @instance\n */","meta":{"range":[1535,1728],"filename":"livedata_common.js","lineno":43,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"The id of the user that made this method call, or `null` if no user was logged in.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"userId","memberof":"MethodInvocation","scope":"instance","longname":"MethodInvocation#userId","kind":"member","___id":"T000002R051227","___s":true,"locus":"Anywhere"},"MethodInvocation#connection":{"comment":"/**\n * @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.\n * @locus Server\n * @name connection\n * @memberOf MethodInvocation\n * @instance\n */","meta":{"range":[1980,2294],"filename":"livedata_common.js","lineno":58,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"name":"connection","memberof":"MethodInvocation","scope":"instance","longname":"MethodInvocation#connection","kind":"member","___id":"T000002R051230","___s":true,"locus":"Server"},"Subscription#connection":{"comment":"/**\n * @summary Access inside the publish function. The incoming [connection](#meteor_onconnection) for this subscription.\n * @locus Server\n * @name connection\n * @memberOf Subscription\n * @instance\n */","meta":{"range":[27477,27692],"filename":"livedata_server.js","lineno":863,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"Access inside the publish function. The incoming [connection](#meteor_onconnection) for this subscription.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"name":"connection","memberof":"Subscription","scope":"instance","longname":"Subscription#connection","kind":"member","___id":"T000002R052738","___s":true,"locus":"Server"},"Subscription#userId":{"comment":"/**\n * @summary Access inside the publish function. The id of the logged-in user, or `null` if no user is logged in.\n * @locus Server\n * @memberOf Subscription\n * @name userId\n * @instance\n */","meta":{"range":[28731,28936],"filename":"livedata_server.js","lineno":905,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"Access inside the publish function. The id of the logged-in user, or `null` if no user is logged in.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","name":"userId","scope":"instance","longname":"Subscription#userId","kind":"member","___id":"T000002R052750","___s":true,"locus":"Server"},"Tracker":{"active":{"comment":"/**\n * @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.\n * @locus Client\n */","meta":{"range":[418,440],"filename":"tracker.js","lineno":13,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100534662","name":"Tracker.active","type":"Literal","value":"false","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"active","longname":"Tracker.active","kind":"member","memberof":"Tracker","scope":"static","___id":"T000002R077667","___s":true,"locus":"Client"},"currentComputation":{"comment":"/**\n * @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.\n * @locus Client\n */","meta":{"range":[824,857],"filename":"tracker.js","lineno":21,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100534668","name":"Tracker.currentComputation","type":"Literal","value":"null","paramnames":[]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"currentComputation","longname":"Tracker.currentComputation","kind":"member","memberof":"Tracker","scope":"static","___id":"T000002R077668","___s":true,"locus":"Client"},"Computation#stopped":{"comment":"/**\n * @summary True if this computation has been stopped.\n * @locus Client\n * @memberOf Tracker.Computation\n * @instance\n * @name stopped\n */","meta":{"range":[4547,4702],"filename":"tracker.js","lineno":132,"path":"/Users/sashko/git/meteor/packages/tracker","code":{}},"summary":"True if this computation has been stopped.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Tracker.Computation","scope":"instance","name":"stopped","longname":"Tracker.Computation#stopped","kind":"member","___id":"T000002R077694","___s":true,"locus":"Client"},"Computation#invalidated":{"comment":"/**\n * @summary True if this computation has been invalidated (and not yet rerun), or if it has been stopped.\n * @locus Client\n * @memberOf Tracker.Computation\n * @instance\n * @name invalidated\n */","meta":{"range":[4784,4994],"filename":"tracker.js","lineno":143,"path":"/Users/sashko/git/meteor/packages/tracker","code":{}},"summary":"True if this computation has been invalidated (and not yet rerun), or if it has been stopped.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Tracker.Computation","scope":"instance","name":"invalidated","longname":"Tracker.Computation#invalidated","kind":"member","___id":"T000002R077696","___s":true,"locus":"Client"},"Computation#firstRun":{"comment":"/**\n * @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.\n * @locus Client\n * @memberOf Tracker.Computation\n * @instance\n * @name firstRun\n */","meta":{"range":[5077,5329],"filename":"tracker.js","lineno":154,"path":"/Users/sashko/git/meteor/packages/tracker","code":{}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Tracker.Computation","scope":"instance","name":"firstRun","longname":"Tracker.Computation#firstRun","kind":"member","___id":"T000002R077698","___s":true,"locus":"Client"},"Computation":{"meta":{"range":[4266,5759],"filename":"tracker.js","lineno":122,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100534917","name":"Tracker.Computation","type":"FunctionExpression","value":"function","paramnames":["f","parent"]},"vars":{"constructingComputation":null,"self":null,"self.stopped":null,"self.invalidated":null,"self.firstRun":null,"self._id":null,"self._onInvalidateCallbacks":null,"self._parent":null,"self._func":null,"self._recomputing":null,"errored":null}},"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.","tags":[{"originalTitle":"instancename","title":"instancename","text":"computation","value":"computation"}],"name":"Computation","longname":"Tracker.Computation","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077691","___s":true,"options":[],"params":[],"instancename":"computation"},"Computation#onInvalidate":{"meta":{"range":[6268,6602],"filename":"tracker.js","lineno":189,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535019","name":"Tracker.Computation.prototype.onInvalidate","type":"FunctionExpression","value":"function","paramnames":["f"]},"vars":{"self":null,"":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

Function to be called on invalidation. Receives one argument, the computation that was invalidated.

","name":"callback"}],"name":"onInvalidate","longname":"Tracker.Computation#onInvalidate","kind":"function","memberof":"Tracker.Computation","scope":"instance","___id":"T000002R077708","___s":true,"options":[],"locus":"Client"},"Computation#invalidate":{"meta":{"range":[6748,7393],"filename":"tracker.js","lineno":210,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535071","name":"Tracker.Computation.prototype.invalidate","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"self":null,"self.invalidated":null,"i":null,"f":null,"":null,"self._onInvalidateCallbacks":null}},"summary":"Invalidates this computation so that it will be rerun.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"invalidate","longname":"Tracker.Computation#invalidate","kind":"function","memberof":"Tracker.Computation","scope":"instance","___id":"T000002R077710","___s":true,"options":[],"params":[],"locus":"Client"},"Computation#stop":{"meta":{"range":[7520,7648],"filename":"tracker.js","lineno":239,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535154","name":"Tracker.Computation.prototype.stop","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"this.stopped":null}},"summary":"Prevents this computation from rerunning.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"stop","longname":"Tracker.Computation#stop","kind":"function","memberof":"Tracker.Computation","scope":"instance","___id":"T000002R077717","___s":true,"options":[],"params":[],"locus":"Client"},"Dependency#depend":{"meta":{"range":[9967,10409],"filename":"tracker.js","lineno":317,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535306","name":"Tracker.Dependency.prototype.depend","type":"FunctionExpression","value":"function","paramnames":["computation"]},"vars":{"computation":null,"self":null,"id":null,"self._dependentsById[undefined]":null,"":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Tracker.Computation"]},"optional":true,"description":"

An optional computation declared to depend on dependency instead of the current computation.

","name":"fromComputation"}],"name":"depend","longname":"Tracker.Dependency#depend","kind":"function","memberof":"Tracker.Dependency","scope":"instance","___id":"T000002R077732","___s":true,"options":[],"locus":"Client"},"Dependency#changed":{"meta":{"range":[10577,10732],"filename":"tracker.js","lineno":342,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535379","name":"Tracker.Dependency.prototype.changed","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"self":null,"id":null}},"summary":"Invalidate all dependent computations immediately and remove them as dependents.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"changed","longname":"Tracker.Dependency#changed","kind":"function","memberof":"Tracker.Dependency","scope":"instance","___id":"T000002R077737","___s":true,"options":[],"params":[],"locus":"Client"},"Dependency#hasDependents":{"meta":{"range":[10951,11101],"filename":"tracker.js","lineno":354,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535410","name":"Tracker.Dependency.prototype.hasDependents","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"self":null,"id":null}},"summary":"True if this Dependency has one or more dependent Computations, which would be invalidated if this Dependency were to change.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"hasDependents","longname":"Tracker.Dependency#hasDependents","kind":"function","memberof":"Tracker.Dependency","scope":"instance","___id":"T000002R077740","___s":true,"options":[],"params":[],"locus":"Client"},"flush":{"meta":{"range":[11280,12945],"filename":"tracker.js","lineno":367,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535436","name":"Tracker.flush","type":"FunctionExpression","value":"function","paramnames":["_opts"]},"vars":{"inFlush":null,"willFlush":null,"throwFirstError":null,"finishedTry":null,"comp":null,"func":null}},"summary":"Process all reactive updates immediately and ensure that all invalidated computations are rerun.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"flush","longname":"Tracker.flush","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077743","___s":true,"options":[],"params":[],"locus":"Client"},"autorun":{"meta":{"range":[13572,13906],"filename":"tracker.js","lineno":438,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535558","name":"Tracker.autorun","type":"FunctionExpression","value":"function","paramnames":["f"]},"vars":{"constructingComputation":null,"c":null,"":null}},"summary":"Run a function now and rerun it later whenever its dependencies change. Returns a Computation object that can be used to stop or observe the rerunning.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

The function to run. It receives one argument: the Computation object that will be returned.

","name":"runFunc"}],"name":"autorun","longname":"Tracker.autorun","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077755","___s":true,"options":[],"locus":"Client"},"nonreactive":{"meta":{"range":[14340,14533],"filename":"tracker.js","lineno":465,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535608","name":"Tracker.nonreactive","type":"FunctionExpression","value":"function","paramnames":["f"]},"vars":{"previous":null}},"summary":"Run a function without tracking dependencies.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

A function to call immediately.

","name":"func"}],"name":"nonreactive","longname":"Tracker.nonreactive","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077758","___s":true,"options":[],"locus":"Client"},"onInvalidate":{"meta":{"range":[14970,15155],"filename":"tracker.js","lineno":482,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535636","name":"Tracker.onInvalidate","type":"FunctionExpression","value":"function","paramnames":["f"]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

A callback function that will be invoked as func(c), where c is the computation on which the callback is registered.

","name":"callback"}],"name":"onInvalidate","longname":"Tracker.onInvalidate","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077760","___s":true,"options":[],"locus":"Client"},"afterFlush":{"meta":{"range":[15566,15652],"filename":"tracker.js","lineno":496,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535661","name":"Tracker.afterFlush","type":"FunctionExpression","value":"function","paramnames":["f"]}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["function"]},"description":"

A function to call at flush time.

","name":"callback"}],"name":"afterFlush","longname":"Tracker.afterFlush","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R077761","___s":true,"options":[],"locus":"Client"},"Dependency":{"meta":{"range":[9057,9122],"filename":"tracker.js","lineno":297,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100535293","name":"Tracker.Dependency","type":"FunctionExpression","value":"function","paramnames":[]},"vars":{"this._dependentsById":null}},"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.","kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"dependency","value":"dependency"}],"name":"Dependency","longname":"Tracker.Dependency","memberof":"Tracker","scope":"static","___id":"T000002R077730","___s":true,"options":[],"params":[],"instancename":"dependency"}},"Template#helpers":{"meta":{"range":[7025,7118],"filename":"template.js","lineno":237,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100044984","name":"Template.prototype.helpers","type":"FunctionExpression","value":"function","paramnames":["dict"]},"vars":{"k":null,"this[undefined]":null}},"summary":"Specify template helpers available to this template.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Object"]},"description":"

Dictionary of helper functions by name.

","name":"helpers"}],"name":"helpers","longname":"Template#helpers","kind":"function","memberof":"Template","scope":"instance","___id":"T000002R003273","___s":true,"options":[],"locus":"Client"},"Template#events":{"meta":{"range":[7278,7901],"filename":"template.js","lineno":247,"path":"/Users/sashko/git/meteor/packages/blaze","code":{"id":"astnode100045007","name":"Template.prototype.events","type":"FunctionExpression","value":"function","paramnames":["eventMap"]},"vars":{"template":null,"eventMap2":null,"k":null,"eventMap2[undefined]":null,"":null}},"summary":"Specify event handlers for this template.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["EventMap"]},"description":"

Event handlers to associate with this template.

","name":"eventMap"}],"name":"events","longname":"Template#events","kind":"function","memberof":"Template","scope":"instance","___id":"T000002R003276","___s":true,"options":[],"locus":"Client"},"MethodInvocation":{"meta":{"range":[500,2526],"filename":"livedata_common.js","lineno":15,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100273713","name":"MethodInvocation","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"self":null,"this.isSimulation":null,"this._unblock":null,"":null,"this._calledUnblock":null,"this.userId":null,"this._setUserId":null,"this.connection":null,"this.randomSeed":null,"this.randomStream":null}},"summary":"The state for a single invocation of a method, referenced by this\ninside a method definition.","params":[{"type":{"names":["Object"]},"name":"options"}],"tags":[{"originalTitle":"instanceName","title":"instancename","text":"this","value":"this"}],"name":"MethodInvocation","longname":"MethodInvocation","kind":"function","scope":"global","___id":"T000002R051221","___s":true,"options":[],"instancename":"this"},"MethodInvocation#unblock":{"meta":{"range":[2770,2870],"filename":"livedata_common.js","lineno":81,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100273797","name":"unblock","type":"FunctionExpression","value":"function"},"vars":{"self":null,"self._calledUnblock":null}},"summary":"Call inside a method invocation. Allow subsequent method from this client to begin running in a new fiber.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"MethodInvocation","scope":"instance","name":"unblock","longname":"MethodInvocation#unblock","kind":"function","___id":"T000002R051234","___s":true,"options":[],"params":[],"locus":"Server"},"MethodInvocation#setUserId":{"meta":{"range":[3092,3311],"filename":"livedata_common.js","lineno":94,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100273815","name":"setUserId","type":"FunctionExpression","value":"function"},"vars":{"self":null,"self.userId":null}},"summary":"Set the logged in user.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"MethodInvocation","scope":"instance","params":[{"type":{"names":["String","null"]},"description":"

The value that should be returned by userId on this connection.

","name":"userId"}],"name":"setUserId","longname":"MethodInvocation#setUserId","kind":"function","___id":"T000002R051237","___s":true,"options":[],"locus":"Server"},"DDP":{"connect":{"meta":{"range":[60099,60244],"filename":"livedata_connection.js","lineno":1587,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100278567","name":"DDP.connect","type":"FunctionExpression","value":"function","paramnames":["url","options"]},"vars":{"ret":null}},"summary":"Connect to the server of a different Meteor application to subscribe to its document sets and invoke its remote methods.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

The URL of another Meteor application.

","name":"url"}],"name":"connect","longname":"DDP.connect","kind":"function","memberof":"DDP","scope":"static","___id":"T000002R051592","___s":true,"options":[],"locus":"Anywhere"}},"Subscription#error":{"meta":{"range":[35098,35259],"filename":"livedata_server.js","lineno":1074,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290848","name":"error","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Call inside the publish function. Stops this client's subscription, triggering a call on the client to the `onError` callback passed to [`Meteor.subscribe`](#meteor_subscribe), if any. If `error` is not a [`Meteor.Error`](#meteor_error), it will be [sanitized](#meteor_error).","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Error"]},"description":"

The error to pass to the client.

","name":"error"}],"scope":"instance","memberof":"Subscription","name":"error","longname":"Subscription#error","kind":"function","___id":"T000002R052774","___s":true,"options":[],"locus":"Server"},"Subscription#stop":{"meta":{"range":[35755,35903],"filename":"livedata_server.js","lineno":1092,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290873","name":"stop","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Call inside the publish function. Stops this client's subscription; the `onError` callback is *not* invoked on the client.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"scope":"instance","memberof":"Subscription","name":"stop","longname":"Subscription#stop","kind":"function","___id":"T000002R052776","___s":true,"options":[],"params":[],"locus":"Server"},"Subscription#onStop":{"meta":{"range":[36152,36306],"filename":"livedata_server.js","lineno":1106,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290896","name":"onStop","type":"FunctionExpression","value":"function"},"vars":{"self":null}},"summary":"Call inside the publish function. Registers a callback function to run when the subscription is stopped.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["function"]},"description":"

The callback function

","name":"func"}],"name":"onStop","longname":"Subscription#onStop","kind":"function","___id":"T000002R052778","___s":true,"options":[],"locus":"Server"},"Subscription#added":{"meta":{"range":[37038,37338],"filename":"livedata_server.js","lineno":1131,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290939","name":"added","type":"FunctionExpression","value":"function"},"vars":{"self":null,"id":null,"[undefined]":null}},"summary":"Call inside the publish function. Informs the subscriber that a document has been added to the record set.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["String"]},"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":["Object"]},"description":"

The fields in the new document. If _id is present it is ignored.

","name":"fields"}],"name":"added","longname":"Subscription#added","kind":"function","___id":"T000002R052782","___s":true,"options":[],"locus":"Server"},"Subscription#changed":{"meta":{"range":[37986,38226],"filename":"livedata_server.js","lineno":1149,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100290991","name":"changed","type":"FunctionExpression","value":"function"},"vars":{"self":null,"id":null}},"summary":"Call inside the publish function. Informs the subscriber that a document in the record set has been modified.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["String"]},"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":["Object"]},"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"}],"name":"changed","longname":"Subscription#changed","kind":"function","___id":"T000002R052786","___s":true,"options":[],"locus":"Server"},"Subscription#removed":{"meta":{"range":[38601,39009],"filename":"livedata_server.js","lineno":1165,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291030","name":"removed","type":"FunctionExpression","value":"function"},"vars":{"self":null,"id":null}},"summary":"Call inside the publish function. Informs the subscriber that a document has been removed from the record set.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","params":[{"type":{"names":["String"]},"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"}],"name":"removed","longname":"Subscription#removed","kind":"function","___id":"T000002R052789","___s":true,"options":[],"locus":"Server"},"Subscription#ready":{"meta":{"range":[39354,39646],"filename":"livedata_server.js","lineno":1182,"path":"/Users/sashko/git/meteor/packages/ddp","code":{"id":"astnode100291076","name":"ready","type":"FunctionExpression","value":"function"},"vars":{"self":null,"self._ready":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"memberof":"Subscription","scope":"instance","name":"ready","longname":"Subscription#ready","kind":"function","___id":"T000002R052792","___s":true,"options":[],"params":[],"locus":"Server"},"EJSON":{"newBinary":{"meta":{"range":[1470,1769],"filename":"base64.js","lineno":70,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100304377","name":"EJSON.newBinary","type":"FunctionExpression","value":"function","paramnames":["len"]},"vars":{"ret":null,"i":null,"ret.$Uint8ArrayPolyfill":null}},"summary":"Allocate a new buffer of binary data that EJSON can serialize.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Number"]},"description":"

The number of bytes of binary data to allocate.

","name":"size"}],"name":"newBinary","longname":"EJSON.newBinary","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053796","___s":true,"options":[],"locus":"Anywhere"},"addType":{"meta":{"range":[1156,1321],"filename":"ejson.js","lineno":24,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100305227","name":"EJSON.addType","type":"FunctionExpression","value":"function","paramnames":["name","factory"]},"vars":{"customTypes[undefined]":null}},"summary":"Add a custom datatype to EJSON.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

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":["function"]},"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"}],"name":"addType","longname":"EJSON.addType","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053877","___s":true,"options":[],"locus":"Anywhere"},"toJSONValue":{"meta":{"range":[5932,6178],"filename":"ejson.js","lineno":193,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100305844","name":"EJSON.toJSONValue","type":"FunctionExpression","value":"function","paramnames":["item"]},"vars":{"changed":null,"item":null}},"summary":"Serialize an EJSON-compatible value into its plain JSON representation.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"

A value to serialize to plain JSON.

","name":"val"}],"name":"toJSONValue","longname":"EJSON.toJSONValue","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053927","___s":true,"options":[],"locus":"Anywhere"},"fromJSONValue":{"meta":{"range":[7910,8166],"filename":"ejson.js","lineno":262,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306042","name":"EJSON.fromJSONValue","type":"FunctionExpression","value":"function","paramnames":["item"]},"vars":{"changed":null,"item":null}},"summary":"Deserialize an EJSON value from its plain JSON representation.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["JSONCompatible"]},"description":"

A value to deserialize into EJSON.

","name":"val"}],"name":"fromJSONValue","longname":"EJSON.fromJSONValue","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053938","___s":true,"options":[],"locus":"Anywhere"},"stringify":{"meta":{"range":[8794,9037],"filename":"ejson.js","lineno":283,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306083","name":"EJSON.stringify","type":"FunctionExpression","value":"function","paramnames":["item","options"]},"vars":{"json":null}},"summary":"Serialize a value to a string.\n\nFor EJSON values, the serialization fully represents the value. For non-EJSON values, serializes the same way as `JSON.stringify`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"

A value to stringify.

","name":"val"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"stringify","longname":"EJSON.stringify","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053941","___s":true,"options":[{"type":{"names":["Boolean","Integer","String"]},"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"]},"description":"

When true, stringifies keys in an object in sorted order.

","name":"canonical"}],"locus":"Anywhere"},"parse":{"meta":{"range":[9227,9404],"filename":"ejson.js","lineno":297,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306125","name":"EJSON.parse","type":"FunctionExpression","value":"function","paramnames":["item"]}},"summary":"Parse a string into an EJSON value. Throws an error if the string is not valid EJSON.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

A string to parse into an EJSON value.

","name":"str"}],"name":"parse","longname":"EJSON.parse","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053943","___s":true,"options":[],"locus":"Anywhere"},"isBinary":{"meta":{"range":[9595,9749],"filename":"ejson.js","lineno":308,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306152","name":"EJSON.isBinary","type":"FunctionExpression","value":"function","paramnames":["obj"]}},"summary":"Returns true if `x` is a buffer of binary data, as returned from [`EJSON.newBinary`](#ejson_new_binary).","params":[{"type":{"names":["Object"]},"description":"

The variable to check.

","name":"x"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"isBinary","longname":"EJSON.isBinary","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053944","___s":true,"options":[],"locus":"Anywhere"},"equals":{"meta":{"range":[10268,12522],"filename":"ejson.js","lineno":321,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306177","name":"EJSON.equals","type":"FunctionExpression","value":"function","paramnames":["a","b","options"]},"vars":{"i":null,"keyOrderSensitive":null,"ret":null,"bKeys":null,"":null}},"summary":"Return true if `a` and `b` are equal to each other. Return false otherwise. Uses the `equals` method on `a` if present, otherwise performs a deep comparison.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"name":"a"},{"type":{"names":["EJSON"]},"name":"b"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"equals","longname":"EJSON.equals","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053945","___s":true,"options":[{"type":{"names":["Boolean"]},"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"}],"locus":"Anywhere"},"clone":{"meta":{"range":[12632,13898],"filename":"ejson.js","lineno":407,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100306564","name":"EJSON.clone","type":"FunctionExpression","value":"function","paramnames":["v"]},"vars":{"ret":null,"i":null,"ret[undefined]":null,"":null}},"summary":"Return a deep copy of `val`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"

A value to copy.

","name":"val"}],"name":"clone","longname":"EJSON.clone","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R053956","___s":true,"options":[],"locus":"Anywhere"}},"Email":{"send":{"meta":{"range":[4584,5279],"filename":"email.js","lineno":141,"path":"/Users/sashko/git/meteor/packages/email","code":{"id":"astnode100308942","name":"Email.send","type":"FunctionExpression","value":"function","paramnames":["options"]},"vars":{"i":null,"mc":null,"":null,"pool":null}},"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.","tags":[{"originalTitle":"locus","title":"locus","text":"Server","value":"Server"}],"params":[{"type":{"names":["Object"]},"name":"options"}],"name":"send","longname":"Email.send","kind":"function","memberof":"Email","scope":"static","___id":"T000002R054178","___s":true,"options":[{"type":{"names":["String"]},"description":"

"From:" address (required)

","name":"from"},{"type":{"names":["String","Array."]},"description":"

"To:", "Cc:", "Bcc:", and "Reply-To:" addresses

","name":"to, cc, bcc, replyTo"},{"type":{"names":["String"]},"optional":true,"description":"

"Subject:" line

","name":"subject"},{"type":{"names":["String"]},"optional":true,"description":"

Mail body (in plain text or HTML)

","name":"text, html"},{"type":{"names":["Object"]},"optional":true,"description":"

Dictionary of custom headers

","name":"headers"}],"locus":"Server"}},"HTTP":{"call":{"meta":{"range":[1471,6226],"filename":"httpcall_client.js","lineno":17,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345042","name":"HTTP.call","type":"FunctionExpression","value":"function","paramnames":["method","url","options","callback"]},"vars":{"callback":null,"options":null,"method":null,"headers":null,"content":null,"headers['Content-Type']":null,"params_for_url":null,"params_for_body":null,"url":null,"username":null,"password":null,"colonLoc":null,"":null,"xhr":null,"k":null,"timed_out":null,"timer":null,"xhr.onreadystatechange":null}},"summary":"Perform an outbound HTTP request.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"

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":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"

Optional callback. If passed, the method runs asynchronously, instead of synchronously, and calls asyncCallback. On the client, this callback is required.

","name":"asyncCallback"}],"name":"call","longname":"HTTP.call","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062535","___s":true,"options":[{"type":{"names":["String"]},"description":"

String to use as the HTTP request body.

","name":"content"},{"type":{"names":["Object"]},"description":"

JSON-able object to stringify and use as the HTTP request body. Overwrites content.

","name":"data"},{"type":{"names":["String"]},"description":"

Query string to go in the URL. Overwrites any query string in url.

","name":"query"},{"type":{"names":["Object"]},"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":["String"]},"description":"

HTTP basic authentication string of the form "username:password"

","name":"auth"},{"type":{"names":["Object"]},"description":"

Dictionary of strings, headers to add to the HTTP request.

","name":"headers"},{"type":{"names":["Number"]},"description":"

Maximum time in milliseconds to wait for the request before failing. There is no timeout by default.

","name":"timeout"},{"type":{"names":["Boolean"]},"description":"

If true, transparently follow HTTP redirects. Cannot be set to false on the client. Default true.

","name":"followRedirects"}],"locus":"Anywhere"},"get":{"meta":{"range":[1479,1588],"filename":"httpcall_common.js","lineno":44,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345685","name":"HTTP.get","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Send an HTTP `GET` request. Equivalent to calling [`HTTP.call`](#http_call) with \"GET\" as the first argument.","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"get","longname":"HTTP.get","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062589","___s":true,"options":[],"locus":"Anywhere"},"post":{"meta":{"range":[2007,2118],"filename":"httpcall_common.js","lineno":55,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345710","name":"HTTP.post","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Send an HTTP `POST` request. Equivalent to calling [`HTTP.call`](#http_call) with \"POST\" as the first argument.","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"post","longname":"HTTP.post","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062590","___s":true,"options":[],"locus":"Anywhere"},"put":{"meta":{"range":[2535,2644],"filename":"httpcall_common.js","lineno":66,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345735","name":"HTTP.put","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Send an HTTP `PUT` request. Equivalent to calling [`HTTP.call`](#http_call) with \"PUT\" as the first argument.","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"put","longname":"HTTP.put","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062591","___s":true,"options":[],"locus":"Anywhere"},"del":{"meta":{"range":[3135,3247],"filename":"httpcall_common.js","lineno":77,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100345760","name":"HTTP.del","type":"FunctionExpression","value":"function","paramnames":[]}},"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`)","params":[{"type":{"names":["String"]},"description":"

The URL to which the request should be sent.

","name":"url"},{"type":{"names":["Object"]},"optional":true,"description":"

Options passed on to HTTP.call.

","name":"callOptions"},{"type":{"names":["function"]},"optional":true,"description":"

Callback that is called when the request is completed. Required on the client.

","name":"asyncCallback"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"del","longname":"HTTP.del","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R062592","___s":true,"options":[],"locus":"Anywhere"}},"ReactiveVar#get":{"meta":{"range":[2724,2837],"filename":"reactive-var.js","lineno":62,"path":"/Users/sashko/git/meteor/packages/reactive-var","code":{"id":"astnode100461309","name":"ReactiveVar.prototype.get","type":"FunctionExpression","value":"function","paramnames":[]}},"summary":"Returns the current value of the ReactiveVar, establishing a reactive dependency.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"name":"get","longname":"ReactiveVar#get","kind":"function","memberof":"ReactiveVar","scope":"instance","___id":"T000002R072876","___s":true,"options":[],"params":[],"locus":"Client"},"ReactiveVar#set":{"meta":{"range":[3040,3290],"filename":"reactive-var.js","lineno":74,"path":"/Users/sashko/git/meteor/packages/reactive-var","code":{"id":"astnode100461333","name":"ReactiveVar.prototype.set","type":"FunctionExpression","value":"function","paramnames":["newValue"]},"vars":{"oldValue":null,"this.curValue":null}},"summary":"Sets the current value of the ReactiveVar, invalidating the Computations that called `get` if `newValue` is different from the old value.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["Any"]},"name":"newValue"}],"name":"set","longname":"ReactiveVar#set","kind":"function","memberof":"ReactiveVar","scope":"instance","___id":"T000002R072877","___s":true,"options":[],"locus":"Client"},"Session":{"set":{"meta":{"range":[126,546],"filename":"session.js","lineno":6,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"set","summary":"Set a variable in the session. Notify any listeners that the value has changed (eg: redraw templates, and rerun any [`Tracker.autorun`](#tracker_autorun) computations, that called [`Session.get`](#session_get) on this `key`.)","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The key to set, eg, selectedItem

","name":"key"},{"type":{"names":["EJSONable","undefined"]},"description":"

The new value for key

","name":"value"}],"scope":"static","longname":"Session.set","___id":"T000002R073023","___s":true,"options":[],"locus":"Client"},"setDefault":{"meta":{"range":[548,866],"filename":"session.js","lineno":15,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"setDefault","summary":"Set a variable in the session if it is undefined. Otherwise works exactly the same as [`Session.set`](#session_set).","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The key to set, eg, selectedItem

","name":"key"},{"type":{"names":["EJSONable","undefined"]},"description":"

The new value for key

","name":"value"}],"scope":"static","longname":"Session.setDefault","___id":"T000002R073024","___s":true,"options":[],"locus":"Client"},"get":{"meta":{"range":[868,1359],"filename":"session.js","lineno":24,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"get","summary":"Get the value of a session variable. If inside a [reactive computation](#reactivity), invalidate the computation the next time the value of the variable is changed by [`Session.set`](#session_set). This returns a clone of the session value, so if it's an object or an array, mutating the returned value has no effect on the value stored in the session.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The name of the session variable to return

","name":"key"}],"scope":"static","longname":"Session.get","___id":"T000002R073025","___s":true,"options":[],"locus":"Client"},"equals":{"meta":{"range":[1361,1770],"filename":"session.js","lineno":32,"path":"/Users/sashko/git/meteor/packages/session","code":{}},"memberof":"Session","kind":"function","name":"equals","summary":"Test if a session variable is equal to a value. If inside a [reactive computation](#reactivity), invalidate the computation the next time the variable changes to or from the value.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"params":[{"type":{"names":["String"]},"description":"

The name of the session variable to test

","name":"key"},{"type":{"names":["String","Number","Boolean","null","undefined"]},"description":"

The value to test against

","name":"value"}],"scope":"static","longname":"Session.equals","___id":"T000002R073026","___s":true,"options":[],"locus":"Client"}},"PackageAPI#imply":{"meta":{"range":[39345,40289],"filename":"package-source.js","lineno":1008,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100601137","name":"imply","type":"FunctionExpression","value":"function"},"vars":{"names":null,"arch":null,"i":null,"name":null,"parsed":null,"":null}},"memberof":"PackageAPI","summary":"Give users of this package access to another package (by passing in the string `packagename`) or a collection of packages (by passing in an array of strings [`packagename1`, `packagename2`]","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"scope":"instance","params":[{"type":{"names":["String","Array."]},"description":"

Name of a package, or array of package names, with an optional @version component for each.

","name":"packagespec"}],"name":"imply","longname":"PackageAPI#imply","kind":"function","___id":"T000002R082955","___s":true,"options":[],"locus":"package.js"},"PackageAPI#addFiles":{"meta":{"range":[40999,41416],"filename":"package-source.js","lineno":1048,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100601226","name":"addFiles","type":"FunctionExpression","value":"function"},"vars":{"paths":null,"arch":null,"":null}},"memberof":"PackageAPI","scope":"instance","summary":"Specify the source code for your package.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"params":[{"type":{"names":["String","Array."]},"description":"

Name of the source file, or array of strings of source file names.

","name":"filename"},{"type":{"names":["String"]},"optional":true,"description":"

If you only want to export the file on the server (or the client), you can pass in the second argument (e.g., 'server' or 'client') to specify what architecture the file is used with.

","name":"architecture"}],"name":"addFiles","longname":"PackageAPI#addFiles","kind":"function","___id":"T000002R082964","___s":true,"options":[],"locus":"package.js"},"initFromPackageDir~api":{"versionsFrom":{"meta":{"range":[42384,43916],"filename":"package-source.js","lineno":1071,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100601282","name":"versionsFrom","type":"FunctionExpression","value":"function"},"vars":{"release":null,"relInf":null,"releaseRecord":null}},"summary":"Use versions of core packages from a release. Unless provided, all packages will default to the versions released along with `meteorversion`. This will save you from having to figure out the exact versions of the core packages you want to use. For example, if the newest release of meteor is METEOR@0.9.0 and it uses jquery@1.0.0, you can use `api.versionsFrom('METEOR@0.9.0')`. If your package uses jQuery, it will automatically depend on jQuery 1.0.0 when it is published.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"params":[{"type":{"names":["String"]},"description":"

Specification of a release: track@version. Just 'version' (ex: "0.9.0") is sufficient if using the default release track

","name":"meteorRelease"}],"name":"versionsFrom","longname":"initFromPackageDir~api.versionsFrom","kind":"function","memberof":"initFromPackageDir~api","scope":"static","___id":"T000002R082970","___s":true,"options":[],"locus":"package.js"},"export":{"meta":{"range":[44783,45677],"filename":"package-source.js","lineno":1123,"path":"/Users/sashko/git/meteor/tools","code":{"id":"astnode100601387","name":"export","type":"FunctionExpression","value":"function"},"vars":{"options":null,"arch":null,"symbols":null,"":null}},"summary":"Export package-level variables in your package. The specified variables (declared without `var` in the source code) will be available to packages that use this package.","tags":[{"originalTitle":"locus","title":"locus","text":"package.js","value":"package.js"}],"params":[{"type":{"names":["String"]},"description":"

Name of the object.

","name":"exportedObject"},{"type":{"names":["String"]},"optional":true,"description":"

If you only want to export the object on the server (or the client), you can pass in the second argument (e.g., 'server' or 'client') to specify what architecture the export is used with.

","name":"architecture"}],"name":"export","longname":"initFromPackageDir~api.export","kind":"function","memberof":"initFromPackageDir~api","scope":"static","___id":"T000002R082976","___s":true,"options":[],"locus":"package.js"}},"Subscription":{"meta":{"range":[27224,27324],"filename":"livedata_server.js","lineno":853,"path":"/Users/sashko/git/meteor/packages/ddp","code":{}},"summary":"The server's side of a subscription","kind":"class","name":"Subscription","tags":[{"originalTitle":"instanceName","title":"instancename","text":"this","value":"this"}],"longname":"Subscription","___id":"T000002R052734","___s":true,"options":[],"params":[],"instancename":"this"},"ReactiveVar":{"meta":{"range":[1971,2247],"filename":"reactive-var.js","lineno":37,"path":"/Users/sashko/git/meteor/packages/reactive-var","code":{"id":"astnode100461231","name":"ReactiveVar","type":"FunctionExpression","value":"function","paramnames":["initialValue","equalsFunc"]},"vars":{"this.curValue":null,"this.equalsFunc":null,"this.dep":null}},"kind":"class","tags":[{"originalTitle":"instanceName","title":"instancename","text":"reactiveVar","value":"reactiveVar"},{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"summary":"Constructor for a ReactiveVar, which represents a single reactive variable.","params":[{"type":{"names":["Any"]},"description":"

The initial value to set. equalsFunc is ignored when setting the initial value.

","name":"initialValue"},{"type":{"names":["function"]},"optional":true,"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"}],"name":"ReactiveVar","longname":"ReactiveVar","scope":"global","___id":"T000002R072869","___s":true,"options":[],"instancename":"reactiveVar","locus":"Client"},"PackageAPI":{"meta":{"range":[35130,35288],"filename":"package-source.js","lineno":913,"path":"/Users/sashko/git/meteor/tools","code":{}},"kind":"class","name":"PackageAPI","tags":[{"originalTitle":"instanceName","title":"instancename","text":"api","value":"api"}],"scope":"global","summary":"The API object passed into the Packages.onUse function.","longname":"PackageAPI","___id":"T000002R082938","___s":true,"options":[],"params":[],"instancename":"api"}}; \ No newline at end of file diff --git a/docs/client/names.json b/docs/client/names.json index 0ae4bdc582..87195204ee 100644 --- a/docs/client/names.json +++ b/docs/client/names.json @@ -119,6 +119,8 @@ "Package.onTest", "Package.onUse", "PackageAPI", + "PackageAPI#addFiles", + "PackageAPI#imply", "ReactiveVar", "ReactiveVar#get", "ReactiveVar#set", @@ -164,5 +166,7 @@ "Tracker.currentComputation", "Tracker.flush", "Tracker.nonreactive", - "Tracker.onInvalidate" + "Tracker.onInvalidate", + "initFromPackageDir~api.export", + "initFromPackageDir~api.versionsFrom" ] \ No newline at end of file diff --git a/tools/package-source.js b/tools/package-source.js index fbf165c6fe..b2de6e71fe 100644 --- a/tools/package-source.js +++ b/tools/package-source.js @@ -913,6 +913,7 @@ _.extend(PackageSource.prototype, { /** * @class PackageAPI * @instanceName api + * @global * @summary The API object passed into the Packages.onUse function. */ var api = { @@ -996,6 +997,14 @@ _.extend(PackageSource.prototype, { // Called when this package wants packages using it to also use // another package. eg, for umbrella packages which want packages // using them to also get symbols or plugins from their components. + + /** + * @memberOf PackageAPI + * @summary Give users of this package access to another package (by passing in the string `packagename`) or a collection of packages (by passing in an array of strings [`packagename1`, `packagename2`] + * @locus package.js + * @instance + * @param {String|String[]} packagespec Name of a package, or array of package names, with an optional @version component for each. + */ imply: function (names, arch) { names = toArray(names); arch = toArchArray(arch); @@ -1027,6 +1036,15 @@ _.extend(PackageSource.prototype, { // Top-level call to add a source file to a package. It will // be processed according to its extension (eg, *.coffee // files will be compiled to JavaScript). + + /** + * @memberOf PackageAPI + * @instance + * @summary Specify the source code for your package. + * @locus package.js + * @param {String|String[]} filename Name of the source file, or array of strings of source file names. + * @param {String} [architecture] If you only want to export the file on the server (or the client), you can pass in the second argument (e.g., 'server' or 'client') to specify what architecture the file is used with. + */ addFiles: function (paths, arch, fileOptions) { paths = toArray(paths); arch = toArchArray(arch); @@ -1044,6 +1062,12 @@ _.extend(PackageSource.prototype, { // Use this release to resolve unclear dependencies for this package. If // you don't fill in dependencies for some of your implies/uses, we will // look at the packages listed in the release to figure that out. + + /** + * @summary Use versions of core packages from a release. Unless provided, all packages will default to the versions released along with `meteorversion`. This will save you from having to figure out the exact versions of the core packages you want to use. For example, if the newest release of meteor is METEOR@0.9.0 and it uses jquery@1.0.0, you can use `api.versionsFrom('METEOR@0.9.0')`. If your package uses jQuery, it will automatically depend on jQuery 1.0.0 when it is published. + * @locus package.js + * @param {String} meteorRelease Specification of a release: track@version. Just 'version' (ex: `"0.9.0"`) is sufficient if using the default release track + */ versionsFrom: function (release) { if (releaseRecord) { buildmessage.error("api.versionsFrom may only be specified once.", @@ -1089,6 +1113,13 @@ _.extend(PackageSource.prototype, { // or an array of those. // The default is ['web', 'server']. // @param options 'testOnly', boolean. + + /** + * @summary Export package-level variables in your package. The specified variables (declared without `var` in the source code) will be available to packages that use this package. + * @locus package.js + * @param {String} exportedObject Name of the object. + * @param {String} [architecture] If you only want to export the object on the server (or the client), you can pass in the second argument (e.g., 'server' or 'client') to specify what architecture the export is used with. + */ export: function (symbols, arch, options) { // Support `api.export("FooTest", {testOnly: true})` without // arch.