npm.io
2.4.1 • Published 7 years ago

globals-docs

Licence
ISC
Version
2.4.1
Deps
0
Size
47 kB
Vulns
0
Weekly
0
Stars
11

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

Keywords