# mdn-docs-search

> Searches the mdn docs

Latest version **1.0.9** (published 2018-12-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install mdn-docs-search
pnpm add mdn-docs-search
yarn add mdn-docs-search
bun add mdn-docs-search
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.9 |
| Published | 2018-12-24 |
| First published | 2018-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 21.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | waspothegreat |
| Maintainers | waspothegreat |

## Links

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

## Dependencies (4)

- [acorn](https://npm.io/package/acorn.md) ^6.0.4
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [html-markdown](https://npm.io/package/html-markdown.md) ^1.0.17
- [node-superfetch](https://npm.io/package/node-superfetch.md) ^0.1.9

## Recent versions

- 1.0.9 (latest) — 2018-12-24
- 1.0.8 — 2018-12-17
- 1.0.7 — 2018-12-06
- 1.0.6 — 2018-12-04
- 1.0.5 — 2018-12-03
- 1.0.4 — 2018-11-30
- 1.0.3 — 2018-11-24
- 1.0.2 — 2018-11-23
- 1.0.1 — 2018-11-22
- 1.0.0 — 2018-11-22

## README

# Mdn-docs-search
 [![Downloads](https://img.shields.io/npm/dt/mdn-docs-search.svg?maxAge=3600)](https://www.npmjs.com/package/mdn-docs-search)
 [![Version](https://img.shields.io/npm/v/mdn-docs-search.svg?maxAge=3600)](https://www.npmjs.com/package/mdn-docs-search)
 [![Build Status](https://travis-ci.org/waspothegreat/mdn-docs-search.svg?branch=master)](https://travis-ci.org/waspothegreat/mdn-docs-search)

A small package made to search the mdn docs

# Usage

Example:
```js
const MDNDocs = require('mdn-docs-search');

// Create an async function for resolving the result
async function searchDocs() {
  const result = await MDNDocs.search('Map.prototype.delete'); // Search the docs
  const docs = await MDNDocs.load(result); // Load the url from searching the docs
  return docs.name; // get the name
}

await searchDocs(); // Use the function
```

# Properties

* **name** - Name of the page
* **description** - Description of the page, markdown support included
* **url** - Url of the page
* **examples** - `Examples` section of the page, if any
* **polyfill** - `Polyfill` section of the page, if any
* **syntax** - `Syntax` section of the page, if any
* **params** - `Parameters` section of the page, parameters sorted and markdown support included
* **pageDescription** - `Description` section of the page, if any, markdown support included
* **seeAlso** - `See also` section of the page, if any, markdown support included
* **methods** - `Methods` section of the page, if any
* **returnValue** - `Return value` of the page, if any

# Contributing

If you want to contribute with anything please open a pull request

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