meteor/meteor

View on GitHub
docs/assets/api-box.html

Summary

Maintainability
Test Coverage
<div class="api {{bare}} new-api-box">
  <div class="api-heading">
    <div class="locus">
      {{locus}}
    </div>

    <{{hTag}} title="{{{title}}}" class="title-api selflink" id={{id}}>
      <a href="#{{id}}" class="link primary">{{{signature}}}</a>
    </{{hTag}}>

    <div class="subtext-api">
      {{#if importName}}
        <div class="code">import { {{importName}} } from 'meteor/{{module}}'</div>
      {{/if}}

      {{#if filepath}}
        <a class="src-code link secondary" href="https://github.com/meteor/meteor/blob/master/packages/{{filepath}}#L{{lineno}}" target="_blank">
          ({{filepath}}, line {{lineno}})
        </a>
      {{/if}}
    </div>
  </div>

  <div class="api-body">
    <div class="desc">
      {{{markdown summary}}}
    </div>

    {{#if paramsNoOptions}}
      <h4 class="subheading">Arguments</h4>
      <dl class="args">
        {{#each paramsNoOptions}}
          <dt>
            <span class="name">{{name}}</span>
            <span class="type">{{{typeNames type.names}}}</span>
          </dt>
          <dd>
            {{{description}}}
          </dd>
        {{/each}}
      </dl>
    {{/if}}

    {{#if options}}
      <h4 class="subheading">Options</h4>
      <dl class="args">
        {{#each options}}
          <dt>
            <span class="name">{{name}}</span>
            <span class="type">{{{typeNames type.names}}}</span>
          </dt>
          <dd>
            {{{description}}}
          </dd>
        {{/each}}
      </dl>
    {{/if}}

    {{#if UI.contentBlock}}
    {{#markdown}}{{> UI.contentBlock}}{{/markdown}}
    {{/if}}
  </div>
</div>