https://github.com/documentationjs/globals-docs

Documentation URIs for JavaScript globals.
https://github.com/documentationjs/globals-docs

Last synced: 29 days ago
JSON representation

Documentation URIs for JavaScript globals.

• Host: GitHub
• URL: https://github.com/documentationjs/globals-docs
• Owner: documentationjs
• License: isc
• Created: 2015-05-27T02:33:43.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-07-13T21:42:58.000Z (over 5 years ago)
• Last Synced: 2026-03-01T14:10:47.960Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 70.3 KB
• Stars: 11
• Watchers: 8
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# globals-docs

[![build status](https://secure.travis-ci.org/documentationjs/globals-docs.svg)](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` | 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