UNPKG

globals-docs

Version:

documentation links for all node and browser globals

42 lines (23 loc) • 779 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# globals-docs [![build status](https://secure.travis-ci.org/documentationjs/globals-docs.png)](http://travis-ci.org/documentationjs/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 ```js getDoc('Array'); // yields MDC documentation for Array ``` Returns the URL of the documentation resource, if found