# globals-docs

> documentation links for all node and browser globals

Latest version **2.4.1** (published 2019-08-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install globals-docs
pnpm add globals-docs
yarn add globals-docs
bun add globals-docs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.1 |
| Published | 2019-08-20 |
| First published | 2015-05-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 46.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Tom MacWright |
| Maintainers | tmcw |
| Keywords | documentation, links, mdc, mozilla, developer, center, node |

## Links

- npm: https://www.npmjs.com/package/globals-docs
- Repository: https://github.com/documentationjs/globals-docs
- Homepage: https://github.com/documentationjs/globals-docs#readme
- Issues: https://github.com/documentationjs/globals-docs/issues
- npm.io page: https://npm.io/package/globals-docs

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 2.4.1 (latest) — 2019-08-20
- 2.4.0 — 2017-12-05
- 2.3.1 — 2017-12-04
- 2.3.0 — 2016-12-13
- 2.2.0 — 2016-01-28
- 2.1.0 — 2015-07-21
- 2.0.2 — 2015-07-06
- 2.0.1 — 2015-05-27
- 2.0.0 — 2015-05-27
- 1.0.2 — 2015-05-27
- 1.0.1 — 2015-05-27

## 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<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

---
_Source: https://npm.io/package/globals-docs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._