Skip to content

Instantly share code, notes, and snippets.

@CarlQLange

CarlQLange/meteor.json

Created June 16, 2016 08:32
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save CarlQLange/8236a34c29ce3149bb38ca1f7dbac83a to your computer and use it in GitHub Desktop.
Save CarlQLange/8236a34c29ce3149bb38ca1f7dbac83a to your computer and use it in GitHub Desktop.
Download ZIP
Raw
meteor.json
{
"!name": "meteor",
"Match": {
"Any": "?",
"String": "?",
"Number": "?",
"Boolean": "?",
"undefined": "?",
"null": "?",
"Integer": "?",
"ObjectIncluding": "?",
"Object": "?",
"Optional": "fn(pattern: string)",
"OneOf": "fn()",
"Where": "fn(condition: bool)",
"test": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Returns true if the value matches the pattern.",
"!type": "fn(value, pattern: +MatchPattern)",
"!url": "https://docs.meteor.com/api/match_test"
}
},
"MeteorSubscribeHandle": {
"stop": "fn()",
"ready": "fn() -> bool"
},
"AccountsClient": {
"!data": {
"!locus": "Client"
},
"!doc": "Constructor for the `Accounts` object on the client.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/accountsclient",
"prototype": {
"config": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Set global accounts options.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/AccountsClient-config"
},
"loggingIn": {
"!data": {
"!locus": "Client"
},
"!doc": "True if a login method (such as `Meteor.loginWithPassword`, `Meteor.loginWithFacebook`, or `Accounts.createUser`) is currently in progress. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/accounts_loggingin"
},
"logout": {
"!data": {
"!locus": "Client"
},
"!doc": "Log the user out.",
"!type": "fn(callback?: fn())",
"!url": "https://docs.meteor.com/api/accounts_logout"
},
"logoutOtherClients": {
"!data": {
"!locus": "Client"
},
"!doc": "Log out other clients logged in as the current user, but does not log out the client that calls this function.",
"!type": "fn(callback?: fn())",
"!url": "https://docs.meteor.com/api/accounts_logoutotherclients"
},
"onLogin": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Register a callback to be called after a login attempt succeeds.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/AccountsClient-onLogin"
},
"onLoginFailure": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Register a callback to be called after a login attempt fails.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/AccountsClient-onLoginFailure"
},
"user": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user record, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/AccountsClient-user"
},
"userId": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user id, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/AccountsClient-userId"
}
}
},
"AccountsCommon": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Super-constructor for AccountsClient and AccountsServer.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/AccountsCommon",
"prototype": {
"config": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Set global accounts options.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/accounts_config"
},
"onLogin": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Register a callback to be called after a login attempt succeeds.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/accounts_onlogin"
},
"onLoginFailure": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Register a callback to be called after a login attempt fails.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/accounts_onloginfailure"
},
"user": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user record, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/accounts_user"
},
"userId": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user id, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/accounts_userid"
}
}
},
"AccountsServer": {
"!data": {
"!locus": "Server"
},
"!doc": "Constructor for the `Accounts` namespace on the server.",
"!type": "fn(server: ?)",
"!url": "https://docs.meteor.com/api/accountsserver",
"prototype": {
"config": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Set global accounts options.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/AccountsServer-config"
},
"onCreateUser": {
"!data": {
"!locus": "Server"
},
"!doc": "Customize new user creation.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/accounts_oncreateuser"
},
"onLogin": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Register a callback to be called after a login attempt succeeds.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/AccountsServer-onLogin"
},
"onLoginFailure": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Register a callback to be called after a login attempt fails.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/AccountsServer-onLoginFailure"
},
"user": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user record, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/AccountsServer-user"
},
"userId": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user id, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/AccountsServer-userId"
},
"validateLoginAttempt": {
"!data": {
"!locus": "Server"
},
"!doc": "Validate login attempts.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/accounts_validateloginattempt"
},
"validateNewUser": {
"!data": {
"!locus": "Server"
},
"!doc": "Set restrictions on new user creation.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/accounts_validatenewuser"
}
}
},
"Blaze": {
"Template": {
"!data": {
"!locus": "Client"
},
"!doc": "Constructor for a Template, which is used to construct Views with particular name and content.",
"!type": "fn(viewName?: string, renderFunction: fn())",
"!url": "https://docs.meteor.com/api/blaze_template"
},
"TemplateInstance": {
"!doc": "The class for template instances",
"!type": "fn(view: +Blaze.View)",
"!url": "https://docs.meteor.com/api/Blaze-TemplateInstance",
"prototype": {
"$": {
"!data": {
"!locus": "Client"
},
"!doc": "Find all elements matching `selector` in this template instance, and return them as a JQuery object.",
"!type": "fn(selector: string) -> [+DOMNode]",
"!url": "https://docs.meteor.com/api/template_$"
},
"autorun": {
"!data": {
"!locus": "Client"
},
"!doc": "A version of [Tracker.autorun](#tracker_autorun) that is stopped when the template is destroyed.",
"!type": "fn(runFunc: fn()) -> +Tracker.Computation",
"!url": "https://docs.meteor.com/api/template_autorun"
},
"data": {
"!data": {
"!locus": "Client"
},
"!doc": "The data context of this instance's latest invocation.",
"!url": "https://docs.meteor.com/api/template_data"
},
"find": {
"!data": {
"!locus": "Client"
},
"!doc": "Find one element matching `selector` in this template instance.",
"!type": "fn(selector: string) -> +DOMElement",
"!url": "https://docs.meteor.com/api/template_find"
},
"findAll": {
"!data": {
"!locus": "Client"
},
"!doc": "Find all elements matching `selector` in this template instance.",
"!type": "fn(selector: string) -> [+DOMElement]",
"!url": "https://docs.meteor.com/api/template_findAll"
},
"firstNode": {
"!data": {
"!locus": "Client"
},
"!doc": "The first top-level DOM node in this template instance.",
"!type": "+DOMNode",
"!url": "https://docs.meteor.com/api/template_firstNode"
},
"lastNode": {
"!data": {
"!locus": "Client"
},
"!doc": "The last top-level DOM node in this template instance.",
"!type": "+DOMNode",
"!url": "https://docs.meteor.com/api/template_lastNode"
},
"subscribe": {
"!data": {
"!locus": "Client"
},
"!doc": "A version of [Meteor.subscribe](#meteor_subscribe) that is stopped\nwhen the template is destroyed.",
"!type": "fn(name: string, arg1, arg2..., options?: fn()) -> +SubscriptionHandle",
"!url": "https://docs.meteor.com/api/Blaze-TemplateInstance-subscribe"
},
"subscriptionsReady": {
"!doc": "A reactive function that returns true when all of the subscriptions\ncalled with [this.subscribe](#TemplateInstance-subscribe) are ready.",
"!type": "fn() -> bool",
"!url": "https://docs.meteor.com/api/Blaze-TemplateInstance-subscriptionsReady"
},
"view": {
"!data": {
"!locus": "Client"
},
"!doc": "The [View](#blaze_view) object for this invocation of the template.",
"!type": "+Blaze.View",
"!url": "https://docs.meteor.com/api/template_view"
}
}
},
"View": {
"!data": {
"!locus": "Client"
},
"!doc": "Constructor for a View, which represents a reactive region of DOM.",
"!type": "fn(name?: string, renderFunction: fn())",
"!url": "https://docs.meteor.com/api/blaze_view"
},
"Each": {
"!data": {
"!locus": "Client"
},
"!doc": "Constructs a View that renders `contentFunc` for each item in a sequence.",
"!type": "fn(argFunc: fn(), contentFunc: fn(), elseFunc?: fn())",
"!url": "https://docs.meteor.com/api/blaze_each"
},
"If": {
"!data": {
"!locus": "Client"
},
"!doc": "Constructs a View that renders content conditionally.",
"!type": "fn(conditionFunc: fn(), contentFunc: fn(), elseFunc?: fn())",
"!url": "https://docs.meteor.com/api/blaze_if"
},
"Let": {
"!doc": "Constructs a View setting the local lexical scope in the block.",
"!type": "fn(bindings: fn(), contentFunc: fn())",
"!url": "https://docs.meteor.com/api/Blaze-Let"
},
"Unless": {
"!data": {
"!locus": "Client"
},
"!doc": "An inverted [`Blaze.If`](#blaze_if).",
"!type": "fn(conditionFunc: fn(), contentFunc: fn(), elseFunc?: fn())",
"!url": "https://docs.meteor.com/api/blaze_unless"
},
"With": {
"!data": {
"!locus": "Client"
},
"!doc": "Constructs a View that renders content with a data context.",
"!type": "fn(data: ?, contentFunc: fn())",
"!url": "https://docs.meteor.com/api/blaze_with"
},
"currentView": {
"!data": {
"!locus": "Client"
},
"!doc": "The View corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.",
"!type": "+Blaze.View",
"!url": "https://docs.meteor.com/api/blaze_currentview"
},
"getData": {
"!data": {
"!locus": "Client"
},
"!doc": "Returns the current data context, or the data context that was used when rendering a particular DOM element or View from a Meteor template.",
"!type": "fn(elementOrView?: +DOMElement)",
"!url": "https://docs.meteor.com/api/blaze_getdata"
},
"getView": {
"!data": {
"!locus": "Client"
},
"!doc": "Gets either the current View, or the View enclosing the given DOM element.",
"!type": "fn(element?: +DOMElement)",
"!url": "https://docs.meteor.com/api/blaze_getview"
},
"isTemplate": {
"!data": {
"!locus": "Client"
},
"!doc": "Returns true if `value` is a template object like `Template.myTemplate`.",
"!type": "fn(value)",
"!url": "https://docs.meteor.com/api/blaze_istemplate"
},
"remove": {
"!data": {
"!locus": "Client"
},
"!doc": "Removes a rendered View from the DOM, stopping all reactive updates and event listeners on it. Also destroys the Blaze.Template instance associated with the view.",
"!type": "fn(renderedView: +Blaze.View)",
"!url": "https://docs.meteor.com/api/blaze_remove"
},
"render": {
"!data": {
"!locus": "Client"
},
"!doc": "Renders a template or View to DOM nodes and inserts it into the DOM, returning a rendered [View](#blaze_view) which can be passed to [`Blaze.remove`](#blaze_remove).",
"!type": "fn(templateOrView: +Template, parentNode: +DOMNode, nextNode?: +DOMNode, parentView?: +Blaze.View)",
"!url": "https://docs.meteor.com/api/blaze_render"
},
"renderWithData": {
"!data": {
"!locus": "Client"
},
"!doc": "Renders a template or View to DOM nodes with a data context. Otherwise identical to `Blaze.render`.",
"!type": "fn(templateOrView: +Template, data: ?, parentNode: +DOMNode, nextNode?: +DOMNode, parentView?: +Blaze.View)",
"!url": "https://docs.meteor.com/api/blaze_renderwithdata"
},
"toHTML": {
"!data": {
"!locus": "Client"
},
"!doc": "Renders a template or View to a string of HTML.",
"!type": "fn(templateOrView: +Template)",
"!url": "https://docs.meteor.com/api/blaze_tohtml"
},
"toHTMLWithData": {
"!data": {
"!locus": "Client"
},
"!doc": "Renders a template or View to HTML with a data context. Otherwise identical to `Blaze.toHTML`.",
"!type": "fn(templateOrView: +Template, data: ?)",
"!url": "https://docs.meteor.com/api/blaze_tohtmlwithdata"
}
},
"CompileStep": {
"!doc": "The object passed into Plugin.registerSourceHandler",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/CompileStep",
"prototype": {
"addAsset": {
"!doc": "Add a file to serve as-is to the browser or to include on\nthe browser, depending on the target. On the web, it will be served\nat the exact path requested. For server targets, it can be retrieved\nusing `Assets.getText` or `Assets.getBinary`.",
"!type": "fn(options: ?, path: string, data: +Buffer)",
"!url": "https://docs.meteor.com/api/CompileStep-addAsset"
},
"addHtml": {
"!doc": "Works in web targets only. Add markup to the `head` or `body`\nsection of the document.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/CompileStep-addHtml"
},
"addJavaScript": {
"!doc": "Add JavaScript code. The code added will only see the\nnamespaces imported by this package as runtime dependencies using\n['api.use'](#PackageAPI-use). If the file being compiled was added\nwith the bare flag, the resulting JavaScript won't be wrapped in a\nclosure.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/CompileStep-addJavaScript"
},
"addStylesheet": {
"!doc": "Web targets only. Add a stylesheet to the document.",
"!type": "fn(options: ?, path: string, data: string, sourceMap: string)",
"!url": "https://docs.meteor.com/api/CompileStep-addStylesheet"
},
"arch": {
"!doc": "The architecture for which we are building. Can be \"os\",\n\"web.browser\", or \"web.cordova\".",
"!type": "string",
"!url": "https://docs.meteor.com/api/CompileStep-arch"
},
"declaredExports": {
"!doc": "The list of exports that the current package has defined.\nCan be used to treat those symbols differently during compilation.",
"!type": "?",
"!url": "https://docs.meteor.com/api/CompileStep-declaredExports"
},
"error": {
"!doc": "Display a build error.",
"!type": "fn(options: ?, message: string, sourcePath?: string, line: number, func: string)",
"!url": "https://docs.meteor.com/api/CompileStep-error"
},
"fileOptions": {
"!doc": "Any options passed to \"api.addFiles\".",
"!type": "?",
"!url": "https://docs.meteor.com/api/CompileStep-fileOptions"
},
"fullInputPath": {
"!doc": "The filename and absolute path of the input file.\nPlease don't use this filename to read the file from disk, instead\nuse [compileStep.read](CompileStep-read).",
"!type": "string",
"!url": "https://docs.meteor.com/api/CompileStep-fullInputPath"
},
"inputPath": {
"!doc": "The filename and relative path of the input file.\nPlease don't use this filename to read the file from disk, instead\nuse [compileStep.read](CompileStep-read).",
"!type": "string",
"!url": "https://docs.meteor.com/api/CompileStep-inputPath"
},
"inputSize": {
"!doc": "The total number of bytes in the input file.",
"!type": "number",
"!url": "https://docs.meteor.com/api/CompileStep-inputSize"
},
"packageName": {
"!doc": "The name of the package in which the file being built exists.",
"!type": "string",
"!url": "https://docs.meteor.com/api/CompileStep-packageName"
},
"pathForSourceMap": {
"!doc": "If you are generating a sourcemap for the compiled file, use\nthis path for the original file in the sourcemap.",
"!type": "string",
"!url": "https://docs.meteor.com/api/CompileStep-pathForSourceMap"
},
"read": {
"!doc": "Read from the input file. If `n` is specified, returns the\nnext `n` bytes of the file as a Buffer. XXX not sure if this actually\nreturns a String sometimes...",
"!type": "fn(n?: number) -> +Buffer",
"!url": "https://docs.meteor.com/api/CompileStep-read"
},
"rootOutputPath": {
"!doc": "On web targets, this will be the root URL prepended\nto the paths you pick for your output files. For example,\nit could be \"/packages/my-package\".",
"!type": "string",
"!url": "https://docs.meteor.com/api/CompileStep-rootOutputPath"
}
}
},
"EJSON": {
"CustomType": {
"!doc": "The interface that a class must satisfy to be able to become an\nEJSON custom type via EJSON.addType.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/EJSON-CustomType",
"prototype": {
"clone": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Return a value `r` such that `this.equals(r)` is true, and modifications to `r` do not affect `this` and vice versa.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/ejson_type_clone"
},
"equals": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Return `true` if `other` has a value equal to `this`; `false` otherwise.",
"!type": "fn(other: ?)",
"!url": "https://docs.meteor.com/api/ejson_type_equals"
},
"toJSONValue": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Serialize this instance into a JSON-compatible value.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/ejson_type_toJSONValue"
},
"typeName": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Return the tag used to identify this type. This must match the tag used to register this type with [`EJSON.addType`](#ejson_add_type).",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/ejson_type_typeName"
}
}
},
"addType": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Add a custom datatype to EJSON.",
"!type": "fn(name: string, factory: fn())",
"!url": "https://docs.meteor.com/api/ejson_add_type"
},
"clone": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Return a deep copy of `val`.",
"!type": "fn(val: +EJSON)",
"!url": "https://docs.meteor.com/api/ejson_clone"
},
"equals": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "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.",
"!type": "fn(a: +EJSON, b: +EJSON, options?: ?)",
"!url": "https://docs.meteor.com/api/ejson_equals"
},
"fromJSONValue": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Deserialize an EJSON value from its plain JSON representation.",
"!type": "fn(val: +JSONCompatible)",
"!url": "https://docs.meteor.com/api/ejson_from_json_value"
},
"isBinary": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Returns true if `x` is a buffer of binary data, as returned from [`EJSON.newBinary`](#ejson_new_binary).",
"!type": "fn(x: ?)",
"!url": "https://docs.meteor.com/api/ejson_is_binary"
},
"newBinary": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Allocate a new buffer of binary data that EJSON can serialize.",
"!url": "https://docs.meteor.com/api/ejson_new_binary"
},
"parse": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Parse a string into an EJSON value. Throws an error if the string is not valid EJSON.",
"!type": "fn(str: string)",
"!url": "https://docs.meteor.com/api/ejson_parse"
},
"stringify": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "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`.",
"!type": "fn(val: +EJSON, options?: ?)",
"!url": "https://docs.meteor.com/api/ejson_stringify"
},
"toJSONValue": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Serialize an EJSON-compatible value into its plain JSON representation.",
"!type": "fn(val: +EJSON)",
"!url": "https://docs.meteor.com/api/ejson_to_json_value"
}
},
"Meteor": {
"Error": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "This class represents a symbolic error thrown by a method.",
"!type": "fn(error: string, reason?: string, details?: string)",
"!url": "https://docs.meteor.com/api/meteor_error"
},
"absoluteUrl": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "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 to Galaxy, but must be provided when using `meteor build`.",
"!type": "fn(path?: string, options?: ?)",
"!url": "https://docs.meteor.com/api/meteor_absoluteurl"
},
"apply": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Invoke a method passing an array of arguments.",
"!type": "fn(name: string, args: [+EJSONable], options?: ?, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/meteor_apply"
},
"call": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Invokes a method passing any number of arguments.",
"!type": "fn(name: string, arg1, arg2..., asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/meteor_call"
},
"clearInterval": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Cancel a repeating function call scheduled by `Meteor.setInterval`.",
"!type": "fn(id: number)",
"!url": "https://docs.meteor.com/api/meteor_clearinterval"
},
"clearTimeout": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Cancel a function call scheduled by `Meteor.setTimeout`.",
"!type": "fn(id: number)",
"!url": "https://docs.meteor.com/api/meteor_cleartimeout"
},
"defer": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Defer execution of a function to run asynchronously in the background (similar to `Meteor.setTimeout(func, 0)`.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/Meteor-defer"
},
"disconnect": {
"!data": {
"!locus": "Client"
},
"!doc": "Disconnect the client from the server.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/meteor_disconnect"
},
"isClient": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Boolean variable. True if running in client environment.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/meteor_isclient"
},
"isCordova": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Boolean variable. True if running in a Cordova mobile environment.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/meteor_iscordova"
},
"isDevelopment": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Boolean variable. True if running in development environment.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/Meteor-isDevelopment"
},
"isProduction": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Boolean variable. True if running in production environment.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/Meteor-isProduction"
},
"isServer": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Boolean variable. True if running in server environment.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/meteor_isserver"
},
"loggingIn": {
"!data": {
"!locus": "Client"
},
"!doc": "True if a login method (such as `Meteor.loginWithPassword`, `Meteor.loginWithFacebook`, or `Accounts.createUser`) is currently in progress. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/meteor_loggingin"
},
"loginWith<ExternalService>": {
"!data": {
"!locus": "Client"
},
"!doc": "Log the user in using an external service.",
"!type": "fn(options?: ?, callback?: fn())",
"!url": "https://docs.meteor.com/api/meteor_loginwithexternalservice"
},
"loginWithPassword": {
"!data": {
"!locus": "Client"
},
"!doc": "Log the user in with a password.",
"!type": "fn(user: ?, password: string, callback?: fn())",
"!url": "https://docs.meteor.com/api/meteor_loginwithpassword"
},
"logout": {
"!data": {
"!locus": "Client"
},
"!doc": "Log the user out.",
"!type": "fn(callback?: fn())",
"!url": "https://docs.meteor.com/api/meteor_logout"
},
"logoutOtherClients": {
"!data": {
"!locus": "Client"
},
"!doc": "Log out other clients logged in as the current user, but does not log out the client that calls this function.",
"!type": "fn(callback?: fn())",
"!url": "https://docs.meteor.com/api/meteor_logoutotherclients"
},
"methods": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Defines functions that can be invoked over the network by clients.",
"!type": "fn(methods: ?)",
"!url": "https://docs.meteor.com/api/meteor_methods"
},
"onConnection": {
"!data": {
"!locus": "Server"
},
"!doc": "Register a callback to be called when a new DDP connection is made to the server.",
"!type": "fn(callback: fn())",
"!url": "https://docs.meteor.com/api/meteor_onconnection"
},
"publish": {
"!data": {
"!locus": "Server"
},
"!doc": "Publish a record set.",
"!type": "fn(name: string, func: fn())",
"!url": "https://docs.meteor.com/api/meteor_publish"
},
"reconnect": {
"!data": {
"!locus": "Client"
},
"!doc": "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.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/meteor_reconnect"
},
"release": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "`Meteor.release` is a string containing the name of the [release](#meteorupdate) with which the project was built (for example, `\"1.2.3\"`). It is `undefined` if the project was built using a git checkout of Meteor.",
"!type": "string",
"!url": "https://docs.meteor.com/api/meteor_release"
},
"setInterval": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Call a function repeatedly, with a time delay between calls.",
"!type": "fn(func: fn(), delay: number)",
"!url": "https://docs.meteor.com/api/meteor_setinterval"
},
"setTimeout": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Call a function in the future after waiting for a specified delay.",
"!type": "fn(func: fn(), delay: number)",
"!url": "https://docs.meteor.com/api/meteor_settimeout"
},
"settings": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "`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 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. You can rely on `Meteor.settings` and `Meteor.settings.public` being defined objects (not undefined) on both client and server even if there are no settings specified. Changes to `Meteor.settings.public` at runtime will be picked up by new client connections.",
"!type": "?",
"!url": "https://docs.meteor.com/api/meteor_settings"
},
"startup": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Run code when a client or a server starts.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/meteor_startup"
},
"status": {
"!data": {
"!locus": "Client"
},
"!doc": "Get the current connection status. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/meteor_status"
},
"subscribe": {
"!data": {
"!locus": "Client"
},
"!doc": "Subscribe to a record set. Returns a handle that provides\n`stop()` and `ready()` methods.",
"!type": "fn(name: string, arg1, arg2..., callbacks?: fn()) -> MeteorSubscribeHandle",
"!url": "https://docs.meteor.com/api/meteor_subscribe"
},
"user": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user record, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/meteor_user"
},
"userId": {
"!data": {
"!locus": "Anywhere but publish functions"
},
"!doc": "Get the current user id, or `null` if no user is logged in. A reactive data source.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/meteor_userid"
},
"users": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "A [Mongo.Collection](#collections) containing user documents.",
"!type": "+Mongo.Collection",
"!url": "https://docs.meteor.com/api/meteor_users"
},
"wrapAsync": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Wrap a function that takes a callback function as its final parameter. The signature of the callback of the wrapped function should be `function(error, result){}`. On the server, the wrapped function can be used either synchronously (without passing a callback) or asynchronously (when a callback is passed). On the client, a callback is always required; errors will be logged if there is no callback. If a callback is provided, the environment captured when the original function was called will be restored in the callback.",
"!type": "fn(func: fn(), context?: ?)",
"!url": "https://docs.meteor.com/api/meteor_wrapasync"
}
},
"Mongo": {
"Collection": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Constructor for a Collection",
"!type": "fn(name: string, options?: ?)",
"!url": "https://docs.meteor.com/api/mongo_collection",
"prototype": {
"allow": {
"!data": {
"!locus": "Server"
},
"!doc": "Allow users to write directly to this collection from client code, subject to limitations you define.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/allow"
},
"deny": {
"!data": {
"!locus": "Server"
},
"!doc": "Override `allow` rules.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/deny"
},
"find": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Find the documents in a collection that match the selector.",
"!type": "fn(selector?: +MongoSelector, options?: ?) -> +Mongo.Cursor",
"!url": "https://docs.meteor.com/api/find"
},
"findOne": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Finds the first document that matches the selector, as ordered by sort and skip options.",
"!type": "fn(selector?: +MongoSelector, options?: ?) -> ?",
"!url": "https://docs.meteor.com/api/findone"
},
"insert": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Insert a document in the collection. Returns its unique _id.",
"!type": "fn(doc: ?, callback?: fn())",
"!url": "https://docs.meteor.com/api/insert"
},
"rawCollection": {
"!data": {
"!locus": "Server"
},
"!doc": "Returns the [`Collection`](http://mongodb.github.io/node-mongodb-native/1.4/api-generated/collection.html) object corresponding to this collection from the [npm `mongodb` driver module](https://www.npmjs.com/package/mongodb) which is wrapped by `Mongo.Collection`.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Mongo-Collection-rawCollection"
},
"rawDatabase": {
"!data": {
"!locus": "Server"
},
"!doc": "Returns the [`Db`](http://mongodb.github.io/node-mongodb-native/1.4/api-generated/db.html) object corresponding to this collection's database connection from the [npm `mongodb` driver module](https://www.npmjs.com/package/mongodb) which is wrapped by `Mongo.Collection`.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Mongo-Collection-rawDatabase"
},
"remove": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Remove documents from the collection",
"!type": "fn(selector: +MongoSelector, callback?: fn())",
"!url": "https://docs.meteor.com/api/remove"
},
"update": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Modify one or more documents in the collection. Returns the number of affected documents.",
"!type": "fn(selector: +MongoSelector, modifier: +MongoModifier, options?: ?, callback?: fn())",
"!url": "https://docs.meteor.com/api/update"
},
"upsert": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "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).",
"!type": "fn(selector: +MongoSelector, modifier: +MongoModifier, options?: ?, callback?: fn())",
"!url": "https://docs.meteor.com/api/upsert"
}
}
},
"Cursor": {
"!doc": "To create a cursor, use find. To access the documents in a cursor, use forEach, map, or fetch.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Mongo-Cursor",
"prototype": {
"count": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Returns the number of documents that match a query.",
"!type": "fn() -> number",
"!url": "https://docs.meteor.com/api/count"
},
"fetch": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Return all matching documents as an Array.",
"!type": "fn() -> [?]",
"!url": "https://docs.meteor.com/api/fetch"
},
"forEach": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Call `callback` once for each matching document, sequentially and synchronously.",
"!type": "fn(callback: fn(?, number), thisArg)",
"!url": "https://docs.meteor.com/api/foreach"
},
"map": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Map callback over all matching documents. Returns an Array.",
"!type": "fn(callback: fn(?, number), thisArg)",
"!url": "https://docs.meteor.com/api/map"
},
"observe": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Watch a query. Receive callbacks as the result set changes.",
"!type": "fn(callbacks: ?)",
"!url": "https://docs.meteor.com/api/observe"
},
"observeChanges": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Watch a query. Receive callbacks as the result set changes. Only the differences between the old and new documents are passed to the callbacks.",
"!type": "fn(callbacks: ?)",
"!url": "https://docs.meteor.com/api/observe_changes"
}
}
},
"ObjectID": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Create a Mongo-style `ObjectID`. If you don't specify a `hexString`, the `ObjectID` will generated randomly (not using MongoDB's ID construction rules).",
"!type": "fn(hexString?: string)",
"!url": "https://docs.meteor.com/api/mongo_object_id"
}
},
"PackageAPI": {
"!doc": "Type of the API object passed into the `Package.onUse` function.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/PackageAPI",
"prototype": {
"addAssets": {
"!data": {
"!locus": "package.js"
},
"!doc": "Specify asset files for your package. They can be accessed via\nthe [Assets API](#assets) from the server, or at the URL\n`/packages/username_package-name/file-name` from the client, depending on the\narchitecture passed.",
"!type": "fn(filenames: string, architecture: string)",
"!url": "https://docs.meteor.com/api/PackageAPI-addAssets"
},
"addFiles": {
"!data": {
"!locus": "package.js"
},
"!doc": "Specify source code files for your package.",
"!type": "fn(filenames: string, architecture?: string, options?: ?)",
"!url": "https://docs.meteor.com/api/pack_addFiles"
},
"export": {
"!data": {
"!locus": "package.js"
},
"!doc": "Export package-level variables in your package. The specified\nvariables (declared without `var` in the source code) will be available\nto packages that use your package. If your package sets the `debugOnly`,\n`prodOnly` or `testOnly` options to `true` when it calls\n`Package.describe()`, then packages that use your package will need to use\n`Package[\"package-name\"].ExportedVariableName` to access the value of an\nexported variable.",
"!type": "fn(exportedObjects: string, architecture?: string, exportOptions?: ?, exportOptions.testOnly: bool)",
"!url": "https://docs.meteor.com/api/pack_export"
},
"imply": {
"!data": {
"!locus": "package.js"
},
"!doc": "Give users of this package access to another package (by passing\nin the string `packagename`) or a collection of packages (by passing in\nan array of strings [`packagename1`, `packagename2`]",
"!type": "fn(packageNames: string, architecture?: string)",
"!url": "https://docs.meteor.com/api/pack_api_imply"
},
"use": {
"!data": {
"!locus": "package.js"
},
"!doc": "Depend on package `packagename`.",
"!type": "fn(packageNames: string, architecture?: string, options?: ?)",
"!url": "https://docs.meteor.com/api/pack_use"
},
"versionsFrom": {
"!data": {
"!locus": "package.js"
},
"!doc": "Use versions of core packages from a release. Unless provided,\nall packages will default to the versions released along with\n`meteorRelease`. This will save you from having to figure out the exact\nversions of the core packages you want to use. For example, if the newest\nrelease of meteor is `METEOR@0.9.0` and it includes `jquery@1.0.0`, you\ncan write `api.versionsFrom('METEOR@0.9.0')` in your package, and when you\nlater write `api.use('jquery')`, it will be equivalent to\n`api.use('jquery@1.0.0')`. You may specify an array of multiple releases,\nin which case the default value for constraints will be the \"or\" of the\nversions from each release: `api.versionsFrom(['METEOR@0.9.0',\n'METEOR@0.9.5'])` may cause `api.use('jquery')` to be interpreted as\n`api.use('jquery@1.0.0 || 2.0.0')`.",
"!type": "fn(meteorRelease: string)",
"!url": "https://docs.meteor.com/api/pack_versions"
}
}
},
"ReactiveVar": {
"!data": {
"!locus": "Client"
},
"!doc": "Constructor for a ReactiveVar, which represents a single reactive variable.",
"!type": "fn(initialValue, equalsFunc?: fn())",
"!url": "https://docs.meteor.com/api/reactive-var",
"prototype": {
"get": {
"!data": {
"!locus": "Client"
},
"!doc": "Returns the current value of the ReactiveVar, establishing a reactive dependency.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/reactivevar_get"
},
"set": {
"!data": {
"!locus": "Client"
},
"!doc": "Sets the current value of the ReactiveVar, invalidating the Computations that called `get` if `newValue` is different from the old value.",
"!type": "fn(newValue)",
"!url": "https://docs.meteor.com/api/reactivevar_set"
}
}
},
"Subscription": {
"!doc": "The server's side of a subscription",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Subscription",
"prototype": {
"added": {
"!data": {
"!locus": "Server"
},
"!doc": "Call inside the publish function. Informs the subscriber that a document has been added to the record set.",
"!type": "fn(collection: string, id: string, fields: ?)",
"!url": "https://docs.meteor.com/api/publish_added"
},
"changed": {
"!data": {
"!locus": "Server"
},
"!doc": "Call inside the publish function. Informs the subscriber that a document in the record set has been modified.",
"!type": "fn(collection: string, id: string, fields: ?)",
"!url": "https://docs.meteor.com/api/publish_changed"
},
"connection": {
"!data": {
"!locus": "Server"
},
"!doc": "Access inside the publish function. The incoming [connection](#meteor_onconnection) for this subscription.",
"!url": "https://docs.meteor.com/api/publish_connection"
},
"error": {
"!data": {
"!locus": "Server"
},
"!doc": "Call inside the publish function. Stops this client's subscription, triggering a call on the client to the `onStop` callback passed to [`Meteor.subscribe`](#meteor_subscribe), if any. If `error` is not a [`Meteor.Error`](#meteor_error), it will be [sanitized](#meteor_error).",
"!type": "fn(error: +Error)",
"!url": "https://docs.meteor.com/api/publish_error"
},
"onStop": {
"!data": {
"!locus": "Server"
},
"!doc": "Call inside the publish function. Registers a callback function to run when the subscription is stopped.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/publish_onstop"
},
"ready": {
"!data": {
"!locus": "Server"
},
"!doc": "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.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/publish_ready"
},
"removed": {
"!data": {
"!locus": "Server"
},
"!doc": "Call inside the publish function. Informs the subscriber that a document has been removed from the record set.",
"!type": "fn(collection: string, id: string)",
"!url": "https://docs.meteor.com/api/publish_removed"
},
"stop": {
"!data": {
"!locus": "Server"
},
"!doc": "Call inside the publish function. Stops this client's subscription and invokes the client's `onStop` callback with no error.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/publish_stop"
},
"userId": {
"!data": {
"!locus": "Server"
},
"!doc": "Access inside the publish function. The id of the logged-in user, or `null` if no user is logged in.",
"!url": "https://docs.meteor.com/api/publish_userId"
}
}
},
"Template": {
"!doc": "The class for defining templates",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/templates",
"prototype": {
"created": {
"!data": {
"!locus": "Client"
},
"!doc": "Provide a callback when an instance of a template is created.",
"!url": "https://docs.meteor.com/api/template_created"
},
"destroyed": {
"!data": {
"!locus": "Client"
},
"!doc": "Provide a callback when an instance of a template is destroyed.",
"!url": "https://docs.meteor.com/api/template_destroyed"
},
"events": {
"!data": {
"!locus": "Client"
},
"!doc": "Specify event handlers for this template.",
"!type": "fn(eventMap: +EventMap)",
"!url": "https://docs.meteor.com/api/template_events"
},
"helpers": {
"!data": {
"!locus": "Client"
},
"!doc": "Specify template helpers available to this template.",
"!type": "fn(helpers: ?)",
"!url": "https://docs.meteor.com/api/template_helpers"
},
"onCreated": {
"!data": {
"!locus": "Client"
},
"!doc": "Register a function to be called when an instance of this template is created.",
"!url": "https://docs.meteor.com/api/template_onCreated"
},
"onDestroyed": {
"!data": {
"!locus": "Client"
},
"!doc": "Register a function to be called when an instance of this template is removed from the DOM and destroyed.",
"!url": "https://docs.meteor.com/api/template_onDestroyed"
},
"onRendered": {
"!data": {
"!locus": "Client"
},
"!doc": "Register a function to be called when an instance of this template is inserted into the DOM.",
"!url": "https://docs.meteor.com/api/template_onRendered"
},
"rendered": {
"!data": {
"!locus": "Client"
},
"!doc": "Provide a callback when an instance of a template is rendered.",
"!url": "https://docs.meteor.com/api/template_rendered"
}
},
"body": {
"!data": {
"!locus": "Client"
},
"!doc": "The [template object](#templates_api) representing your `<body>`\ntag.",
"!url": "https://docs.meteor.com/api/template_body"
},
"currentData": {
"!data": {
"!locus": "Client"
},
"!doc": "- Inside an `onCreated`, `onRendered`, or `onDestroyed` callback, returns\nthe data context of the template.\n- Inside an event handler, returns the data context of the template on which\nthis event handler was defined.\n- Inside a helper, returns the data context of the DOM node where the helper\nwas used.\n\nEstablishes a reactive dependency on the result.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/template_currentdata"
},
"deregisterHelper": {
"!data": {
"!locus": "Client"
},
"!doc": "Removes a global [helper function](#template_helpers).",
"!type": "fn(name: string)",
"!url": "https://docs.meteor.com/api/Template-deregisterHelper"
},
"dynamic": {
"!data": {
"!locus": "Templates"
},
"!doc": "Choose a template to include dynamically, by name.",
"!type": "fn(template: string, data?: ?)",
"!url": "https://docs.meteor.com/api/template_dynamic"
},
"instance": {
"!data": {
"!locus": "Client"
},
"!doc": "The [template instance](#template_inst) corresponding to the current template helper, event handler, callback, or autorun. If there isn't one, `null`.",
"!type": "fn() -> +Blaze.TemplateInstance",
"!url": "https://docs.meteor.com/api/template_instance"
},
"parentData": {
"!data": {
"!locus": "Client"
},
"!doc": "Accesses other data contexts that enclose the current data context.",
"!type": "fn(numLevels?: number)",
"!url": "https://docs.meteor.com/api/template_parentdata"
},
"registerHelper": {
"!data": {
"!locus": "Client"
},
"!doc": "Defines a [helper function](#template_helpers) which can be used from all templates.",
"!type": "fn(name: string, function: fn())",
"!url": "https://docs.meteor.com/api/template_registerhelper"
}
},
"Tracker": {
"Dependency": {
"!doc": "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.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Tracker-Dependency",
"prototype": {
"changed": {
"!data": {
"!locus": "Client"
},
"!doc": "Invalidate all dependent computations immediately and remove them as dependents.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/dependency_changed"
},
"depend": {
"!data": {
"!locus": "Client"
},
"!doc": "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.",
"!type": "fn(fromComputation?: +Tracker.Computation) -> bool",
"!url": "https://docs.meteor.com/api/dependency_depend"
},
"hasDependents": {
"!data": {
"!locus": "Client"
},
"!doc": "True if this Dependency has one or more dependent Computations, which would be invalidated if this Dependency were to change.",
"!type": "fn() -> bool",
"!url": "https://docs.meteor.com/api/dependency_hasdependents"
}
}
},
"Computation": {
"!doc": "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.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Tracker-Computation",
"prototype": {
"firstRun": {
"!data": {
"!locus": "Client"
},
"!doc": "True during the initial run of the computation at the time `Tracker.autorun` is called, and false on subsequent reruns and at other times.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/computation_firstrun"
},
"flush": {
"!data": {
"!locus": "Client"
},
"!doc": "Process the reactive updates for this computation immediately\nand ensure that the computation is rerun. The computation is rerun only\nif it is invalidated.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Tracker-Computation-flush"
},
"invalidate": {
"!data": {
"!locus": "Client"
},
"!doc": "Invalidates this computation so that it will be rerun.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/computation_invalidate"
},
"invalidated": {
"!data": {
"!locus": "Client"
},
"!doc": "True if this computation has been invalidated (and not yet rerun), or if it has been stopped.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/computation_invalidated"
},
"onInvalidate": {
"!data": {
"!locus": "Client"
},
"!doc": "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.",
"!type": "fn(callback: fn())",
"!url": "https://docs.meteor.com/api/computation_oninvalidate"
},
"onStop": {
"!data": {
"!locus": "Client"
},
"!doc": "Registers `callback` to run when this computation is stopped, or runs it immediately if the computation is already stopped. The callback is run after any `onInvalidate` callbacks.",
"!type": "fn(callback: fn())",
"!url": "https://docs.meteor.com/api/computation_onstop"
},
"run": {
"!data": {
"!locus": "Client"
},
"!doc": "Causes the function inside this computation to run and\nsynchronously process all reactive updtes.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/Tracker-Computation-run"
},
"stop": {
"!data": {
"!locus": "Client"
},
"!doc": "Prevents this computation from rerunning.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/computation_stop"
},
"stopped": {
"!data": {
"!locus": "Client"
},
"!doc": "True if this computation has been stopped.",
"!url": "https://docs.meteor.com/api/computation_stopped"
}
}
},
"active": {
"!data": {
"!locus": "Client"
},
"!doc": "True if there is a current computation, meaning that dependencies on reactive data sources will be tracked and potentially cause the current computation to be rerun.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/tracker_active"
},
"afterFlush": {
"!data": {
"!locus": "Client"
},
"!doc": "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.",
"!type": "fn(callback: fn())",
"!url": "https://docs.meteor.com/api/tracker_afterflush"
},
"autorun": {
"!data": {
"!locus": "Client"
},
"!doc": "Run a function now and rerun it later whenever its dependencies\nchange. Returns a Computation object that can be used to stop or observe the\nrerunning.",
"!type": "fn(runFunc: fn(+Tracker.Computation), options?: ?) -> +Tracker.Computation",
"!url": "https://docs.meteor.com/api/tracker_autorun"
},
"currentComputation": {
"!data": {
"!locus": "Client"
},
"!doc": "The current computation, or `null` if there isn't one. The current computation is the [`Tracker.Computation`](#tracker_computation) object created by the innermost active call to `Tracker.autorun`, and it's the computation that gains dependencies when reactive data sources are accessed.",
"!type": "+Tracker.Computation",
"!url": "https://docs.meteor.com/api/tracker_currentcomputation"
},
"flush": {
"!data": {
"!locus": "Client"
},
"!doc": "Process all reactive updates immediately and ensure that all invalidated computations are rerun.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/tracker_flush"
},
"nonreactive": {
"!data": {
"!locus": "Client"
},
"!doc": "Run a function without tracking dependencies.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/tracker_nonreactive"
},
"onInvalidate": {
"!data": {
"!locus": "Client"
},
"!doc": "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.",
"!type": "fn(callback: fn())",
"!url": "https://docs.meteor.com/api/tracker_oninvalidate"
}
},
"Accounts": {
"addEmail": {
"!data": {
"!locus": "Server"
},
"!doc": "Add an email address for a user. Use this instead of directly\nupdating the database. The operation will fail if there is a different user\nwith an email only differing in case. If the specified user has an existing\nemail only differing in case however, we replace it.",
"!type": "fn(userId: string, newEmail: string, verified?: bool)",
"!url": "https://docs.meteor.com/api/Accounts-addEmail"
},
"changePassword": {
"!data": {
"!locus": "Client"
},
"!doc": "Change the current user's password. Must be logged in.",
"!type": "fn(oldPassword: string, newPassword: string, callback?: fn())",
"!url": "https://docs.meteor.com/api/accounts_changepassword"
},
"createUser": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Create a new user.",
"!type": "fn(options: ?, callback?: fn())",
"!url": "https://docs.meteor.com/api/accounts_createuser"
},
"emailTemplates": {
"!data": {
"!locus": "Server"
},
"!doc": "Options to customize emails sent from the Accounts system.",
"!url": "https://docs.meteor.com/api/accounts_emailtemplates"
},
"findUserByEmail": {
"!data": {
"!locus": "Server"
},
"!doc": "Finds the user with the specified email.\nFirst tries to match email case sensitively; if that fails, it\ntries case insensitively; but if more than one user matches the case\ninsensitive search, it returns null.",
"!type": "fn(email: string) -> ?",
"!url": "https://docs.meteor.com/api/Accounts-findUserByEmail"
},
"findUserByUsername": {
"!data": {
"!locus": "Server"
},
"!doc": "Finds the user with the specified username.\nFirst tries to match username case sensitively; if that fails, it\ntries case insensitively; but if more than one user matches the case\ninsensitive search, it returns null.",
"!type": "fn(username: string) -> ?",
"!url": "https://docs.meteor.com/api/Accounts-findUserByUsername"
},
"forgotPassword": {
"!data": {
"!locus": "Client"
},
"!doc": "Request a forgot password email.",
"!type": "fn(options: ?, callback?: fn())",
"!url": "https://docs.meteor.com/api/accounts_forgotpassword"
},
"onEmailVerificationLink": {
"!data": {
"!locus": "Client"
},
"!doc": "Register a function to call when an email verification link is\nclicked in an email sent by\n[`Accounts.sendVerificationEmail`](#accounts_sendverificationemail).\nThis function should be called in top-level code, not inside\n`Meteor.startup()`.",
"!url": "https://docs.meteor.com/api/Accounts-onEmailVerificationLink"
},
"onEnrollmentLink": {
"!data": {
"!locus": "Client"
},
"!doc": "Register a function to call when an account enrollment link is\nclicked in an email sent by\n[`Accounts.sendEnrollmentEmail`](#accounts_sendenrollmentemail).\nThis function should be called in top-level code, not inside\n`Meteor.startup()`.",
"!url": "https://docs.meteor.com/api/Accounts-onEnrollmentLink"
},
"onResetPasswordLink": {
"!data": {
"!locus": "Client"
},
"!doc": "Register a function to call when a reset password link is clicked\nin an email sent by\n[`Accounts.sendResetPasswordEmail`](#accounts_sendresetpasswordemail).\nThis function should be called in top-level code, not inside\n`Meteor.startup()`.",
"!url": "https://docs.meteor.com/api/Accounts-onResetPasswordLink"
},
"removeEmail": {
"!data": {
"!locus": "Server"
},
"!doc": "Remove an email address for a user. Use this instead of updating\nthe database directly.",
"!type": "fn(userId: string, email: string)",
"!url": "https://docs.meteor.com/api/Accounts-removeEmail"
},
"resetPassword": {
"!data": {
"!locus": "Client"
},
"!doc": "Reset the password for a user using a token received in email. Logs the user in afterwards.",
"!type": "fn(token: string, newPassword: string, callback?: fn())",
"!url": "https://docs.meteor.com/api/accounts_resetpassword"
},
"sendEnrollmentEmail": {
"!data": {
"!locus": "Server"
},
"!doc": "Send an email with a link the user can use to set their initial password.",
"!type": "fn(userId: string, email?: string)",
"!url": "https://docs.meteor.com/api/accounts_sendenrollmentemail"
},
"sendResetPasswordEmail": {
"!data": {
"!locus": "Server"
},
"!doc": "Send an email with a link the user can use to reset their password.",
"!type": "fn(userId: string, email?: string)",
"!url": "https://docs.meteor.com/api/accounts_sendresetpasswordemail"
},
"sendVerificationEmail": {
"!data": {
"!locus": "Server"
},
"!doc": "Send an email with a link the user can use verify their email address.",
"!type": "fn(userId: string, email?: string)",
"!url": "https://docs.meteor.com/api/accounts_sendverificationemail"
},
"setPassword": {
"!data": {
"!locus": "Server"
},
"!doc": "Forcibly change the password for a user.",
"!type": "fn(userId: string, newPassword: string, options?: ?)",
"!url": "https://docs.meteor.com/api/accounts_setpassword"
},
"setUsername": {
"!data": {
"!locus": "Server"
},
"!doc": "Change a user's username. Use this instead of updating the\ndatabase directly. The operation will fail if there is an existing user\nwith a username only differing in case.",
"!type": "fn(userId: string, newUsername: string)",
"!url": "https://docs.meteor.com/api/Accounts-setUsername"
},
"ui": {
"config": {
"!data": {
"!locus": "Client"
},
"!doc": "Configure the behavior of [`{{> loginButtons}}`](#accountsui).",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/accounts_ui_config"
}
},
"verifyEmail": {
"!data": {
"!locus": "Client"
},
"!doc": "Marks the user's email address as verified. Logs the user in afterwards.",
"!type": "fn(token: string, callback?: fn())",
"!url": "https://docs.meteor.com/api/accounts_verifyemail"
}
},
"App": {
"accessRule": {
"!doc": "Set a new access rule based on origin domain for your app.\nBy default your application has a limited list of servers it can contact.\nUse this method to extend this list.\n\nDefault access rules:\n\n- `tel:*`, `geo:*`, `mailto:*`, `sms:*`, `market:*` are allowed and\n are handled by the system (e.g. opened in the phone app or an email client)\n- `http://localhost:*` is used to serve the app's assets from.\n- The domain or address of the Meteor server to connect to for DDP and\n hot code push of new versions.\n\nRead more about domain patterns in [Cordova\ndocs](http://cordova.apache.org/docs/en/6.0.0/guide_appdev_whitelist_index.md.html).\n\nStarting with Meteor 1.0.4 access rule for all domains and protocols\n(`<access origin=\"*\"/>`) is no longer set by default due to\n[certain kind of possible\nattacks](http://cordova.apache.org/announcements/2014/08/04/android-351.html).",
"!type": "fn(pattern: string, options?: ?)",
"!url": "https://docs.meteor.com/api/App-accessRule"
},
"configurePlugin": {
"!doc": "Set the build-time configuration for a Cordova plugin.",
"!type": "fn(id: string, config: ?)",
"!url": "https://docs.meteor.com/api/App-configurePlugin"
},
"icons": {
"!doc": "Set the icons for your mobile app.",
"!type": "fn(icons: ?)",
"!url": "https://docs.meteor.com/api/App-icons"
},
"info": {
"!doc": "Set your mobile app's core configuration information.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/App-info"
},
"launchScreens": {
"!doc": "Set the launch screen images for your mobile app.",
"!type": "fn(launchScreens: ?)",
"!url": "https://docs.meteor.com/api/App-launchScreens"
},
"setPreference": {
"!doc": "Add a preference for your build as described in the\n[Cordova documentation](http://cordova.apache.org/docs/en/5.1.1/config_ref_index.md.html#The%20config.xml%20File_global_preferences).",
"!type": "fn(name: string, value: string, platform?: string)",
"!url": "https://docs.meteor.com/api/App-setPreference"
}
},
"Assets": {
"absoluteFilePath": {
"!data": {
"!locus": "Server [Not in build plugins]"
},
"!doc": "Get the absolute path to the static server asset. Note that assets are read-only.",
"!type": "fn(assetPath: string)",
"!url": "https://docs.meteor.com/api/Assets-absoluteFilePath"
},
"getBinary": {
"!data": {
"!locus": "Server"
},
"!doc": "Retrieve the contents of the static server asset as an [EJSON Binary](#ejson_new_binary).",
"!type": "fn(assetPath: string, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/assets_getBinary"
},
"getText": {
"!data": {
"!locus": "Server"
},
"!doc": "Retrieve the contents of the static server asset as a UTF8-encoded string.",
"!type": "fn(assetPath: string, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/assets_getText"
}
},
"Cordova": {
"depends": {
"!data": {
"!locus": "package.js"
},
"!doc": "Specify which [Cordova / PhoneGap](http://cordova.apache.org/)\nplugins your Meteor package depends on.\n\nPlugins are installed from\n[plugins.cordova.io](http://plugins.cordova.io/), so the plugins and\nversions specified must exist there. Alternatively, the version\ncan be replaced with a GitHub tarball URL as described in the\n[Cordova](https://github.com/meteor/meteor/wiki/Meteor-Cordova-integration#meteor-packages-with-cordova-dependencies)\npage of the Meteor wiki on GitHub.",
"!type": "fn(dependencies: ?)",
"!url": "https://docs.meteor.com/api/Cordova-depends"
}
},
"DDP": {
"connect": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Connect to the server of a different Meteor application to subscribe to its document sets and invoke its remote methods.",
"!type": "fn(url: string)",
"!url": "https://docs.meteor.com/api/ddp_connect"
}
},
"DDPCommon": {
"MethodInvocation": {
"!doc": "The state for a single invocation of a method, referenced by this\ninside a method definition.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/DDPCommon-MethodInvocation",
"prototype": {
"connection": {
"!data": {
"!locus": "Server"
},
"!doc": "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. Calls to methods made from a server method which was in turn initiated from the client share the same `connection`.",
"!url": "https://docs.meteor.com/api/method_connection"
},
"isSimulation": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Access inside a method invocation. Boolean value, true if this invocation is a stub.",
"!type": "bool",
"!url": "https://docs.meteor.com/api/method_issimulation"
},
"setUserId": {
"!data": {
"!locus": "Server"
},
"!doc": "Set the logged in user.",
"!type": "fn(userId: string)",
"!url": "https://docs.meteor.com/api/method_setUserId"
},
"unblock": {
"!data": {
"!locus": "Server"
},
"!doc": "Call inside a method invocation. Allow subsequent method from this client to begin running in a new fiber.",
"!type": "fn()",
"!url": "https://docs.meteor.com/api/method_unblock"
},
"userId": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "The id of the user that made this method call, or `null` if no user was logged in.",
"!url": "https://docs.meteor.com/api/method_userId"
}
}
}
},
"DDPRateLimiter": {
"addRule": {
"!data": {
"!locus": "Server"
},
"!doc": "Add a rule that matches against a stream of events describing method or\nsubscription attempts. Each event is an object with the following\nproperties:\n\n- `type`: Either \"method\" or \"subscription\"\n- `name`: The name of the method or subscription being called\n- `userId`: The user ID attempting the method or subscription\n- `connectionId`: A string representing the user's DDP connection\n- `clientAddress`: The IP address of the user\n\nReturns unique `ruleId` that can be passed to `removeRule`.",
"!type": "fn(matcher: ?, numRequests: number, timeInterval: number)",
"!url": "https://docs.meteor.com/api/DDPRateLimiter-addRule"
},
"removeRule": {
"!data": {
"!locus": "Server"
},
"!doc": "Removes the specified rule from the rate limiter. If rule had\nhit a rate limit, that limit is removed as well.",
"!type": "fn(id: string) -> bool",
"!url": "https://docs.meteor.com/api/DDPRateLimiter-removeRule"
},
"setErrorMessage": {
"!data": {
"!locus": "Server"
},
"!doc": "Set error message text when method or subscription rate limit\nexceeded.",
"!type": "fn(message: string)",
"!url": "https://docs.meteor.com/api/DDPRateLimiter-setErrorMessage"
}
},
"Email": {
"send": {
"!data": {
"!locus": "Server"
},
"!doc": "Send an email. Throws an `Error` on failure to contact mail server\nor if mail server returns an error. All fields should match\n[RFC5322](http://tools.ietf.org/html/rfc5322) specification.\n\nIf the `MAIL_URL` environment variable is set, actually sends the email.\nOtherwise, prints the contents of the email to standard out.\n\nNote that this package is based on mailcomposer version `0.1.15`, so make\nsure to refer to the documentation for that version if using the\n`attachments` or `mailComposer` options.\n[Click here to read the mailcomposer 0.1.15 docs](https://github.com/andris9/mailcomposer/blob/7c0422b2de2dc61a60ba27cfa3353472f662aeb5/README.md).",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/email_send"
}
},
"HTTP": {
"call": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Perform an outbound HTTP request.",
"!type": "fn(method: string, url: string, options?: ?, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/http_call"
},
"del": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Send an HTTP `DELETE` request. Equivalent to calling [`HTTP.call`](#http_call) with \"DELETE\" as the first argument. (Named `del` to avoid conflict with the Javascript keyword `delete`)",
"!type": "fn(url: string, callOptions?: ?, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/http_del"
},
"get": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Send an HTTP `GET` request. Equivalent to calling [`HTTP.call`](#http_call) with \"GET\" as the first argument.",
"!type": "fn(url: string, callOptions?: ?, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/http_get"
},
"patch": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Send an HTTP `PATCH` request. Equivalent to calling [`HTTP.call`](#http_call) with \"PATCH\" as the first argument.",
"!type": "fn(url: string, callOptions?: ?, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/HTTP-patch"
},
"post": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Send an HTTP `POST` request. Equivalent to calling [`HTTP.call`](#http_call) with \"POST\" as the first argument.",
"!type": "fn(url: string, callOptions?: ?, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/http_post"
},
"put": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Send an HTTP `PUT` request. Equivalent to calling [`HTTP.call`](#http_call) with \"PUT\" as the first argument.",
"!type": "fn(url: string, callOptions?: ?, asyncCallback?: fn())",
"!url": "https://docs.meteor.com/api/http_put"
}
},
"InputFile": {
"prototype": {
"addAsset": {
"!doc": "Add a file to serve as-is to the browser or to include on\nthe browser, depending on the target. On the web, it will be served\nat the exact path requested. For server targets, it can be retrieved\nusing `Assets.getText` or `Assets.getBinary`.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/InputFile-addAsset"
},
"addHtml": {
"!doc": "Works in web targets only. Add markup to the `head` or `body`\nsection of the document.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/InputFile-addHtml"
},
"addJavaScript": {
"!doc": "Add JavaScript code. The code added will only see the\nnamespaces imported by this package as runtime dependencies using\n['api.use'](#PackageAPI-use). If the file being compiled was added\nwith the bare flag, the resulting JavaScript won't be wrapped in a\nclosure.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/InputFile-addJavaScript"
},
"addStylesheet": {
"!doc": "Web targets only. Add a stylesheet to the document. Not available\nfor linter build plugins.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/InputFile-addStylesheet"
},
"error": {
"!doc": "Call this method to raise a compilation or linting error for the\nfile.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/InputFile-error"
},
"getArch": {
"!doc": "Returns the architecture that is targeted while processing this\nfile.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getArch"
},
"getBasename": {
"!doc": "Returns the filename of the file.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getBasename"
},
"getContentsAsBuffer": {
"!doc": "Returns the full contents of the file as a buffer.",
"!type": "fn() -> +Buffer",
"!url": "https://docs.meteor.com/api/InputFile-getContentsAsBuffer"
},
"getContentsAsString": {
"!doc": "Returns the full contents of the file as a string.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getContentsAsString"
},
"getDeclaredExports": {
"!doc": "Returns a list of symbols declared as exports in this target. The\nresult of `api.export('symbol')` calls in target's control file such as\npackage.js.",
"!type": "fn() -> [string]",
"!url": "https://docs.meteor.com/api/InputFile-getDeclaredExports"
},
"getDirname": {
"!doc": "Returns the directory path relative to the package or app root.\nThe returned path always uses forward slashes.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getDirname"
},
"getDisplayPath": {
"!doc": "Returns a relative path that can be used to form error messages or\nother display properties. Can be used as an input to a source map.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getDisplayPath"
},
"getExtension": {
"!doc": "Returns the extension that matched the compiler plugin.\nThe longest prefix is preferred.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getExtension"
},
"getFileOptions": {
"!doc": "Returns an object of file options such as those passed as the\n third argument to api.addFiles.",
"!type": "fn() -> ?",
"!url": "https://docs.meteor.com/api/InputFile-getFileOptions"
},
"getPackageName": {
"!doc": "Returns the name of the package or `null` if the file is not in a\npackage.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getPackageName"
},
"getPathInBundle": {
"!doc": "Returns the path of the compiled file in the bundle.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getPathInBundle"
},
"getPathInPackage": {
"!doc": "Returns the relative path of file to the package or app root\ndirectory. The returned path always uses forward slashes.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getPathInPackage"
},
"getSourceHash": {
"!doc": "Returns a hash string for the file that can be used to implement\ncaching.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getSourceHash"
},
"getSourceMap": {
"!doc": "Returns the source-map associated with the file.",
"!type": "fn() -> string",
"!url": "https://docs.meteor.com/api/InputFile-getSourceMap"
}
}
},
"Npm": {
"depends": {
"!data": {
"!locus": "package.js"
},
"!doc": "Specify which [NPM](https://www.npmjs.org/) packages\nyour Meteor package depends on.",
"!type": "fn(dependencies: ?)",
"!url": "https://docs.meteor.com/api/Npm-depends"
},
"require": {
"!data": {
"!locus": "Server"
},
"!doc": "Require a package that was specified using\n`Npm.depends()`.",
"!type": "fn(name: string)",
"!url": "https://docs.meteor.com/api/Npm-require"
}
},
"Package": {
"describe": {
"!data": {
"!locus": "package.js"
},
"!doc": "Provide basic package information.",
"!type": "fn(options: ?)",
"!url": "https://docs.meteor.com/api/Package-describe"
},
"onTest": {
"!data": {
"!locus": "package.js"
},
"!doc": "Define dependencies and expose package methods for unit tests.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/Package-onTest"
},
"onUse": {
"!data": {
"!locus": "package.js"
},
"!doc": "Define package dependencies and expose package methods.",
"!type": "fn(func: fn())",
"!url": "https://docs.meteor.com/api/pack_onUse"
},
"registerBuildPlugin": {
"!data": {
"!locus": "package.js"
},
"!doc": "Define a build plugin. A build plugin extends the build\nprocess for apps and packages that use this package. For example,\nthe `coffeescript` package uses a build plugin to compile CoffeeScript\nsource files into JavaScript.",
"!type": "fn(options?: ?)",
"!url": "https://docs.meteor.com/api/Package-registerBuildPlugin"
}
},
"Plugin": {
"registerCompiler": {
"!data": {
"!locus": "Build Plugin"
},
"!doc": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a compiler that will handle files with certain extensions or\nfilenames.",
"!type": "fn(options: ?, factory: fn())",
"!url": "https://docs.meteor.com/api/Plugin-registerCompiler"
},
"registerLinter": {
"!data": {
"!locus": "Build Plugin"
},
"!doc": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a linter that will handle files with certain extensions or\nfilenames.",
"!type": "fn(options: ?, factory: fn())",
"!url": "https://docs.meteor.com/api/Plugin-registerLinter"
},
"registerMinifier": {
"!data": {
"!locus": "Build Plugin"
},
"!doc": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a linter that will handle files with certain extensions or\nfilenames.",
"!type": "fn(options: ?, factory: fn())",
"!url": "https://docs.meteor.com/api/Plugin-registerMinifier"
},
"registerSourceHandler": {
"!data": {
"!locus": "Build Plugin"
},
"!doc": "Inside a build plugin source file specified in\n[Package.registerBuildPlugin](#Package-registerBuildPlugin),\nadd a handler to compile files with a certain file extension.",
"!type": "fn(fileExtension: string, handler: fn())",
"!url": "https://docs.meteor.com/api/Plugin-registerSourceHandler"
}
},
"Session": {
"equals": {
"!data": {
"!locus": "Client"
},
"!doc": "Test if a session variable is equal to a value. If inside a\n[reactive computation](#reactivity), invalidate the computation the next\ntime the variable changes to or from the value.",
"!type": "fn(key: string, value: string)",
"!url": "https://docs.meteor.com/api/session_equals"
},
"get": {
"!data": {
"!locus": "Client"
},
"!doc": "Get the value of a session variable. If inside a [reactive\ncomputation](#reactivity), invalidate the computation the next time the\nvalue of the variable is changed by [`Session.set`](#session_set). This\nreturns a clone of the session value, so if it's an object or an array,\nmutating the returned value has no effect on the value stored in the\nsession.",
"!type": "fn(key: string)",
"!url": "https://docs.meteor.com/api/session_get"
},
"set": {
"!data": {
"!locus": "Client"
},
"!doc": "Set a variable in the session. Notify any listeners that the value\nhas changed (eg: redraw templates, and rerun any\n[`Tracker.autorun`](#tracker_autorun) computations, that called\n[`Session.get`](#session_get) on this `key`.)",
"!type": "fn(key: string, value: +EJSONable)",
"!url": "https://docs.meteor.com/api/session_set"
},
"setDefault": {
"!data": {
"!locus": "Client"
},
"!doc": "Set a variable in the session if it hasn't been set before.\nOtherwise works exactly the same as [`Session.set`](#session_set).",
"!type": "fn(key: string, value: +EJSONable)",
"!url": "https://docs.meteor.com/api/session_set_default"
}
},
"check": {
"!data": {
"!locus": "Anywhere"
},
"!doc": "Check that a value matches a [pattern](#matchpatterns).\nIf the value does not match the pattern, throw a `Match.Error`.\n\nParticularly useful to assert that arguments to a function have the right\ntypes and structure.",
"!url": "https://docs.meteor.com/api/check"
},
"currentUser": {
"!doc": "Calls [Meteor.user()](#meteor_user). Use `{{#if currentUser}}` to check whether the user is logged in.",
"!url": "https://docs.meteor.com/api/template_currentuser"
},
"execFileAsync": {
"!doc": "Executes a command asynchronously, returning a promise that will\neither be resolved to the captured stdout output or be rejected with an\nerror containing the stderr output as part of the message. In addition,\nthe error will contain fields pid, stderr, stdout, status and signal.",
"!type": "fn(command: string, args?: Array, options?: ?) -> Promise.<string>",
"!url": "https://docs.meteor.com/api/execFileAsync"
},
"execFileSync": {
"!doc": "Executes a command synchronously, returning either the captured\nstdout output or throwing an error containing the stderr output as part of\nthe message. In addition, the error will contain fields pid, stderr, stdout,\nstatus and signal.",
"!type": "fn(command: string, args?: Array, options?: ?) -> string",
"!url": "https://docs.meteor.com/api/execFileSync"
},
"loggingIn": {
"!doc": "Calls [Meteor.loggingIn()](#meteor_loggingin).",
"!url": "https://docs.meteor.com/api/template_loggingin"
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment