kiruthiga 55473b7e7c initial push 5 days ago
..
scripts 55473b7e7c initial push 5 days ago
.travis.yml 55473b7e7c initial push 5 days ago
CHANGELOG.md 55473b7e7c initial push 5 days ago
LICENSE 55473b7e7c initial push 5 days ago
README.md 55473b7e7c initial push 5 days ago
globals-docs.json 55473b7e7c initial push 5 days ago
index.js 55473b7e7c initial push 5 days ago
package.json 55473b7e7c initial push 5 days ago

README.md

globals-docs

build status

Documentation URIs for JavaScript globals.

docs

Docs: an object of documentation as a plain-old-javascript object.

Has keys that correspond to environments:

  • builtin
  • nonstandard
  • browser
  • worker
  • node

getDoc

Get a URL for a global object.

Parameters

name type description
name string name of the global object
env Array<string> environments that will be reached. By default tries all environments

Examples

getDoc('Array'); // yields MDC documentation for Array

Returns the URL of the documentation resource, if found