2.4.1 • Published 5 years ago

globals-docs v2.4.1

Weekly downloads
59,244
License
ISC
Repository
github
Last release
5 years ago

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

nametypedescription
namestringname of the global object
envArray<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