Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

globals-docs

documentationjs246.8kISC2.4.1

documentation links for all node and browser globals

documentation, links, mdc, mozilla, developer, center, node

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

changelog

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.4.1 (2019-08-20)

2.4.0 (2017-12-05)

Features

  • Basic WebRTC types, improved build scripts (84f7df0), closes #5

2.3.1 (2017-12-04)

Bug Fixes

  • Fix tests, remove unused dependency (5b037d8)
  • Remove /en-US/ from Mozilla docs (#4) (95ce765)

2.3.0

  • feat(types): Add TypedArray TypedArray is not exactly an available global property or constructor but it is used to talk about typed array constructors in general. It is documented as a global in MDN and it would be useful to have it linked when an API accepts any typed array argument.<Paste>

2.1.0

  • Added deep-links for node.js event & stream APIs