globals-docs

documentation links for all node and browser globals

Usage no npm install needed!

<script type="module">
  import globalsDocs from 'https://cdn.skypack.dev/globals-docs';
</script>

README

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