Package Exports
- globals-docs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (globals-docs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
globals-docs
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