Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 779 Bytes

README.md

File metadata and controls

41 lines (23 loc) · 779 Bytes

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