meteor / docs

The Meteor API documentation.

This repository has been merged into Meteor main repository. You can find it there.

Meteor API Documentation - http://docs.meteor.com

This is a hexo static site used to generate the Meteor API Docs.

Contributing

We'd love your contributions! Please send us Pull Requests or open issues on github. Also, read the contribution guidelines.

If you are making a larger contribution, you may need to run the site locally:

Running locally

Submodules

This repo has two submodules, one the theme, the other full Meteor repository.

We have the Meteor repo to generate the data.js file (see below).

After cloning, or updating the repo, it makes sense to run

git submodule update --init

Generally you should not commit changes to the submodules, unless you know what you are doing.

Generating data.js

To generate the api boxes, the site uses a file data/data.js which is generated from the js docs in the Meteor source code. This will automatically happen whenever you start your local hexo server.

Starting hexo

Ensure you've run npm install. Then simply npm start.

Developing with local meteor source

When developing jsdoc documentation within the meteor code you will need to make some local modifications to get the documentation to work locally for testing.

1. Modify url in _config.yml so links within localhost:4000 will not jump out to https://docs.meteor.com

- url: http://docs.meteor.com/
+ url: http://localhost:4000/

2. reconnect the meteor submodule in /code to your local meteor folder.

# REMOVE submodule
# Remove the submodule entry from .git/config
git submodule deinit -f code

# Remove the submodule directory from the superproject's
# .git/modules directory
rm -rf .git/modules/code

# Remove the entry in .gitmodules and remove the submodule directory
# located at path/to/submodule
git rm -f code

# ADD your local meteor submodule
git submodule add /path/to/local/meteor code

3. Hexo builds if you are just changing md files in sources then hexo will watch for changes and update. If you are making changes in the /code folder then you will need to npm run clean && npm start.

Of course, do not commit any of these changes.

docs's Issues

Use ES2015 where appropriate

See Tom's link below for an animated GIF of what this issue is meant to accomplish.

@tmeasday commented on Tue Feb 23 2016

Note this isn't the modules stuff (see #6304), but instead ES2015 stuff.

Note we didn't do it for 1.2

---

@tmeasday commented on Mon Feb 29 2016

https://github.com/meteor/guide/blob/structure-content/content/code-style.md#javascript-style-guide

Docs should mention how to switch from WkWebview to UiWebview and to mention issues with UiWebView

With meteor 1.3 the cordova implementation now uses WkWebview instead of UiWebview, but there is at least one major drawback with WkWebview:

Autoplay of

The docs should mention this problem (there are maybe more)

Workaround is to switch to UiWebview with App.setPreference("CordovaWebViewEngine", "CDVUIWebViewEngine");

The docs should also mention this option (I found it while debugging the native cordova-code in xcode)

See also meteor/meteor#7173

Formatting issues for field names/types

Noticed this on http://docs.meteor.com/api/connections.html but there may be others.

I was wondering why the first field was now called connectedBoolean before realising that the field types are merged with the field names. So it's actually connected [a boolean].

Text (font) size too small?

Is it only me (my eyes ;) that think text is a bit too tiny?

Sure, there's always [CMD][+] but the text size in a previous version was okay...

Search

It's gone! It'd be particularly useful now that it's no longer a single page.

The need to add DDPRateLimiter not mentioned in docs

Moved from meteor/meteor.

@brianmingus commented on Thu Oct 29 2015

On the client: Uncaught ReferenceError: DDPRateLimiter is not defined
On the server: ReferenceError: DDPRateLimiter is not defined

addCommentRule =
  userId: (userId) ->
    type: 'method'
    name: 'getessay'

DDPRateLimiter.addRule addCommentRule, 1, 3000
DDPRateLimiter.setErrorMessage "Please wait three seconds"

---

@brianmingus commented on Thu Oct 29 2015

I don't believe the official documentation mentions that in order to use the rate limiter you must install a special ddp-rate-limiter package.

---

@stubailo commented on Tue Nov 03 2015

Yes, we don't do a good job listing in the docs when you need to add a certain package. For example, this is also the case with ReactiveVar.

Meteor.onConnect: does `idString` change after a reconnect?

The docs [1] describe idString as A globally unique id for this connection.

I'm trying to figure out if the idString is subject to change when a client reconnects after dropping out, or if the reconnect establishes the same idString as before.

[1] http://docs.meteor.com/api/connections.html#Meteor-onConnection

Remove `Meteor.users` `profile` usage

@ffxsam commented on Sat Jan 16 2016

The guide says:

The best way to store your custom data onto the Meteor.users collection is to add a new uniquely-named top-level field on the user document.

I thought it was encouraged to use the profile object, per the official docs?

Meteor.users.update(userId, {$set: {'profile.nickname': 'MegaBob'}});

---

@stubailo commented on Sun Jan 17 2016

No in fact there are multiple sections in the guide that say not to use profile. We should change the docs.

---

@ffxsam commented on Sun Jan 17 2016

Oh shoot. And here I just misinformed someone. 😞 Thanks for the tip.

---

@stubailo commented on Thu Apr 07 2016

Moved to meteor/meteor

BrowserPolicy

Moved from meteor/meteor#6766:

The solution was that in order to use BrowserPolicy it must be included! But from where!?

From Here:

import { BrowserPolicy } from 'meteor/browser-policy-common';

I guess this entire package needs to be documented? There is some debate in #6766 about whether it should be from browser-policy-common or browser-policy, but either way, this needs to be documented and it's likely that it can be exported from both for reverse-compatibility.

Original Issue

I have installed the browser-policy package (meteor add browser-policy) and set up some rules:

BrowserPolicy.framing.disallow();
BrowserPolicy.content.disallowEval();
BrowserPolicy.content.disallowObject();
BrowserPolicy.content.disallowInlineScripts();
BrowserPolicy.content.disallowFont();

The Meteor Guide recommends the Airbnb javascript style guide, which requires that BrowserPolicy be defined/imported before making the above declarations. Not being able to import the BrowserPolicy variable results in ESLint errors, which causes the test suite (meteor npm run test) to fail.

DDP.connect `options` parameter

DDP.connect is documented, but options are omitted. I realized just after I moved this that this is because they're not in the jsdoc definition.

@sanjo commented on Sat Feb 28 2015

You can pass options when creating a DDP connection with DDP.connect. But currently those are not documented and I had to dig through the code. I'm not sure if this is intentional, so I open this issue.

Available options can be found here: https://github.com/meteor/meteor/blob/devel/packages/ddp/livedata_connection.js#L29-L64

{% dtdd name:"someName" type:"SomeType" %} Not rendering properly?

It seems like the main site is mashing this:
{% dtdd name:"connected" type:"Boolean" %}

Into this:
-> connectedBoolean

I would imagine it should be rendering something like this instead:
-> connected [Boolean]

It confused me for a while as i had just assumed someoned had named the variables after their type.

The example is from http://docs.meteor.com/api/connections.html , but it is all over.

Use Hypothesis for commenting/annotating docs

I think it would be great to be able to use Hypothesis for commenting/annotating docs.

Mal-formatted object property description for validateLoginAttempt

Related to #41

See screenshot

All docs on one site

Please create a way to have all docs displayed on one large website. This really allows quick jumping back and forth, searching, navigating. It also works offline nicely.

Docs show empty square brackets if there's no type

When there's no type in options, it shows empty square brackets, as shown in the following screenshot:

During my fix to #60 which was fixed by #67, I failed to account for this use case.
Creating a PR to fix this.

Nested Helper explanation needs example or two

@Maxhodges commented on Sun Mar 01 2015

No matter how many times I read this, I can't be sure what it's saying. Please provide an example or two.

Nested Helper: If there is a positional argument followed by other (positional or keyword arguments), the first argument is called on the others using the normal helper argument calling convention.

---

@Maxhodges commented on Sun Mar 01 2015

is this right?

Passing helperB to helperA
{{helperA helperB}}

Passing 'helperB with argument x' to helperA
{{helperA helperB x}}

Passing 'helperB with argument x=false' to helperA
{{helperA helperB x=false}}

---

@stubailo commented on Tue Mar 10 2015

@Maxhodges, looks like you have it correct. I agree that this is confusing. Can you point me to the part of the documentation that has that sentence?

---

@abernix commented on Wed Aug 03 2016

I'm moving this to the docs repo. This is in the Spacebars docs here: https://docs.meteor.com/packages/spacebars.html

@Maxhodges I realize this issue is super old but I'm sure the community would appreciate a pull-request to make this more clear if you get a chance. I think the examples you provided are helpful too.

Guide v Docs

Let's add a guideline to Contributing.md saying what stuff to put where

Generally docs is what it does, and guide is opinionated long form ("articles") on how to use it? But guide has a good bit of "what it does" too, eg build tool section, mobile.

For example, this should be docs because it's "what it does"? meteor/guide#457

And we've got some overlap, eg with modules, which we should probably keep down, but it makes sense for long form articles to sometimes include information from the docs.

Accounts.onLogout is listed as only for "server"

The new onLogout method for Accounts is currently listed in the AccountsServer section but should be in AccountsCommon (with it's partner, onLogin) since it's actually in the common code and available "Anywhere".

Incoming PR if this sounds correct. ;-)

Contributing info placement

From my observations (of myself 😳) I'm guessing a lot of people who A) submit issues, or even B) submit PRs don't read Contributing.mds.

There are 5 places to consider:

• readme
• contributing
• issue template
• pr template
• "Please review the guidelines for contributing to this repository." link to contributing that appears above issues and PR forms

Atm we have:

• Guide
  • readme just links to guide,
  • contributing talks about PRs.
• Docs
  • readme: links to docs.meteor, links to contributing, how to run locally
  • contributing to meteor documentation in general – docs, guide, tutorials. PRs and issues, becoming a maintainer
• Meteor
  • contributing links to https://github.com/meteor/docs

To make it more likely for people to read the info, I'd like to move the content of docs and guide contributings to readmes and just have a link in contributing that points to readme. Maintain the first readme CTA as the site link, as in current docs readme. Docs readme will have the extra general sections, and both will have some duplicated hexo running and editing syntax rules. Table of contents so it's not overwhelming. No issue templates. Pr templates short and tactical, like https://github.com/meteor/guide/pull/440/files And then also linking from todos/readme and tutorials/readme to docs/readme.

Return value of findOne is not specified for special cases

Return value of Mongo.Collection#findOne([selector], [options]) is not specified for case where there is no matching document.

Return value is also not specified for case where subscription is not yet ready.

Search misses some stuff (API method in code snippet)

I made no extensive checking but the one thing I tested failed:

Search for isapptest in the guide. No results.
Go to testing section, press Ctrl-F and search isapptest find it as expected.

Facts!

Perhaps the facts package should be documented? It's currently only briefly talked about here, but can be quite helpful – but is a bit advanced at the moment (docs could help make this a lot easier to understand):

https://github.com/meteor/docs/blob/version-NEXT/long-form/oplog-observe-driver.md#how-to-tell-if-your-queries-are-using-oplogobservedriver

Docs show empty square brackets if there's no type

When there's no type in options, it shows empty square brackets, as shown in the following screenshot:

During my fix to #60 which was fixed by #67, I failed to account for this use case.
Creating a PR to fix this.

Should not forbid rescaling viewport

@awwx commented on Wed May 25 2016

<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">

Please, please, please: do not turn off user-scalable.

Not all of us have eyes that can read tiny fonts.

Documentation about pollingIntervalMs and pollingThrottleMs is unclear

Moved from meteor/meteor#7538

Original by @ignl

I am not sure if documentation is correct for Collection-find. In this blog post settings for Livedata optimization are called pollingInterval and pollingThrottle. Also I am not sure if default for pollingIntervalMs is really 10s? I tried various combinations but couldn't get it to work on meteor 1.4.0.1. Currently I try like this serverside:

messages.find({'metadata.thread': threadId}, {sort: {'date' : sort}, limit: limit, pollingThrottle: 12000, pollingInterval: 12000});

I expect a new message to be pushed to other client every 12s, but it seems meteor just updates them immediately anyway. Is this a correct way to do it?

Improve module docs

1. api.mainModule is documented under modules. Should link to it from Package.js section
2. How to import/export using CommonJS, if you haven't added ecmascript, or if you use coffeescript: meteor/meteor#6636

Migrated from meteor/guide#401

Where is ReactiveDict package documented?

This seems like a pretty core package and is a better replacement for Session, which is documented and only exists for legacy purposes as it is built using ReactiveDict anyway. Looks like there was an old issue meteor/meteor#4100

Also, ReactiveDict has some functions not in Session such as all, clear and delete.

Session and ReactiveDict both have a setDefault function that is not documented in Session docs either.

Host previous versions of the docs

would be nicer than current solution:

http://stackoverflow.com/questions/22871093/archived-meteor-documentation

Hexo server failure on `Assests.addAbsoluteFilePath`

I've been having an issue running the documentation locally after running git submodule update --init, npm install, and npm start on meteor/docs branch master.

Hexo is failing due to error:

API Data not found: Assets.absoluteFilePath

---

The full error message:

> hexo server

INFO  Start processing
API Data not found: Assets.absoluteFilePath
FATAL Something's wrong. Maybe you can find the solution here: http://hexo.io/docs/troubleshooting.html
Template render error: (unknown path)
  TypeError: Cannot read property 'replace' of undefined
    at Object.exports.prettifyError (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/lib.js:34:15)
    at /Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:485:31
    at root [as rootRenderFunc] (eval at <anonymous> (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:564:24), <anonymous>:22:3)
    at Obj.extend.render (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:478:15)
    at Obj.extend.renderString (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:326:21)
    at /Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/extend/tag.js:66:9
    at Promise._execute (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/debuggability.js:272:9)
    at Promise._resolveFromExecutor (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:475:18)
    at new Promise (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:77:14)
    at Tag.render (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/extend/tag.js:64:10)
    at Object.tagFilter [as onRenderEnd] (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/hexo/post.js:253:16)
    at /Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/hexo/render.js:65:19
    at tryCatcher (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/util.js:16:23)
    at Promise._settlePromiseFromHandler (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:504:31)
    at Promise._settlePromise (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:561:18)
    at Promise._settlePromise0 (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:606:10)
    at Promise._settlePromises (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:685:18)
FATAL (unknown path)
  TypeError: Cannot read property 'replace' of undefined
Template render error: (unknown path)
  TypeError: Cannot read property 'replace' of undefined
    at Object.exports.prettifyError (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/lib.js:34:15)
    at /Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:485:31
    at root [as rootRenderFunc] (eval at <anonymous> (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:564:24), <anonymous>:22:3)
    at Obj.extend.render (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:478:15)
    at Obj.extend.renderString (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/nunjucks/src/environment.js:326:21)
    at /Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/extend/tag.js:66:9
    at Promise._execute (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/debuggability.js:272:9)
    at Promise._resolveFromExecutor (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:475:18)
    at new Promise (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:77:14)
    at Tag.render (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/extend/tag.js:64:10)
    at Object.tagFilter [as onRenderEnd] (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/hexo/post.js:253:16)
    at /Users/CASE/Documents/JYProgramming/other/docs/node_modules/hexo/lib/hexo/render.js:65:19
    at tryCatcher (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/util.js:16:23)
    at Promise._settlePromiseFromHandler (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:504:31)
    at Promise._settlePromise (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:561:18)
    at Promise._settlePromise0 (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:606:10)
    at Promise._settlePromises (/Users/CASE/Documents/JYProgramming/other/docs/node_modules/bluebird/js/release/promise.js:685:18)

npm ERR! Darwin 15.5.0
npm ERR! argv "/usr/local/bin/node" "/usr/local/bin/npm" "start"
npm ERR! node v4.0.0
npm ERR! npm  v3.7.3
npm ERR! code ELIFECYCLE
npm ERR! [email protected] start: `hexo server`
npm ERR! Exit status 2
npm ERR!
npm ERR! Failed at the [email protected] start script 'hexo server'.
npm ERR! Make sure you have the latest version of node.js and npm installed.
npm ERR! If you do, this is most likely a problem with the hexo-site package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR!     hexo server
npm ERR! You can get information on how to open an issue for this project with:
npm ERR!     npm bugs hexo-site
npm ERR! Or if that isn't available, you can get their info via:
npm ERR!     npm owner ls hexo-site
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR!     /Users/CASE/Documents/JYProgramming/other/docs/npm-debug.log

Link to individual Guide articles?

In addition to the general link already in the intro.

For instance from somewhere in here:

to here:

http://guide.meteor.com/blaze.html

How to parse information from Mongo collection and pass it to email?

I want to send last 7days entries from my collection. I used the code below and I got the email with text: [Object, object]

Question is: How to make appear collection in the email and how to display records just from last 7 days?

Meteor.methods({
  sendEmail: function (to, from, subject, text) {
    Email.send({
      to: to,
      from: from,
      subject: subject,
      html: text
    });
  }
});
Meteor.methods({
  'feedbacks.insert'(emoji, feed, timeSet) {
    FeedbacksList.insert({
      feedback: emoji,
      knowFrom: feed,
      createdAt: timeSet
    });
  }
});

var myMessages = FeedbacksList.find({}).toString();

SyncedCron.add({
  name: 'Jura Ataskaitos',
    schedule: function(parser) {
      return parser.text('at 9:00 am on Mon'); // every 1 min
    },
    job: function() {
      const sendM = Meteor.call(
        'sendEmail',
        '[email protected]',
        '[email protected]',
        'test',
        myMessages
      );
      return sendM;
    }
  }
);

SyncedCron.start();

Double escaping of colons in code blocks `/:`

Add section on directory structure

Eg what you should put in public/. Where should this section go?

Edit on GitHub links on the bottom do not work

Example: http://docs.meteor.com/api/methods.html

There is a link on the bottom which points to: https://github.com/meteor/guide/tree/master/content/api/methods.md

Parameters to onLogout(func) callback not documented

I suppose the callback receives the same parameter as the callback to onLoginFailure but it isn't documented. Tnx.

Functionality loss: Harder to find APIs with new docs.

I love the new look and feel of the docs and contents browsing. BUT...

I have lost a major functionality. The old docs had the entirety of the API in the sidebar. So I could search for an API by searching the sidebar. Then I could find the result in the sidebar in context with other APIs.

The new docs do not have a search and even if search was available it would be a loss in functionality because I would rather see the result in context with other APIs.

Come to think of it, that is a problem with the guide also. I cannot easily search the entire table of contents and I have wrestled with finding things in the guide as a consequence.

In the interim is there a link to the old docs available?

Request

Display the entire API in the sidebar like the old docs.
Display the entire TOC for the guide in the sidebar.

Bonus

Add sidebar search that jumps you to the location of the API in context with the rest of the API.
Limiting the list of APIs like underscore does is less desirable.

Move Command Line section up?

People might not find it unless they scroll down the sidebar. Think I'd prefer above API, but above Packages also works

could not start, node 6.2.0

bob@pc /foo $ git clone https://github.com/meteor/docs.git
Cloning into 'docs'...
remote: Counting objects: 8052, done.
remote: Compressing objects: 100% (17/17), done.
remote: Total 8052 (delta 5), reused 0 (delta 0), pack-reused 8035
Receiving objects: 100% (8052/8052), 3.65 MiB | 1.26 MiB/s, done.
Resolving deltas: 100% (4763/4763), done.
Checking connectivity... done.

bob@pc /foo $ cd docs/

bob@pc /foo/docs $ git submodule update --init
Submodule 'code' (https://github.com/meteor/meteor.git) registered for path 'code'
Submodule 'themes/meteor' (https://github.com/meteor/hexo-theme-meteor.git) registered for path 'themes/meteor'
Cloning into 'code'...
remote: Counting objects: 149207, done.
remote: Compressing objects: 100% (523/523), done.
remote: Total 149207 (delta 265), reused 0 (delta 0), pack-reused 148680
Receiving objects: 100% (149207/149207), 62.21 MiB | 6.04 MiB/s, done.
Resolving deltas: 100% (107611/107611), done.
Checking connectivity... done.
Submodule path 'code': checked out '85037369f927321f28248fecd08137bbe1eae86c'
Cloning into 'themes/meteor'...
remote: Counting objects: 905, done.
remote: Total 905 (delta 0), reused 0 (delta 0), pack-reused 905
Receiving objects: 100% (905/905), 1.22 MiB | 386.00 KiB/s, done.
Resolving deltas: 100% (419/419), done.
Checking connectivity... done.
Submodule path 'themes/meteor': checked out '3325ae7aa750ab66d3b005cd3cca563d069880d3'

bob@pc /foo/docs $ npm install
npm WARN deprecated [email protected]: cross-spawn no longer requires a build toolchain, use it instead!
npm WARN deprecated [email protected]: graceful-fs v3.0.0 and before will fail on node releases >= v7.0. Please update to graceful-fs@^4.0.0 as soon as possible. Use 'npm ls graceful-fs' to find it in the tree.
npm WARN deprecated [email protected]: wrench.js is deprecated! You should check out fs-extra (https://github.com/jprichardson/node-fs-extra) for any operations you were using wrench for. Thanks for all the usage over the years.
npm WARN deprecated [email protected]: renamed to d3-queue
npm WARN prefer global [email protected] should be installed with -g
npm WARN prefer global [email protected] should be installed with -g
npm WARN prefer global [email protected] should be installed with -g

> [email protected] install /foo/docs/node_modules/dtrace-provider
> node scripts/install.js


> [email protected] install /foo/docs/node_modules/leveldown
> prebuild --install


> [email protected] postinstall /foo/docs/node_modules/spawn-sync
> node postinstall


> [email protected] postinstall /foo/docs/node_modules/hexo-util
> npm run build:highlight


> [email protected] build:highlight /foo/docs/node_modules/hexo-util
> node scripts/build_highlight_alias.js > highlight_alias.json

[email protected] /foo/docs
├── [email protected] 
├─┬ [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ ├── [email protected] 
│ │ └── [email protected] 
│ ├─┬ [email protected] 
│ │ └── [email protected] 
│ └─┬ [email protected] 
│   ├── [email protected] 
│   ├── [email protected] 
│   ├── [email protected] 
│   └─┬ [email protected] 
│     ├── [email protected] 
│     ├─┬ [email protected] 
│     │ ├─┬ [email protected] 
│     │ │ ├─┬ [email protected] 
│     │ │ │ ├── [email protected] 
│     │ │ │ └── [email protected] 
│     │ │ └── [email protected] 
│     │ ├── [email protected] 
│     │ └── [email protected] 
│     └── [email protected] 
├─┬ [email protected] 
│ ├── [email protected] 
│ ├── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ ├── [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ └── [email protected] 
│ │ ├── [email protected] 
│ │ └── [email protected] 
│ ├─┬ [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ ├── [email protected] 
│ │ │ ├── [email protected] 
│ │ │ ├── [email protected] 
│ │ │ └── [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ └── [email protected] 
│ │ ├── [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ ├── [email protected] 
│ │ │ ├── [email protected] 
│ │ │ ├── [email protected] 
│ │ │ └─┬ [email protected] 
│ │ │   └── [email protected] 
│ │ └─┬ [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├─┬ [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├─┬ [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ └── [email protected] 
│ │   │ └── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├─┬ [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├─┬ [email protected] 
│ │   │ │ └─┬ [email protected] 
│ │   │ │   └── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├─┬ [email protected] 
│ │   │ │ └── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├─┬ [email protected] 
│ │   │ │ ├─┬ [email protected] 
│ │   │ │ │ └── [email protected] 
│ │   │ │ ├─┬ [email protected] 
│ │   │ │ │ ├── [email protected] 
│ │   │ │ │ ├─┬ [email protected] 
│ │   │ │ │ │ └── [email protected] 
│ │   │ │ │ └── [email protected] 
│ │   │ │ └─┬ [email protected] 
│ │   │ │   └── [email protected] 
│ │   │ ├─┬ [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ └── [email protected] 
│ │   │ ├─┬ [email protected] 
│ │   │ │ ├── [email protected] 
│ │   │ │ ├─┬ [email protected] 
│ │   │ │ │ ├── [email protected] 
│ │   │ │ │ ├── [email protected] 
│ │   │ │ │ └── [email protected] 
│ │   │ │ └─┬ [email protected] 
│ │   │ │   ├── [email protected] 
│ │   │ │   ├── [email protected] 
│ │   │ │   ├─┬ [email protected] 
│ │   │ │   │ └── [email protected] 
│ │   │ │   ├── [email protected] 
│ │   │ │   ├─┬ [email protected] 
│ │   │ │   │ └── [email protected] 
│ │   │ │   ├── [email protected] 
│ │   │ │   ├── [email protected] 
│ │   │ │   └── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ ├── [email protected] 
│ │   │ └── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├─┬ [email protected] 
│ │   │ └── [email protected] 
│ │   └── [email protected] 
│ ├─┬ [email protected] 
│ │ └── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ ├─┬ [email protected] 
│ │ │ │ ├── [email protected] 
│ │ │ │ └─┬ [email protected] 
│ │ │ │   ├─┬ [email protected] 
│ │ │ │   │ └── [email protected] 
│ │ │ │   ├── [email protected] 
│ │ │ │   ├─┬ [email protected] 
│ │ │ │   │ ├─┬ [email protected] 
│ │ │ │   │ │ └─┬ [email protected] 
│ │ │ │   │ │   ├── [email protected] 
│ │ │ │   │ │   ├─┬ [email protected] 
│ │ │ │   │ │   │ └── [email protected] 
│ │ │ │   │ │   └── [email protected] 
│ │ │ │   │ ├── [email protected] 
│ │ │ │   │ └── [email protected] 
│ │ │ │   ├─┬ [email protected] 
│ │ │ │   │ └── [email protected] 
│ │ │ │   ├── [email protected] 
│ │ │ │   ├── [email protected] 
│ │ │ │   ├─┬ [email protected] 
│ │ │ │   │ └── [email protected] 
│ │ │ │   ├── [email protected] 
│ │ │ │   ├─┬ [email protected] 
│ │ │ │   │ ├─┬ [email protected] 
│ │ │ │   │ │ └── [email protected] 
│ │ │ │   │ └── [email protected] 
│ │ │ │   ├─┬ [email protected] 
│ │ │ │   │ ├── [email protected] 
│ │ │ │   │ └── [email protected] 
│ │ │ │   └─┬ [email protected] 
│ │ │ │     ├── [email protected] 
│ │ │ │     └── [email protected] 
│ │ │ ├── [email protected] 
│ │ │ ├── [email protected] 
│ │ │ ├── [email protected] 
│ │ │ ├─┬ [email protected] 
│ │ │ │ └── [email protected] 
│ │ │ ├─┬ [email protected] 
│ │ │ │ └── [email protected] 
│ │ │ └── [email protected] 
│ │ └── [email protected] 
│ ├─┬ [email protected] 
│ │ └── [email protected] 
│ ├─┬ [email protected] 
│ │ └─┬ [email protected] 
│ │   ├── [email protected] 
│ │   ├─┬ [email protected] 
│ │   │ ├── [email protected] 
│ │   │ └─┬ [email protected] 
│ │   │   └─┬ [email protected] 
│ │   │     └── [email protected] 
│ │   └── [email protected] 
│ ├─┬ [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ ├─┬ [email protected] 
│ │ │ │ └── [email protected] 
│ │ │ └── [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ ├─┬ [email protected] 
│ │ │ │ ├─┬ [email protected] 
│ │ │ │ │ ├── [email protected] 
│ │ │ │ │ └── [email protected] 
│ │ │ │ └─┬ [email protected] 
│ │ │ │   └── [email protected] 
│ │ │ └─┬ [email protected] 
│ │ │   ├─┬ [email protected] 
│ │ │   │ ├─┬ [email protected] 
│ │ │   │ │ └── [email protected] 
│ │ │   │ └── [email protected] 
│ │ │   └── [email protected] 
│ │ ├── [email protected] 
│ │ ├── [email protected] 
│ │ └── [email protected] 
│ ├─┬ [email protected] 
│ │ ├── [email protected] 
│ │ └── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ └─┬ [email protected] 
│ │   ├── [email protected] 
│ │   └── [email protected] 
│ ├── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ ├── [email protected] 
│ │ └─┬ [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   └── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ └── [email protected] 
│ ├─┬ [email protected] 
│ │ └─┬ [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   └─┬ [email protected] 
│ │     └── [email protected] 
│ ├─┬ [email protected] 
│ │ └─┬ [email protected] 
│ │   └── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ └── [email protected] 
│ ├── [email protected] 
│ └─┬ [email protected] 
│   ├─┬ [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ └── [email protected] 
│   ├─┬ [email protected] 
│   │ └── [email protected] 
│   └─┬ [email protected] 
│     ├── [email protected] 
│     └── [email protected] 
├─┬ [email protected] 
│ ├─┬ [email protected] 
│ │ └── [email protected] 
│ └── [email protected] 
├─┬ [email protected] 
│ └── [email protected] 
├─┬ [email protected] 
│ └── [email protected] 
├─┬ [email protected] 
│ └── [email protected] 
├─┬ [email protected] 
│ ├── [email protected] 
│ └── [email protected] 
├─┬ [email protected] 
│ └─┬ [email protected] 
│   ├─┬ [email protected] 
│   │ └── [email protected] 
│   ├── [email protected] 
│   ├── [email protected] 
│   ├─┬ [email protected] 
│   │ └── [email protected] 
│   ├─┬ [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├─┬ [email protected] 
│   │ │ ├── [email protected] 
│   │ │ └─┬ [email protected] 
│   │ │   └── [email protected] 
│   │ ├─┬ [email protected] 
│   │ │ ├── [email protected] 
│   │ │ ├── [email protected] 
│   │ │ ├── [email protected] 
│   │ │ └── [email protected] 
│   │ ├─┬ [email protected] 
│   │ │ ├── [email protected] 
│   │ │ ├── [email protected] 
│   │ │ └── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ └── [email protected] 
│   └── [email protected] 
├─┬ [email protected] 
│ └── [email protected] 
├─┬ [email protected] 
│ ├─┬ [email protected] 
│ │ └─┬ [email protected] 
│ │   ├─┬ [email protected] 
│ │   │ └─┬ [email protected] 
│ │   │   └── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   └── [email protected] 
│ └─┬ [email protected] 
│   ├── [email protected] 
│   ├─┬ [email protected] 
│   │ └── [email protected] 
│   ├─┬ [email protected] 
│   │ └─┬ [email protected] 
│   │   ├── [email protected] 
│   │   └── [email protected] 
│   ├── [email protected] 
│   └── [email protected] 
├─┬ [email protected] 
│ ├─┬ [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ └─┬ [email protected] 
│ │ │   ├─┬ [email protected] 
│ │ │   │ └── [email protected] 
│ │ │   ├── [email protected] 
│ │ │   ├─┬ [email protected] 
│ │ │   │ └─┬ [email protected] 
│ │ │   │   └── [email protected] 
│ │ │   ├── [email protected] 
│ │ │   ├── [email protected] 
│ │ │   └── [email protected] 
│ │ └─┬ [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   └─┬ [email protected] 
│ │     ├── [email protected] 
│ │     ├─┬ [email protected] 
│ │     │ ├── [email protected] 
│ │     │ ├── [email protected] 
│ │     │ ├─┬ [email protected] 
│ │     │ │ └─┬ [email protected] 
│ │     │ │   ├─┬ [email protected] 
│ │     │ │   │ └─┬ [email protected] 
│ │     │ │   │   └── [email protected] 
│ │     │ │   └─┬ [email protected] 
│ │     │ │     ├── [email protected] 
│ │     │ │     └─┬ [email protected] 
│ │     │ │       └── [email protected] 
│ │     │ ├── [email protected] 
│ │     │ └── [email protected] 
│ │     ├── [email protected] 
│ │     ├── [email protected] 
│ │     ├─┬ [email protected] 
│ │     │ ├── [email protected] 
│ │     │ ├─┬ [email protected] 
│ │     │ │ └── [email protected] 
│ │     │ ├─┬ [email protected] 
│ │     │ │ └── [email protected] 
│ │     │ ├─┬ [email protected] 
│ │     │ │ └── [email protected] 
│ │     │ ├─┬ [email protected] 
│ │     │ │ └─┬ [email protected] 
│ │     │ │   └─┬ [email protected] 
│ │     │ │     ├── [email protected] 
│ │     │ │     └─┬ [email protected] 
│ │     │ │       ├── [email protected] 
│ │     │ │       └── [email protected] 
│ │     │ └─┬ [email protected] 
│ │     │   └── [email protected] 
│ │     ├─┬ [email protected] 
│ │     │ ├─┬ [email protected] 
│ │     │ │ └── [email protected] 
│ │     │ └─┬ [email protected] 
│ │     │   └── [email protected] 
│ │     ├── [email protected] 
│ │     ├─┬ [email protected] 
│ │     │ ├── [email protected] 
│ │     │ ├─┬ [email protected] 
│ │     │ │ └── [email protected] 
│ │     │ └─┬ [email protected] 
│ │     │   ├── [email protected] 
│ │     │   ├─┬ [email protected] 
│ │     │   │ ├── [email protected] 
│ │     │   │ ├── [email protected] 
│ │     │   │ └── [email protected] 
│ │     │   ├── [email protected] 
│ │     │   └── [email protected] 
│ │     ├─┬ [email protected] 
│ │     │ ├── [email protected] 
│ │     │ └─┬ [email protected] 
│ │     │   └── [email protected] 
│ │     ├─┬ [email protected] 
│ │     │ ├── [email protected] 
│ │     │ ├── [email protected] 
│ │     │ └── [email protected] 
│ │     ├─┬ [email protected] 
│ │     │ └── [email protected] 
│ │     ├── [email protected] 
│ │     └─┬ [email protected] 
│ │       └─┬ [email protected] 
│ │         └── [email protected] 
│ ├─┬ [email protected] 
│ │ ├── [email protected] 
│ │ └─┬ [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   ├── [email protected] 
│ │   └── [email protected] 
│ └─┬ [email protected] 
│   ├── [email protected] 
│   ├── [email protected] 
│   ├─┬ [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ ├── [email protected] 
│   │ └─┬ [email protected] 
│   │   └── [email protected] 
│   ├─┬ [email protected] 
│   │ ├── [email protected] 
│   │ ├─┬ [email protected] 
│   │ │ └── [email protected] 
│   │ └─┬ [email protected] 
│   │   └── [email protected] 
│   ├─┬ [email protected] 
│   │ └─┬ [email protected] 
│   │   └─┬ [email protected] 
│   │     └── [email protected] 
│   ├── [email protected] 
│   ├── [email protected] 
│   └── [email protected] 
├─┬ [email protected] 
│ ├─┬ [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ ├── [email protected] 
│ │ │ └── [email protected] 
│ │ ├── [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ └── [email protected] 
│ │ ├── [email protected] 
│ │ └── [email protected] 
│ ├─┬ [email protected] 
│ │ ├─┬ [email protected] 
│ │ │ └── [email protected] 
│ │ └── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ ├── [email protected] 
│ │ ├── [email protected] 
│ │ └─┬ [email protected] 
│ │   └── [email protected] 
│ ├── [email protected] 
│ └─┬ [email protected] 
│   ├── [email protected] 
│   └─┬ [email protected] 
│     ├── [email protected] 
│     ├── [email protected] 
│     ├── [email protected] 
│     ├── [email protected] 
│     ├── [email protected] 
│     ├── [email protected] 
│     └── [email protected] 
├─┬ [email protected]  (git+https://github.com/jsdoc3/jsdoc.git#407bd470cde2dcb2745c217411fe8f9406cb694d)
│ ├── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ └─┬ [email protected] 
│ │   └── [email protected] 
│ ├── [email protected] 
│ ├── [email protected] 
│ ├── [email protected] 
│ ├─┬ [email protected] 
│ │ └── [email protected] 
│ ├── [email protected] 
│ ├── [email protected] 
│ └── [email protected] 
├─┬ [email protected] 
│ └─┬ [email protected] 
│   ├── [email protected] 
│   ├─┬ [email protected] 
│   │ └── [email protected] 
│   ├── [email protected] 
│   ├─┬ [email protected] 
│   │ └─┬ [email protected] 
│   │   └── [email protected] 
│   ├─┬ [email protected] 
│   │ ├─┬ [email protected] 
│   │ │ └── [email protected] 
│   │ └── [email protected] 
│   ├── [email protected] 
│   └── [email protected] 
└── [email protected] 

npm WARN optional Skipping failed optional dependency /chokidar/fsevents:
npm WARN notsup Not compatible with your operating system or architecture: [email protected]

bob@pc /foo/docs $ npm start

> [email protected] prestart /foo/docs
> jsdoc/jsdoc.sh

/foo/docs/node_modules/.bin/jsdoc -t /foo/docs/jsdoc/docdata-jsdoc-template -c /foo/docs/jsdoc/jsdoc-conf.json packages/accounts-base/accounts_client.js packages/accounts-base/accounts_common.js packages/accounts-base/accounts_server.js packages/accounts-base/client_main.js packages/accounts-base/server_main.js packages/accounts-base/url_client.js packages/accounts-oauth/oauth_client.js packages/accounts-password/email_templates.js packages/accounts-password/password_client.js packages/accounts-password/password_server.js packages/accounts-ui-unstyled/accounts_ui.js packages/allow-deny/allow-deny.js packages/blaze/builtins.js packages/blaze/preamble.js packages/blaze/template.js packages/blaze/view.js packages/check/match.js packages/ddp-client/livedata_connection.js packages/ddp-client/namespace.js packages/ddp-common/method_invocation.js packages/ddp-common/namespace.js packages/ddp-rate-limiter/ddp-rate-limiter.js packages/ddp-server/livedata_server.js packages/ejson/ejson.js packages/email/email.js packages/http/httpcall_client.js packages/http/httpcall_common.js packages/meteor/client_environment.js packages/meteor/cordova_environment.js packages/meteor/errors.js packages/meteor/helpers.js packages/meteor/startup_client.js packages/meteor/timers.js packages/meteor/url_common.js packages/minimongo/minimongo.js packages/mongo/collection.js packages/reactive-var/reactive-var.js packages/session/session.js packages/templating/dynamic.js packages/templating/templating.js packages/tracker/tracker.js scripts/admin/jsdoc/docdata-jsdoc-template/publish.js scripts/admin/jsdoc/jsdoc.sh tools/cordova/builder.js tools/isobuild/build-plugin.js tools/isobuild/bundler.js tools/isobuild/compiler-deprecated-compile-step.js tools/isobuild/compiler-plugin.js tools/isobuild/isopack.js tools/isobuild/minifier-plugin.js tools/isobuild/package-api.js tools/isobuild/package-source.js tools/static-assets/server/boot.js tools/utils/processes.js 

> [email protected] start /foo/docs
> hexo server

(node:916) fs: re-evaluating native module sources is not supported. If you are using the graceful-fs module, please update it to a more recent version.
INFO  Start processing
API Data not found: Assets.absoluteFilePath
FATAL Something's wrong. Maybe you can find the solution here: http://hexo.io/docs/troubleshooting.html
Template render error: (unknown path)
  TypeError: Cannot read property 'replace' of undefined                                                                                                                                        
    at Object.exports.prettifyError (/foo/docs/node_modules/nunjucks/src/lib.js:34:15)                                                                                           
    at /foo/docs/node_modules/nunjucks/src/environment.js:485:31                                                                                                                 
    at root [as rootRenderFunc] (eval at <anonymous> (/foo/docs/node_modules/nunjucks/src/environment.js:564:24), <anonymous>:22:3)                                              
    at Obj.extend.render (/foo/docs/node_modules/nunjucks/src/environment.js:478:15)                                                                                             
    at Obj.extend.renderString (/foo/docs/node_modules/nunjucks/src/environment.js:326:21)                                                                                       
    at /foo/docs/node_modules/hexo/lib/extend/tag.js:66:9                                                                                                                        
    at Promise._execute (/foo/docs/node_modules/bluebird/js/release/debuggability.js:272:9)                                                                                      
    at Promise._resolveFromExecutor (/foo/docs/node_modules/bluebird/js/release/promise.js:473:18)                                                                               
    at new Promise (/foo/docs/node_modules/bluebird/js/release/promise.js:77:14)                                                                                                 
    at Tag.render (/foo/docs/node_modules/hexo/lib/extend/tag.js:64:10)                                                                                                          
    at Object.tagFilter [as onRenderEnd] (/foo/docs/node_modules/hexo/lib/hexo/post.js:253:16)                                                                                   
    at /foo/docs/node_modules/hexo/lib/hexo/render.js:63:19                                                                                                                      
    at tryCatcher (/foo/docs/node_modules/bluebird/js/release/util.js:16:23)                                                                                                     
    at Promise._settlePromiseFromHandler (/foo/docs/node_modules/bluebird/js/release/promise.js:502:31)                                                                          
    at Promise._settlePromise (/foo/docs/node_modules/bluebird/js/release/promise.js:559:18)                                                                                     
    at Promise._settlePromise0 (/foo/docs/node_modules/bluebird/js/release/promise.js:604:10)                                                                                    
    at Promise._settlePromises (/foo/docs/node_modules/bluebird/js/release/promise.js:683:18)                                                                                    
    at Async._drainQueue (/foo/docs/node_modules/bluebird/js/release/async.js:138:16)                                                                                            
FATAL (unknown path)
  TypeError: Cannot read property 'replace' of undefined
Template render error: (unknown path)
  TypeError: Cannot read property 'replace' of undefined                                                                                                                                        
    at Object.exports.prettifyError (/foo/docs/node_modules/nunjucks/src/lib.js:34:15)                                                                                           
    at /foo/docs/node_modules/nunjucks/src/environment.js:485:31                                                                                                                 
    at root [as rootRenderFunc] (eval at <anonymous> (/foo/docs/node_modules/nunjucks/src/environment.js:564:24), <anonymous>:22:3)                                              
    at Obj.extend.render (/foo/docs/node_modules/nunjucks/src/environment.js:478:15)                                                                                             
    at Obj.extend.renderString (/foo/docs/node_modules/nunjucks/src/environment.js:326:21)                                                                                       
    at /foo/docs/node_modules/hexo/lib/extend/tag.js:66:9
    at Promise._execute (/foo/docs/node_modules/bluebird/js/release/debuggability.js:272:9)
    at Promise._resolveFromExecutor (/foo/docs/node_modules/bluebird/js/release/promise.js:473:18)
    at new Promise (/foo/docs/node_modules/bluebird/js/release/promise.js:77:14)
    at Tag.render (/foo/docs/node_modules/hexo/lib/extend/tag.js:64:10)
    at Object.tagFilter [as onRenderEnd] (/foo/docs/node_modules/hexo/lib/hexo/post.js:253:16)
    at /foo/docs/node_modules/hexo/lib/hexo/render.js:63:19
    at tryCatcher (/foo/docs/node_modules/bluebird/js/release/util.js:16:23)
    at Promise._settlePromiseFromHandler (/foo/docs/node_modules/bluebird/js/release/promise.js:502:31)
    at Promise._settlePromise (/foo/docs/node_modules/bluebird/js/release/promise.js:559:18)
    at Promise._settlePromise0 (/foo/docs/node_modules/bluebird/js/release/promise.js:604:10)
    at Promise._settlePromises (/foo/docs/node_modules/bluebird/js/release/promise.js:683:18)
    at Async._drainQueue (/foo/docs/node_modules/bluebird/js/release/async.js:138:16)

OAuth article

Does anyone know how oauth works? 🙏 help 😄

I've had problems with every cordova native fb auth package I've tried, and when I opened them up to work on it, and then looked at core facebook, google etc, I had no idea what was going on.

Migrated from meteor/meteor#3621

Document recommended createUser error handling

@lorensr commented on Tue Feb 03 2015

Let devs know that if error.reason is 'Email already exists.', they should tell the user that either they've already created an account, in which case they can try logging in, or someone else has signed up using their email, and they can recover the account by resetting the password.

http://docs.meteor.com/#/full/accounts_createuser

---

@glasser commented on Wed Feb 04 2015

Thanks for the docs feature request! You might be interested in reading our feature request guidelines.

Linting: add VS Code to list of editors

I was able to get things working with VS Code by following the Installing and running ESLint instructions and installing the VS Code ESLint extension. Perhaps this setup could be added to the guide section Integrating with your editor.

Explain universal publication

@lorensr commented on Sat Apr 09 2016

common questions

1. Why is Meteor.user() undefined? (see for example meteor/meteor#6745 (comment))
2. How do I publish different data about a user?

current docs

suggested additions

• Say what the universal/null publication contains by default (otherwise someone could overwrite it with non-user data and wonder why Meteor.user() stays undefined)
• Give an example on how to redefine it (and could subsume the userData publish example in
  http://docs.meteor.com/#/full/meteor_user ? or recommend people don't redefine it)

Meteor.user()

Get the current user record, or null if no user is logged in. A reactive data source.

• Add "or undefined if the universal publication[linked to description] isn't ready".
• Since there's no way to check whether the universal publication is ready, add "do Tracker.autorun -> Meteor.user()" to react to the user data being published.
• Say "use Meteor.userId() instead if you want to determine whether a user is logged in". (And perhaps put Meteor.userId() before Meteor.user() in docs)

"Type" is smashed up against options on some pages

http://docs.meteor.com/api/connections.html

As you can see the name of the option is connected and the type is Boolean, but it appears as connectedBoolean.

Most links within the body text appear to be broken

The links within the body text that point to locations within the documentation appear to all be broken. I'm using Chrome on Ubuntu.

For example, in the documentation for Meteor.publish, there are links to "added", "changed", and "removed" that don't work. The "added" link's target is https://docs.meteor.com/api/pubsub.html#publish_added. The "this.added" link in the sidebar has the value https://docs.meteor.com/api/pubsub.html#Subscription-added and works fine.

I stuck to links with targets within the section in that example because that is the simplest case, but the link to Collection.Cursor which is across sections in the text above that is broken too.

I'm having trouble believing that this is an issue that was either knowingly accepted or simply missed. It's too basic. But, I refreshed and even opened another browser (Firefox) to be sure I was using a different cache and the behavior didn't change.

I'd also note that I'm getting a strange behavior of seeing the old documentation style when I awake my computer from sleep and the browser had been left showing a page from the new documentation. I then hit F5 and the new documentation style reappears. Perhaps I'm getting some strange mix of old and new documentation.

Cannot find Accounts.createUser in docs

I just filed #30 because I was having a hard time finding Accounts.createUser.

Joke is on me! I think it has been especially hard because Accounts.createUser is not in the new docs. Is this a lapse or is the API being deprecated?

Or am I missing it?

Is there a pointer to the old docs available?

I assume that I cannot run locally on windows?
I tried the instructions but it failed trying to run jsdoc/jsdoc.sh

Include meteor/meteor/History.md in Docs

Currently, if you get a Meteor update to a new version, I'm not sure there is any clear path for you to see what has changed unless you're aware that GitHub is the place to go. There's a History.md which is well maintained, but it's hard to find as GitHub might not be the first place many users go. Aside from GitHub, Meteor.com would seem like the first logical place to head.

But even then, it appears the process would be something like this for many (most?) users:

• Go to Meteor.com
• (optional, but likely, path) Click on Install
  • See no Release Notes
  • Try the Docs/Guide links there?
• Click on Developer (at top)
  • Hmm, maybe Docs? or Guide?
• Get to Docs/Guide
  • Guide: See Migration Guides, but nothing per version. Click Docs (top right)
  • Docs: See nothing helpful. Click Guide.
  • Maybe go to Forums? But forums usually only has major releases.
• Try to find the code source?
  • No link to the meteor/meteor GitHub
  • Google?

It would be best if Meteor.com had a _tiny link to Release Notes under the "Install" button. Or at least on the Install page. Linking to the GitHub Repo might be abrupt UX (with no return path), so a nice option might be the Docs. Unfortunately, Docs doesn't have Release Notes to link to right now.

Since the code is already a submodule of docs, and code has a History.md, it seems like it might be possible to import this into Docs.

Seed planted by: meteor/meteor#7881 & meteor/meteor#7870, both opened this week and semi-related to: meteor/meteor#6730.

Options in DDP.connect isn't documented.

Posted by @ilacyero in meteor/meteor as meteor/meteor#7156 .

I had a problem to detect the connected state of DDP client connection.
I find in the documentation how to add this callback. I must debug the initialize to see the options and >its onConnected options. Please try to add in documentation.

const connection = DDP.connect(config, {
  onConnected() {
    console.log('connected');
  }
});

Clarify that Meteor.methods generate the same _id on the client and server

Moved from meteor/meteor#4780

I couldn't find this anywhere in the docs, so I think it's still undocumented. Please close if you know of its whereabouts.

Sashko commented on Tue Jul 21 2015

Except for this trello card: https://trello.com/c/moiiS2rP/57-pattern-for-creating-multiple-database-records-from-a-method

---

Justin commented on Tue Jul 21 2015

Indeed, https://github.com/meteor/meteor/blob/devel/packages/ddp/DDP.md says that it is deliberately undocumented 'pending stabilization'. Perhaps we can now consider it stable and document it!

---

Sashko commented on Tue Jul 21 2015

Yep, we should make sure to document it nearby the Methods section on docs.meteor.com as well.

User profile is not created when account is created with accounts-password

by @jrullmann on meteor/meteor#1369

The 3-year-old ancient issue

_1 Upvote_ From the docs:
"By default the profile option is added directly to the new user document."

So I expect that if a user creates an account with accounts-password then a profile should be created for her. Instead, I'm seeing that no profile is created.

Steps to reproduce:

1. Create the leaderboard example app (meteor create --example leaderboard)
2. Add accounts packages (meteor add accounts-ui accounts-password)
3. Add {{loginButtons}} to leaderboard.html
4. Run the app
5. Create an account with email/password
6. In the browser console, run Meteor.user().profile

Expected: Meteor.user().profile is an object
Actual: Meteor.user().profile is undefined

More info:

• I'm using meteor version 0.6.5
• If I follow these steps using accounts-twitter the profile is created as expected

Spacebars references?

The spacebars github repo used to contain a very useful readme.md.
This file now says it has been incorporated in the docs.
Except all the links are confused.

1. The link in the github readme is wrong. I submitted a PR for this.
2. The Templates section of the API docs has two links referencing the Spacebars readme.
   One points to the Athmosphere package, and the other one just points back to itself.

I tried editing these, but it looks like there is some auto-magic stuff supposed to be going on with the #pkg_spacebars reference, but that's not working....? So I left it and submit this issue instead.