github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
2b680d087cd2bb6cb8a70fadd850b044e9fe0d34
meteor/docs/client/data.js
Sashko Stubailo 5458c985f5 Run JSDoc to update API and names.json
2014-08-27 20:25:35 -07:00

2 lines
107 KiB
JavaScript
Raw Blame History

// 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":"T000002R000046","___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":"astnode100017007","name":"Accounts.ui","type":"ObjectExpression","value":"{}","paramnames":[]}},"summary":"Accounts UI","kind":"namespace","memberof":"Accounts","name":"ui","longname":"Accounts.ui","scope":"static","___id":"T000002R001212","___s":true,"config":{"meta":{"range":[1184,3840],"filename":"accounts_ui.js","lineno":25,"path":"/Users/sashko/git/meteor/packages/accounts-ui-unstyled","code":{"id":"astnode100017027","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":"T000002R001217","___s":true,"options":[{"type":{"names":["Object"]},"description":"<p>Which <a href=\"#requestpermissions\">permissions</a> to request from the user for each external service.</p>","name":"requestPermissions"},{"type":{"names":["Object"]},"description":"<p>To ask the user for permission to act on their behalf when offline, map the relevant external service to <code>true</code>. Currently only supported with Google. See <a href=\"#meteor_loginwithexternalservice\">Meteor.loginWithExternalService</a> for more details.</p>","name":"requestOfflineToken"},{"type":{"names":["Boolean"]},"description":"<p>If true, forces the user to approve the app's permissions, even if previously approved. Currently only supported with Google.</p>","name":"forceApprovalPrompt"},{"type":{"names":["String"]},"description":"<p>Which fields to display in the user creation form. One of '<code>USERNAME_AND_EMAIL</code>', '<code>USERNAME_AND_OPTIONAL_EMAIL</code>', '<code>USERNAME_ONLY</code>', or '<code>EMAIL_ONLY</code>' (default).</p>","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":"astnode100007962","name":"Accounts.emailTemplates","type":"ObjectExpression","value":"{\"from\":\"Meteor Accounts <no-reply@meteor.com>\",\"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":"T000002R000644","___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":"astnode100000619","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":"T000002R000053","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"<p>New users with an email address will receive an address verification email.</p>","name":"sendVerificationEmail"},{"type":{"names":["Boolean"]},"description":"<p>Calls to <a href=\"#accounts_createuser\"><code>createUser</code></a> from the client will be rejected. In addition, if you are using <a href=\"#accountsui\">accounts-ui</a>, the &quot;Create account&quot; link will not be available.</p>","name":"forbidClientAccountCreation"},{"type":{"names":["String","function"]},"description":"<p>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: <code>Accounts.config({ restrictCreationByEmailDomain: 'school.edu' })</code>.</p>","name":"restrictCreationByEmailDomain"},{"type":{"names":["Number"]},"description":"<p>The number of days from when a user logs in until their token expires and they are logged out. Defaults to 90. Set to <code>null</code> to disable login expiration.</p>","name":"loginExpirationInDays"},{"type":{"names":["String"]},"description":"<p>When using the <code>oauth-encryption</code> 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.</p>","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":"astnode100001075","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":"<p>Called whenever a login is attempted (either successful or unsuccessful). A login can be aborted by returning a falsy value or throwing an exception.</p>","name":"func"}],"name":"validateLoginAttempt","longname":"Accounts.validateLoginAttempt","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000086","___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":"astnode100001089","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":"<p>The callback to be called when login is successful.</p>","name":"func"}],"name":"onLogin","longname":"Accounts.onLogin","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000087","___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":"astnode100001103","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":"<p>The callback to be called after the login has failed.</p>","name":"func"}],"name":"onLoginFailure","longname":"Accounts.onLoginFailure","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000088","___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":"astnode100003117","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":"<p>Called whenever a new user is created. Return the new user object, or throw an <code>Error</code> to abort the creation.</p>","name":"func"}],"name":"onCreateUser","longname":"Accounts.onCreateUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000294","___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":"astnode100003340","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":"<p>Called whenever a new user is created. Takes the new user object, and returns true to allow the creation or false to abort.</p>","name":"func"}],"name":"validateNewUser","longname":"Accounts.validateNewUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000310","___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":"astnode100009903","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":"<p>Client only, optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","name":"callback"}],"name":"createUser","longname":"Accounts.createUser","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000734","___s":true,"options":[{"type":{"names":["String"]},"description":"<p>A unique name for this user.</p>","name":"username"},{"type":{"names":["String"]},"description":"<p>The user's email address.</p>","name":"email"},{"type":{"names":["String"]},"description":"<p>The user's password. This is <strong>not</strong> sent in plain text over the wire.</p>","name":"password"},{"type":{"names":["Object"]},"description":"<p>The user's profile, typically including the <code>name</code> field.</p>","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":"astnode100009970","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":"<p>The user's current password. This is <strong>not</strong> sent in plain text over the wire.</p>","name":"oldPassword"},{"type":{"names":["String"]},"description":"<p>A new password for the user. This is <strong>not</strong> sent in plain text over the wire.</p>","name":"newPassword"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","name":"callback"}],"name":"changePassword","longname":"Accounts.changePassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000740","___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":"astnode100010111","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":"<p>Optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","name":"callback"}],"name":"forgotPassword","longname":"Accounts.forgotPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000745","___s":true,"options":[{"type":{"names":["String"]},"description":"<p>The email address to send a password reset link.</p>","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":"astnode100010139","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":"<p>The token retrieved from the reset password URL.</p>","name":"token"},{"type":{"names":["String"]},"description":"<p>A new password for the user. This is <strong>not</strong> sent in plain text over the wire.</p>","name":"newPassword"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","name":"callback"}],"name":"resetPassword","longname":"Accounts.resetPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000746","___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":"astnode100010189","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":"<p>The token retrieved from the verification URL.</p>","name":"token"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","name":"callback"}],"name":"verifyEmail","longname":"Accounts.verifyEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000750","___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":"astnode100011068","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":"<p>The id of the user to update.</p>","name":"userId"},{"type":{"names":["String"]},"description":"<p>A new password for the user.</p>","name":"newPassword"}],"name":"setPassword","longname":"Accounts.setPassword","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000827","___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":"astnode100011172","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":"<p>The id of the user to send email to.</p>","name":"userId"},{"type":{"names":["String"]},"optional":true,"description":"<p>Optional. Which address of the user's to send the email to. This address must be in the user's <code>emails</code> list. Defaults to the first email in the list.</p>","name":"email"}],"name":"sendResetPasswordEmail","longname":"Accounts.sendResetPasswordEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000838","___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":"astnode100011367","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":"<p>The id of the user to send email to.</p>","name":"userId"},{"type":{"names":["String"]},"optional":true,"description":"<p>Optional. Which address of the user's to send the email to. This address must be in the user's <code>emails</code> list. Defaults to the first email in the list.</p>","name":"email"}],"name":"sendEnrollmentEmail","longname":"Accounts.sendEnrollmentEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000857","___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":"astnode100011779","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":"<p>The id of the user to send email to.</p>","name":"userId"},{"type":{"names":["String"]},"optional":true,"description":"<p>Optional. Which address of the user's to send the email to. This address must be in the user's <code>emails</code> list. Defaults to the first unverified email in the list.</p>","name":"email"}],"name":"sendVerificationEmail","longname":"Accounts.sendVerificationEmail","kind":"function","memberof":"Accounts","scope":"static","___id":"T000002R000899","___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":"T000002R065579","___s":true,"users":{"comment":"/**\n * @summary A [Meteor.Collection](#collections) containing user documents.\n * @locus Anywhere\n */","meta":{"range":[6938,7089],"filename":"accounts_common.js","lineno":140,"path":"/Users/sashko/git/meteor/packages/accounts-base","code":{"id":"astnode100000816","name":"Meteor.users","type":"NewExpression","paramnames":[]}},"summary":"A [Meteor.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":"T000002R000060","___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":"astnode100379162","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":"T000002R065581","___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":"astnode100379164","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":"T000002R065582","___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":"astnode100379177","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":"T000002R065583","___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":"astnode100381531","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":"T000002R065742","___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":"<p>Optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","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":"<p>Optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","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":"astnode100009710","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":"<p>Either a string interpreted as a username or an email; or an object with a single key: <code>email</code>, <code>username</code> or <code>id</code>.</p>","name":"user"},{"type":{"names":["String"]},"description":"<p>The user's password.</p>","name":"password"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional callback. Called with no arguments on success, or with a single <code>Error</code> argument on failure.</p>","name":"callback"}],"name":"loginWithPassword","longname":"Meteor.loginWithPassword","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R000711","___s":true,"options":[],"locus":"Client"},"status":{"meta":{"range":[36013,36142],"filename":"livedata_connection.js","lineno":935,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100348972","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":"T000002R063060","___s":true,"options":[],"params":[],"locus":"Client"},"reconnect":{"meta":{"range":[36364,36499],"filename":"livedata_connection.js","lineno":947,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100348992","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":"T000002R063062","___s":true,"options":[],"params":[],"locus":"Client"},"disconnect":{"meta":{"range":[36610,36747],"filename":"livedata_connection.js","lineno":957,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100349012","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":"T000002R063064","___s":true,"options":[],"params":[],"locus":"Client"},"onConnection":{"meta":{"range":[42780,42881],"filename":"livedata_server.js","lineno":1298,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363588","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":"<p>The function to call when a new DDP connection is established.</p>","name":"callback"}],"memberof":"Meteor","name":"onConnection","longname":"Meteor.onConnection","kind":"function","scope":"static","___id":"T000002R064390","___s":true,"options":[],"locus":"Server"},"publish":{"meta":{"range":[45712,47678],"filename":"livedata_server.js","lineno":1370,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363757","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":"<p>Name of the record set. If <code>null</code>, the set has no name, and the record set is automatically sent to all connected clients.</p>","name":"name"},{"type":{"names":["function"]},"description":"<p>Function called on the server each time a client subscribes. Inside the function, <code>this</code> is the publish handler object, described below. If the client passed arguments to <code>subscribe</code>, the function is called with the same arguments.</p>","name":"func"}],"name":"publish","longname":"Meteor.publish","kind":"function","scope":"static","___id":"T000002R064401","___s":true,"options":[],"locus":"Server"},"methods":{"meta":{"range":[48062,48324],"filename":"livedata_server.js","lineno":1435,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363917","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":"<p>Dictionary whose keys are method names and values are functions.</p>","name":"methods"}],"memberof":"Meteor","name":"methods","longname":"Meteor.methods","kind":"function","scope":"static","___id":"T000002R064408","___s":true,"options":[],"locus":"Anywhere"},"startup":{"meta":{"range":[651,1018],"filename":"startup_client.js","lineno":27,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100383462","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":"<p>A function to run on startup.</p>","name":"func"}],"name":"startup","longname":"Meteor.startup","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R065939","___s":true,"options":[],"locus":"Anywhere"},"setTimeout":{"meta":{"range":[969,1082],"filename":"timers.js","lineno":28,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100383625","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":"<p>The function to run</p>","name":"func"},{"type":{"names":["Number"]},"description":"<p>Number of milliseconds to wait before calling function</p>","name":"delay"}],"name":"setTimeout","longname":"Meteor.setTimeout","kind":"function","scope":"static","___id":"T000002R065945","___s":true,"options":[],"locus":"Anywhere"},"setInterval":{"meta":{"range":[1351,1467],"filename":"timers.js","lineno":39,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100383638","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":"<p>The function to run</p>","name":"func"},{"type":{"names":["Number"]},"description":"<p>Number of milliseconds to wait between each function call.</p>","name":"delay"}],"name":"setInterval","longname":"Meteor.setInterval","kind":"function","scope":"static","___id":"T000002R065946","___s":true,"options":[],"locus":"Anywhere"},"clearInterval":{"meta":{"range":[1677,1738],"filename":"timers.js","lineno":49,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100383651","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":"<p>The handle returned by <code>Meteor.setInterval</code></p>","name":"id"}],"name":"clearInterval","longname":"Meteor.clearInterval","kind":"function","scope":"static","___id":"T000002R065947","___s":true,"options":[],"locus":"Anywhere"},"clearTimeout":{"meta":{"range":[1936,1995],"filename":"timers.js","lineno":59,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100383659","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":"<p>The handle returned by <code>Meteor.setTimeout</code></p>","name":"id"}],"name":"clearTimeout","longname":"Meteor.clearTimeout","kind":"function","scope":"static","___id":"T000002R065948","___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":"astnode100383771","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":"<p>A path to append to the root URL. Do not include a leading &quot;<code>/</code>&quot;.</p>","name":"path"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"absoluteUrl","longname":"Meteor.absoluteUrl","kind":"function","memberof":"Meteor","scope":"static","___id":"T000002R065955","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"<p>Create an HTTPS URL.</p>","name":"secure"},{"type":{"names":["Boolean"]},"description":"<p>Replace localhost with 127.0.0.1. Useful for services that don't recognize localhost as a domain name.</p>","name":"replaceLocalhost"},{"type":{"names":["String"]},"description":"<p>Override the default ROOT_URL from the server environment. For example: &quot;<code>http://foo.example.com</code>&quot;</p>","name":"rootUrl"}],"locus":"Anywhere"},"Collection":{"Cursor#forEach":{"meta":{"range":[5061,5487],"filename":"minimongo.js","lineno":153,"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":"Meteor.Collection.Cursor","params":[{"type":{"names":["function"]},"description":"<p>Function to call. It will be called with three arguments: the document, a 0-based index, and <em>cursor</em> itself.</p>","name":"callback"},{"type":{"names":["Any"]},"optional":true,"description":"<p>An object which will be the value of <code>this</code> inside <code>callback</code>.</p>","name":"thisArg"}],"longname":"Meteor.Collection.Cursor#forEach","___id":"T000002R066268","___s":true,"options":[],"locus":"Anywhere"},"Cursor#map":{"meta":{"range":[6241,6642],"filename":"minimongo.js","lineno":194,"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":"Meteor.Collection.Cursor","params":[{"type":{"names":["function"]},"description":"<p>Function to call. It will be called with three arguments: the document, a 0-based index, and <em>cursor</em> itself.</p>","name":"callback"},{"type":{"names":["Any"]},"optional":true,"description":"<p>An object which will be the value of <code>this</code> inside <code>callback</code>.</p>","name":"thisArg"}],"longname":"Meteor.Collection.Cursor#map","___id":"T000002R066281","___s":true,"options":[],"locus":"Anywhere"},"Cursor#fetch":{"meta":{"range":[6867,7017],"filename":"minimongo.js","lineno":212,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Return all matching documents as an Array.","memberof":"Meteor.Collection.Cursor","kind":"function","name":"fetch","scope":"instance","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"longname":"Meteor.Collection.Cursor#fetch","___id":"T000002R066285","___s":true,"options":[],"params":[],"locus":"Anywhere"},"Cursor#count":{"meta":{"range":[7183,7342],"filename":"minimongo.js","lineno":228,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"Returns the number of documents that match a query.","memberof":"Meteor.Collection.Cursor","kind":"function","name":"count","scope":"instance","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"longname":"Meteor.Collection.Cursor#count","___id":"T000002R066289","___s":true,"options":[],"params":[],"locus":"Anywhere"},"Cursor#observe":{"meta":{"range":[10066,10190],"filename":"minimongo.js","lineno":310,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{"id":"astnode100388693","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":"Meteor.Collection.Cursor","scope":"instance","params":[{"type":{"names":["Object"]},"description":"<p>Functions to call to deliver the result set as it changes</p>","name":"callbacks"}],"name":"observe","longname":"Meteor.Collection.Cursor#observe","kind":"function","___id":"T000002R066303","___s":true,"options":[],"locus":"Anywhere"},"Cursor#observeChanges":{"meta":{"range":[10532,14485],"filename":"minimongo.js","lineno":322,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{"id":"astnode100388708","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":"Meteor.Collection.Cursor","scope":"instance","params":[{"type":{"names":["Object"]},"description":"<p>Functions to call to deliver the result set as it changes</p>","name":"callbacks"}],"name":"observeChanges","longname":"Meteor.Collection.Cursor#observeChanges","kind":"function","___id":"T000002R066305","___s":true,"options":[],"locus":"Anywhere"},"Cursor":{"meta":{"range":[2777,2964],"filename":"minimongo.js","lineno":89,"path":"/Users/sashko/git/meteor/packages/minimongo","code":{}},"summary":"To create a cursor, use find. To access the documents in a cursor, use forEach, map, or fetch.","kind":"class","name":"Cursor","memberof":"Meteor.Collection","tags":[{"originalTitle":"instanceName","title":"instancename","text":"cursor","value":"cursor"}],"scope":"static","longname":"Meteor.Collection.Cursor","___id":"T000002R066245","___s":true,"options":[],"params":[],"instancename":"cursor"},"meta":{"range":[1419,8435],"filename":"collection.js","lineno":20,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","code":{"id":"astnode100407274","name":"Meteor.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":"<p>The name of the collection. If null, creates an unmanaged (unsynchronized) local collection.</p>","name":"name"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"Collection","longname":"Meteor.Collection","memberof":"Meteor","scope":"static","___id":"T000002R068124","___s":true,"options":[{"type":{"names":["Object"]},"description":"<p>The server connection that will manage this collection. Uses the default connection if not specified. Pass the return value of calling <a href=\"#ddp_connect\"><code>DDP.connect</code></a> to specify a different server. Pass <code>null</code> to specify no connection. Unmanaged (<code>name</code> is null) collections cannot specify a connection.</p>","name":"connection"},{"type":{"names":["String"]},"description":"<p>The method of generating the <code>_id</code> fields of new documents in this collection. Possible values:</p>\n<ul>\n<li><strong><code>'STRING'</code></strong>: random strings</li>\n<li><strong><code>'MONGO'</code></strong>: random <a href=\"#collection_object_id\"><code>Meteor.Collection.ObjectID</code></a> values</li>\n</ul>\n<p>The default id generation technique is <code>'STRING'</code>.</p>","name":"idGeneration"},{"type":{"names":["function"]},"description":"<p>An optional transformation function. Documents will be passed through this function before being returned from <code>fetch</code> or <code>findOne</code>, and before being passed to callbacks of <code>observe</code>, <code>map</code>, <code>forEach</code>, <code>allow</code>, and <code>deny</code>. Transforms are <em>not</em> applied for the callbacks of <code>observeChanges</code> or to cursors returned from publish functions.</p>","name":"transform"}],"locus":"Anywhere","instancename":"collection","ObjectID":{"meta":{"range":[25535,25589],"filename":"collection.js","lineno":638,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","code":{"id":"astnode100409073","name":"Meteor.Collection.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":"<p>Optional. The 24-character hexadecimal contents of the ObjectID to create</p>","name":"hexString"}],"name":"ObjectID","longname":"Meteor.Collection.ObjectID","memberof":"Meteor.Collection","scope":"static","___id":"T000002R068249","___s":true,"options":[],"locus":"Anywhere"}},"Collection#insert":{"meta":{"range":[15926,16365],"filename":"collection.js","lineno":407,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","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":"Meteor.Collection","scope":"instance","params":[{"type":{"names":["Object"]},"description":"<p>The document to insert. May not yet have an _id attribute, in which case Meteor will generate one for you.</p>","name":"doc"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional. If present, called with an error object as the first argument and, if no error, the _id as the second.</p>","name":"callback"}],"longname":"Meteor.Collection#insert","___id":"T000002R068122","___s":true,"options":[],"locus":"Anywhere"},"Collection#update":{"meta":{"range":[16367,17137],"filename":"collection.js","lineno":417,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","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":"Meteor.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"description":"<p>Specifies which documents to modify</p>","name":"selector"},{"type":{"names":["MongoModifier"]},"description":"<p>Specifies how to modify the documents</p>","name":"modifier"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.</p>","name":"callback"}],"longname":"Meteor.Collection#update","___id":"T000002R068123","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"<p>True to modify all matching documents; false to only modify one of the matching documents (the default).</p>","name":"multi"},{"type":{"names":["Boolean"]},"description":"<p>True to insert a document if no matching documents are found.</p>","name":"upsert"}],"locus":"Anywhere"},"Collection#find":{"meta":{"range":[9195,10059],"filename":"collection.js","lineno":245,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","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":"Meteor.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"optional":true,"description":"<p>A query describing the documents to find</p>","name":"selector"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"longname":"Meteor.Collection#find","___id":"T000002R068174","___s":true,"options":[{"type":{"names":["MongoSortSpecifier"]},"description":"<p>Sort order (default: natural order)</p>","name":"sort"},{"type":{"names":["Number"]},"description":"<p>Number of results to skip at the beginning</p>","name":"skip"},{"type":{"names":["Number"]},"description":"<p>Maximum number of results to return</p>","name":"limit"},{"type":{"names":["MongoFieldSpecifier"]},"description":"<p>Dictionary of fields to return or exclude.</p>","name":"fields"},{"type":{"names":["Boolean"]},"description":"<p>(Client only) Default <code>true</code>; pass <code>false</code> to disable reactivity</p>","name":"reactive"},{"type":{"names":["function"]},"description":"<p>Overrides <code>transform</code> on the <a href=\"#collections\"><code>Collection</code></a> for this cursor. Pass <code>null</code> to disable transformation.</p>","name":"transform"}],"locus":"Anywhere"},"Collection#findOne":{"meta":{"range":[10479,11299],"filename":"collection.js","lineno":270,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","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":"Meteor.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"optional":true,"description":"<p>A query describing the documents to find</p>","name":"selector"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"longname":"Meteor.Collection#findOne","___id":"T000002R068178","___s":true,"options":[{"type":{"names":["MongoSortSpecifier"]},"description":"<p>Sort order (default: natural order)</p>","name":"sort"},{"type":{"names":["Number"]},"description":"<p>Number of results to skip at the beginning</p>","name":"skip"},{"type":{"names":["MongoFieldSpecifier"]},"description":"<p>Dictionary of fields to return or exclude.</p>","name":"fields"},{"type":{"names":["Boolean"]},"description":"<p>(Client only) Default true; pass false to disable reactivity</p>","name":"reactive"},{"type":{"names":["function"]},"description":"<p>Overrides <code>transform</code> on the <a href=\"#collections\"><code>Collection</code></a> for this cursor. Pass <code>null</code> to disable transformation.</p>","name":"transform"}],"locus":"Anywhere"},"Collection#remove":{"meta":{"range":[17139,17447],"filename":"collection.js","lineno":431,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","code":{}},"summary":"Remove documents from the collection","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"kind":"function","name":"remove","memberof":"Meteor.Collection","scope":"instance","params":[{"type":{"names":["MongoSelector"]},"description":"<p>Specifies which documents to remove</p>","name":"selector"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional. If present, called with an error object as its argument.</p>","name":"callback"}],"longname":"Meteor.Collection#remove","___id":"T000002R068205","___s":true,"options":[],"locus":"Anywhere"},"Collection#upsert":{"meta":{"range":[23713,24109],"filename":"collection.js","lineno":593,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","code":{"id":"astnode100408878","name":"Meteor.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":"<p>Specifies which documents to modify</p>","name":"selector"},{"type":{"names":["MongoModifier"]},"description":"<p>Specifies how to modify the documents</p>","name":"modifier"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional. If present, called with an error object as the first argument and, if no error, the number of affected documents as the second.</p>","name":"callback"}],"name":"upsert","longname":"Meteor.Collection#upsert","kind":"function","memberof":"Meteor.Collection","scope":"instance","___id":"T000002R068235","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"<p>True to modify all matching documents; false to only modify one of the matching documents (the default).</p>","name":"multi"}],"locus":"Anywhere"},"Collection#allow":{"meta":{"range":[29204,29310],"filename":"collection.js","lineno":727,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","code":{"id":"astnode100409262","name":"Meteor.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":"Meteor.Collection#allow","kind":"function","memberof":"Meteor.Collection","scope":"instance","___id":"T000002R068256","___s":true,"options":[{"type":{"names":["function"]},"name":"insert"},{"type":{"names":["function"]},"name":"update"},{"type":{"names":["function"]},"description":"<p>Functions that look at a proposed modification to the database and return true if it should be allowed.</p>","name":"remove"},{"type":{"names":["Array.<String>"]},"description":"<p>Optional performance enhancement. Limits the fields that will be fetched from the database for inspection by your <code>update</code> and <code>remove</code> functions.</p>","name":"fetch"},{"type":{"names":["function"]},"description":"<p>Overrides <code>transform</code> on the <a href=\"#collections\"><code>Collection</code></a>. Pass <code>null</code> to disable transformation.</p>","name":"transform"}],"locus":"Server"},"Collection#deny":{"meta":{"range":[29995,30099],"filename":"collection.js","lineno":741,"path":"/Users/sashko/git/meteor/packages/mongo-livedata","code":{"id":"astnode100409282","name":"Meteor.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":"Meteor.Collection#deny","kind":"function","memberof":"Meteor.Collection","scope":"instance","___id":"T000002R068257","___s":true,"options":[{"type":{"names":["function"]},"name":"insert"},{"type":{"names":["function"]},"name":"update"},{"type":{"names":["function"]},"description":"<p>Functions that look at a proposed modification to the database and return true if it should be denied, even if an <code>allow</code> rule says otherwise.</p>","name":"remove"},{"type":{"names":["Array.<String>"]},"description":"<p>Optional performance enhancement. Limits the fields that will be fetched from the database for inspection by your <code>update</code> and <code>remove</code> functions.</p>","name":"fetch"},{"type":{"names":["function"]},"description":"<p>Overrides <code>transform</code> on the <a href=\"#collections\"><code>Collection</code></a>. Pass <code>null</code> to disable transformation.</p>","name":"transform"}],"locus":"Server"},"Error":{"meta":{"range":[1911,3068],"filename":"errors.js","lineno":53,"path":"/Users/sashko/git/meteor/packages/meteor","code":{"id":"astnode100380441","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":"<p>A numeric error code, likely similar to an HTTP code (eg, 404, 500).</p>","name":"error"},{"type":{"names":["String"]},"optional":true,"description":"<p>Optional. A short human-readable summary of the error, like 'Not Found'.</p>","name":"reason"},{"type":{"names":["String"]},"optional":true,"description":"<p>Optional. Additional information about the error, like a textual stack trace.</p>","name":"details"}],"name":"Error","longname":"Meteor.Error","memberof":"Meteor","scope":"static","___id":"T000002R065656","___s":true,"options":[],"locus":"Anywhere"}},"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":[895,1097],"filename":"livedata_common.js","lineno":24,"path":"/Users/sashko/git/meteor/packages/livedata","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":"T000002R062810","___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":[1407,1600],"filename":"livedata_common.js","lineno":41,"path":"/Users/sashko/git/meteor/packages/livedata","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":"T000002R062814","___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":[1852,2166],"filename":"livedata_common.js","lineno":56,"path":"/Users/sashko/git/meteor/packages/livedata","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":"T000002R062817","___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/livedata","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":"T000002R064314","___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/livedata","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":"T000002R064326","___s":true,"locus":"Server"},"Template#created":{"comment":"/**\n * @summary Provide a callback when an instance of a template is created.\n * @locus Client\n * @memberOf Template\n * @name created\n * @instance\n */","meta":{"range":[4279,4442],"filename":"templating.js","lineno":140,"path":"/Users/sashko/git/meteor/packages/templating","code":{}},"summary":"Provide a callback when an instance of a template is created.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Template","name":"created","scope":"instance","longname":"Template#created","kind":"member","___id":"T000002R075179","___s":true,"locus":"Client"},"Template#rendered":{"comment":"/**\n * @summary Provide a callback when an instance of a template is rendered.\n * @locus Client\n * @memberOf Template\n * @name rendered\n * @instance\n */","meta":{"range":[4610,4775],"filename":"templating.js","lineno":154,"path":"/Users/sashko/git/meteor/packages/templating","code":{}},"summary":"Provide a callback when an instance of a template is rendered.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"memberof":"Template","name":"rendered","scope":"instance","longname":"Template#rendered","kind":"member","___id":"T000002R075180","___s":true,"locus":"Client"},"Template#destroyed":{"comment":"/**\n * @summary Provide a callback when an instance of a template is destroyed.\n * @locus Client\n * @instance\n * @name destroyed\n * @memberOf Template\n */","meta":{"range":[4946,5113],"filename":"templating.js","lineno":168,"path":"/Users/sashko/git/meteor/packages/templating","code":{}},"summary":"Provide a callback when an instance of a template is destroyed.","tags":[{"originalTitle":"locus","title":"locus","text":"Client","value":"Client"}],"scope":"instance","name":"destroyed","memberof":"Template","longname":"Template#destroyed","kind":"member","___id":"T000002R075181","___s":true,"locus":"Client"},"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":[412,434],"filename":"tracker.js","lineno":13,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100502979","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":"T000002R075968","___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`](#deps_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":[812,845],"filename":"tracker.js","lineno":21,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100502985","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`](#deps_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":"T000002R075969","___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":[4534,4689],"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":"T000002R075995","___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":[4773,4983],"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":"T000002R075997","___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":[5068,5320],"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":"T000002R075999","___s":true,"locus":"Client"},"Computation":{"meta":{"range":[4251,5750],"filename":"tracker.js","lineno":122,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503234","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":"T000002R075992","___s":true,"options":[],"params":[],"instancename":"computation"},"Computation#onInvalidate":{"meta":{"range":[6259,6593],"filename":"tracker.js","lineno":189,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503336","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":"<p>Function to be called on invalidation. Receives one argument, the computation that was invalidated.</p>","name":"callback"}],"name":"onInvalidate","longname":"Tracker.Computation#onInvalidate","kind":"function","memberof":"Tracker.Computation","scope":"instance","___id":"T000002R076009","___s":true,"options":[],"locus":"Client"},"Computation#invalidate":{"meta":{"range":[6739,7384],"filename":"tracker.js","lineno":210,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503388","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":"T000002R076011","___s":true,"options":[],"params":[],"locus":"Client"},"Computation#stop":{"meta":{"range":[7511,7639],"filename":"tracker.js","lineno":239,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503471","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":"T000002R076018","___s":true,"options":[],"params":[],"locus":"Client"},"Dependency#depend":{"meta":{"range":[9955,10397],"filename":"tracker.js","lineno":317,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503623","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":"<p>An optional computation declared to depend on <code>dependency</code> instead of the current computation.</p>","name":"fromComputation"}],"name":"depend","longname":"Tracker.Dependency#depend","kind":"function","memberof":"Tracker.Dependency","scope":"instance","___id":"T000002R076033","___s":true,"options":[],"locus":"Client"},"Dependency#changed":{"meta":{"range":[10565,10720],"filename":"tracker.js","lineno":342,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503696","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":"T000002R076038","___s":true,"options":[],"params":[],"locus":"Client"},"Dependency#hasDependents":{"meta":{"range":[10939,11089],"filename":"tracker.js","lineno":354,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503727","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":"T000002R076041","___s":true,"options":[],"params":[],"locus":"Client"},"flush":{"meta":{"range":[11265,12930],"filename":"tracker.js","lineno":367,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503753","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":"T000002R076044","___s":true,"options":[],"params":[],"locus":"Client"},"autorun":{"meta":{"range":[13554,13888],"filename":"tracker.js","lineno":438,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503875","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":"<p>The function to run. It receives one argument: the Computation object that will be returned.</p>","name":"runFunc"}],"name":"autorun","longname":"Tracker.autorun","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R076056","___s":true,"options":[],"locus":"Client"},"nonreactive":{"meta":{"range":[14319,14512],"filename":"tracker.js","lineno":465,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503925","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":"<p>A function to call immediately.</p>","name":"func"}],"name":"nonreactive","longname":"Tracker.nonreactive","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R076059","___s":true,"options":[],"locus":"Client"},"onInvalidate":{"meta":{"range":[14946,15131],"filename":"tracker.js","lineno":482,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503953","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":"<p>A callback function that will be invoked as <code>func(c)</code>, where <code>c</code> is the computation on which the callback is registered.</p>","name":"callback"}],"name":"onInvalidate","longname":"Tracker.onInvalidate","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R076061","___s":true,"options":[],"locus":"Client"},"afterFlush":{"meta":{"range":[15539,15625],"filename":"tracker.js","lineno":496,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503978","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":"<p>A function to call at flush time.</p>","name":"callback"}],"name":"afterFlush","longname":"Tracker.afterFlush","kind":"function","memberof":"Tracker","scope":"static","___id":"T000002R076062","___s":true,"options":[],"locus":"Client"},"Dependency":{"meta":{"range":[9045,9110],"filename":"tracker.js","lineno":297,"path":"/Users/sashko/git/meteor/packages/tracker","code":{"id":"astnode100503610","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":"T000002R076031","___s":true,"options":[],"params":[],"instancename":"dependency"}},"EJSON":{"newBinary":{"meta":{"range":[1470,1769],"filename":"base64.js","lineno":70,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100267124","name":"EJSON.newBinary","type":"FunctionExpression","value":"function","paramnames":["len"]},"vars":{"ret":null,"i":null,"ret.$Uint8ArrayPolyfill":null}},"summary":"Allocate a new buffer of binary data that EJSON can serialize.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["Number"]},"description":"<p>The number of bytes of binary data to allocate.</p>","name":"size"}],"name":"newBinary","longname":"EJSON.newBinary","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050748","___s":true,"options":[],"locus":"Anywhere"},"addType":{"meta":{"range":[1156,1321],"filename":"ejson.js","lineno":24,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100267974","name":"EJSON.addType","type":"FunctionExpression","value":"function","paramnames":["name","factory"]},"vars":{"customTypes[undefined]":null}},"summary":"Add a custom datatype to EJSON.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"<p>A tag for your custom type; must be unique among custom data types defined in your project, and must match the result of your type's <code>typeName</code> method.</p>","name":"name"},{"type":{"names":["function"]},"description":"<p>A function that deserializes a JSON-compatible value into an instance of your type. This should match the serialization performed by your type's <code>toJSONValue</code> method.</p>","name":"factory"}],"name":"addType","longname":"EJSON.addType","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050829","___s":true,"options":[],"locus":"Anywhere"},"toJSONValue":{"meta":{"range":[5932,6178],"filename":"ejson.js","lineno":193,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100268591","name":"EJSON.toJSONValue","type":"FunctionExpression","value":"function","paramnames":["item"]},"vars":{"changed":null,"item":null}},"summary":"Serialize an EJSON-compatible value into its plain JSON representation.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"<p>A value to serialize to plain JSON.</p>","name":"val"}],"name":"toJSONValue","longname":"EJSON.toJSONValue","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050879","___s":true,"options":[],"locus":"Anywhere"},"fromJSONValue":{"meta":{"range":[7910,8166],"filename":"ejson.js","lineno":262,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100268789","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":"<p>A value to deserialize into EJSON.</p>","name":"val"}],"name":"fromJSONValue","longname":"EJSON.fromJSONValue","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050890","___s":true,"options":[],"locus":"Anywhere"},"stringify":{"meta":{"range":[8794,9037],"filename":"ejson.js","lineno":283,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100268830","name":"EJSON.stringify","type":"FunctionExpression","value":"function","paramnames":["item","options"]},"vars":{"json":null}},"summary":"Serialize a value to a string.\n\nFor EJSON values, the serialization fully represents the value. For non-EJSON values, serializes the same way as `JSON.stringify`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"<p>A value to stringify.</p>","name":"val"},{"type":{"names":["Object"]},"optional":true,"name":"options"}],"name":"stringify","longname":"EJSON.stringify","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050893","___s":true,"options":[{"type":{"names":["Boolean","Integer","String"]},"description":"<p>Indents objects and arrays for easy readability. When <code>true</code>, indents by 2 spaces; when an integer, indents by that number of spaces; and when a string, uses the string as the indentation pattern.</p>","name":"indent"},{"type":{"names":["Boolean"]},"description":"<p>When <code>true</code>, stringifies keys in an object in sorted order.</p>","name":"canonical"}],"locus":"Anywhere"},"parse":{"meta":{"range":[9227,9404],"filename":"ejson.js","lineno":297,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100268872","name":"EJSON.parse","type":"FunctionExpression","value":"function","paramnames":["item"]}},"summary":"Parse a string into an EJSON value. Throws an error if the string is not valid EJSON.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"<p>A string to parse into an EJSON value.</p>","name":"str"}],"name":"parse","longname":"EJSON.parse","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050895","___s":true,"options":[],"locus":"Anywhere"},"isBinary":{"meta":{"range":[9595,9749],"filename":"ejson.js","lineno":308,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100268899","name":"EJSON.isBinary","type":"FunctionExpression","value":"function","paramnames":["obj"]}},"summary":"Returns true if `x` is a buffer of binary data, as returned from [`EJSON.newBinary`](#ejson_new_binary).","params":[{"type":{"names":["Object"]},"description":"<p>The variable to check.</p>","name":"x"}],"tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"name":"isBinary","longname":"EJSON.isBinary","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050896","___s":true,"options":[],"locus":"Anywhere"},"equals":{"meta":{"range":[10268,12522],"filename":"ejson.js","lineno":321,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100268924","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":"T000002R050897","___s":true,"options":[{"type":{"names":["Boolean"]},"description":"<p>Compare in key sensitive order, if supported by the JavaScript implementation. For example, <code>{a: 1, b: 2}</code> is equal to <code>{b: 2, a: 1}</code> only when <code>keyOrderSensitive</code> is <code>false</code>. The default is <code>false</code>.</p>","name":"keyOrderSensitive"}],"locus":"Anywhere"},"clone":{"meta":{"range":[12632,13898],"filename":"ejson.js","lineno":407,"path":"/Users/sashko/git/meteor/packages/ejson","code":{"id":"astnode100269311","name":"EJSON.clone","type":"FunctionExpression","value":"function","paramnames":["v"]},"vars":{"ret":null,"i":null,"ret[undefined]":null,"":null}},"summary":"Return a deep copy of `val`.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["EJSON"]},"description":"<p>A value to copy.</p>","name":"val"}],"name":"clone","longname":"EJSON.clone","kind":"function","memberof":"EJSON","scope":"static","___id":"T000002R050908","___s":true,"options":[],"locus":"Anywhere"}},"HTTP":{"call":{"meta":{"range":[1471,6304],"filename":"httpcall_client.js","lineno":17,"path":"/Users/sashko/git/meteor/packages/http","code":{"id":"astnode100305667","name":"HTTP.call","type":"FunctionExpression","value":"function","paramnames":["method","url","options","callback"]},"vars":{"callback":null,"options":null,"method":null,"headers":null,"content":null,"headers['Content-Type']":null,"params_for_url":null,"params_for_body":null,"query_match":null,"url":null,"username":null,"password":null,"colonLoc":null,"":null,"xhr":null,"k":null,"timed_out":null,"timer":null,"xhr.onreadystatechange":null}},"summary":"Perform an outbound HTTP request.","tags":[{"originalTitle":"locus","title":"locus","text":"Anywhere","value":"Anywhere"}],"params":[{"type":{"names":["String"]},"description":"<p>The <a href=\"http://en.wikipedia.org/wiki/HTTP_method\">HTTP method</a> to use, such as &quot;<code>GET</code>&quot;, &quot;<code>POST</code>&quot;, or &quot;<code>HEAD</code>&quot;.</p>","name":"method"},{"type":{"names":["String"]},"description":"<p>The URL to retrieve.</p>","name":"url"},{"type":{"names":["Object"]},"optional":true,"name":"options"},{"type":{"names":["function"]},"optional":true,"description":"<p>Optional callback. If passed, the method runs asynchronously, instead of synchronously, and calls asyncCallback. On the client, this callback is required.</p>","name":"asyncCallback"}],"name":"call","longname":"HTTP.call","kind":"function","memberof":"HTTP","scope":"static","___id":"T000002R059343","___s":true,"options":[{"type":{"names":["String"]},"description":"<p>String to use as the HTTP request body.</p>","name":"content"},{"type":{"names":["Object"]},"description":"<p>JSON-able object to stringify and use as the HTTP request body. Overwrites <code>content</code>.</p>","name":"data"},{"type":{"names":["String"]},"description":"<p>Query string to go in the URL. Overwrites any query string in <code>url</code>.</p>","name":"query"},{"type":{"names":["Object"]},"description":"<p>Dictionary of request parameters to be encoded and placed in the URL (for GETs) or request body (for POSTs). If <code>content</code> or <code>data</code> is specified, <code>params</code> will always be placed in the URL.</p>","name":"params"},{"type":{"names":["String"]},"description":"<p>HTTP basic authentication string of the form <code>&quot;username:password&quot;</code></p>","name":"auth"},{"type":{"names":["Object"]},"description":"<p>Dictionary of strings, headers to add to the HTTP request.</p>","name":"headers"},{"type":{"names":["Number"]},"description":"<p>Maximum time in milliseconds to wait for the request before failing. There is no timeout by default.</p>","name":"timeout"},{"type":{"names":["Boolean"]},"description":"<p>If <code>true</code>, transparently follow HTTP redirects. Cannot be set to <code>false</code> on the client. Default <code>true</code>.</p>","name":"followRedirects"}],"locus":"Anywhere"}},"MethodInvocation":{"meta":{"range":[372,2398],"filename":"livedata_common.js","lineno":13,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100346061","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":"T000002R062808","___s":true,"options":[],"instancename":"this"},"MethodInvocation#unblock":{"meta":{"range":[2642,2742],"filename":"livedata_common.js","lineno":79,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100346145","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":"T000002R062821","___s":true,"options":[],"params":[],"locus":"Server"},"MethodInvocation#setUserId":{"meta":{"range":[2964,3183],"filename":"livedata_common.js","lineno":92,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100346163","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":"<p>The value that should be returned by <code>userId</code> on this connection.</p>","name":"userId"}],"name":"setUserId","longname":"MethodInvocation#setUserId","kind":"function","___id":"T000002R062824","___s":true,"options":[],"locus":"Server"},"DDP":{"connect":{"meta":{"range":[58274,58419],"filename":"livedata_connection.js","lineno":1559,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100350915","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":"<p>The URL of another Meteor application.</p>","name":"url"}],"name":"connect","longname":"DDP.connect","kind":"function","memberof":"DDP","scope":"static","___id":"T000002R063179","___s":true,"options":[],"locus":"Anywhere"}},"Subscription#error":{"meta":{"range":[35098,35259],"filename":"livedata_server.js","lineno":1074,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363043","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":"<p>The error to pass to the client.</p>","name":"error"}],"scope":"instance","memberof":"Subscription","name":"error","longname":"Subscription#error","kind":"function","___id":"T000002R064350","___s":true,"options":[],"locus":"Server"},"Subscription#stop":{"meta":{"range":[35755,35903],"filename":"livedata_server.js","lineno":1092,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363068","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":"T000002R064352","___s":true,"options":[],"params":[],"locus":"Server"},"Subscription#onStop":{"meta":{"range":[36152,36306],"filename":"livedata_server.js","lineno":1106,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363091","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":"<p>The callback function</p>","name":"func"}],"name":"onStop","longname":"Subscription#onStop","kind":"function","___id":"T000002R064354","___s":true,"options":[],"locus":"Server"},"Subscription#added":{"meta":{"range":[37038,37338],"filename":"livedata_server.js","lineno":1131,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363134","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":"<p>The name of the collection that contains the new document.</p>","name":"collection"},{"type":{"names":["String"]},"description":"<p>The new document's ID.</p>","name":"id"},{"type":{"names":["Object"]},"description":"<p>The fields in the new document. If <code>_id</code> is present it is ignored.</p>","name":"fields"}],"name":"added","longname":"Subscription#added","kind":"function","___id":"T000002R064358","___s":true,"options":[],"locus":"Server"},"Subscription#changed":{"meta":{"range":[37986,38226],"filename":"livedata_server.js","lineno":1149,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363186","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":"<p>The name of the collection that contains the changed document.</p>","name":"collection"},{"type":{"names":["String"]},"description":"<p>The changed document's ID.</p>","name":"id"},{"type":{"names":["Object"]},"description":"<p>The fields in the document that have changed, together with their new values. If a field is not present in <code>fields</code> it was left unchanged; if it is present in <code>fields</code> and has a value of <code>undefined</code> it was removed from the document. If <code>_id</code> is present it is ignored.</p>","name":"fields"}],"name":"changed","longname":"Subscription#changed","kind":"function","___id":"T000002R064362","___s":true,"options":[],"locus":"Server"},"Subscription#removed":{"meta":{"range":[38601,39009],"filename":"livedata_server.js","lineno":1165,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363225","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":"<p>The name of the collection that the document has been removed from.</p>","name":"collection"},{"type":{"names":["String"]},"description":"<p>The ID of the document that has been removed.</p>","name":"id"}],"name":"removed","longname":"Subscription#removed","kind":"function","___id":"T000002R064365","___s":true,"options":[],"locus":"Server"},"Subscription#ready":{"meta":{"range":[39354,39646],"filename":"livedata_server.js","lineno":1182,"path":"/Users/sashko/git/meteor/packages/livedata","code":{"id":"astnode100363271","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":"T000002R064368","___s":true,"options":[],"params":[],"locus":"Server"},"Session":{"set":{"meta":{"range":[293,710],"filename":"session.js","lineno":12,"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`](#deps_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":"<p>The key to set, eg, <code>selectedItem</code></p>","name":"key"},{"type":{"names":["EJSONable","undefined"]},"description":"<p>The new value for <code>key</code></p>","name":"value"}],"scope":"static","longname":"Session.set","___id":"T000002R072307","___s":true,"options":[],"locus":"Client"},"setDefault":{"meta":{"range":[712,1030],"filename":"session.js","lineno":21,"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":"<p>The key to set, eg, <code>selectedItem</code></p>","name":"key"},{"type":{"names":["EJSONable","undefined"]},"description":"<p>The new value for <code>key</code></p>","name":"value"}],"scope":"static","longname":"Session.setDefault","___id":"T000002R072308","___s":true,"options":[],"locus":"Client"},"get":{"meta":{"range":[1032,1523],"filename":"session.js","lineno":30,"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":"<p>The name of the session variable to return</p>","name":"key"}],"scope":"static","longname":"Session.get","___id":"T000002R072309","___s":true,"options":[],"locus":"Client"},"equals":{"meta":{"range":[1525,1934],"filename":"session.js","lineno":38,"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":"<p>The name of the session variable to test</p>","name":"key"},{"type":{"names":["String","Number","Boolean","null","undefined"]},"description":"<p>The value to test against</p>","name":"value"}],"scope":"static","longname":"Session.equals","___id":"T000002R072313","___s":true,"options":[],"locus":"Client"}},"Template#helpers":{"meta":{"range":[720,813],"filename":"templating.js","lineno":25,"path":"/Users/sashko/git/meteor/packages/templating","code":{"id":"astnode100492577","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":"<p>Dictionary of helper functions by name.</p>","name":"helpers"}],"name":"helpers","longname":"Template#helpers","kind":"function","memberof":"Template","scope":"instance","___id":"T000002R075184","___s":true,"options":[],"locus":"Client"},"Template#events":{"meta":{"range":[2338,3039],"filename":"templating.js","lineno":85,"path":"/Users/sashko/git/meteor/packages/templating","code":{"id":"astnode100492785","name":"Template.prototype.events","type":"FunctionExpression","value":"function","paramnames":["eventMap"]},"vars":{"template":null,"template.__eventMaps":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":["Object.<String, function>"]},"description":"<p>Event handlers to associate with this template.</p>","name":"eventMap"}],"name":"events","longname":"Template#events","kind":"function","memberof":"Template","scope":"instance","___id":"T000002R075207","___s":true,"options":[],"locus":"Client"},"Subscription":{"meta":{"range":[27224,27324],"filename":"livedata_server.js","lineno":853,"path":"/Users/sashko/git/meteor/packages/livedata","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":"T000002R064310","___s":true,"options":[],"params":[],"instancename":"this"},"Template":{"meta":{"range":[301,382],"filename":"templating.js","lineno":9,"path":"/Users/sashko/git/meteor/packages/templating","code":{}},"summary":"Template \"class\"","kind":"class","name":"Template","tags":[{"originalTitle":"instanceName","title":"instancename","text":"template","value":"template"}],"longname":"Template","___id":"T000002R075183","___s":true,"options":[],"params":[],"instancename":"template"}};
Reference in New Issue View Git Blame Copy Permalink