# metascraper-description

> Metascraper rule to extract the description from HTML using Open Graph, JSON-LD, and fallback selectors.

Latest version **5.56.2** (published 2026-08-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install metascraper-description
pnpm add metascraper-description
yarn add metascraper-description
bun add metascraper-description
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 5.56.2 |
| Published | 2026-08-17 |
| First published | 2017-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 22 |
| Dependencies | 1 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2737 |
| Author | microlink.io |
| Maintainers | kikobeats |
| Keywords | description, extract, html, json-ld, metadata, metascraper, og:description, open-graph, scraper, summary |

## Links

- npm: https://www.npmjs.com/package/metascraper-description
- Repository: https://github.com/microlinkhq/metascraper.git#master
- Homepage: https://github.com/microlinkhq/metascraper/packages/metascraper-description
- Issues: https://github.com/microlinkhq/metascraper/issues
- npm.io page: https://npm.io/package/metascraper-description

## Dependencies (1)

- [@metascraper/helpers](https://npm.io/package/@metascraper/helpers.md) 5.56.2

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 5.56.2 (latest) — 2026-08-17
- 1.0.0-alpha.3ac8a881 (canary) — 2017-12-15
- 5.55.2 — 2026-08-13
- 5.55.0 — 2026-08-09
- 5.54.1 — 2026-08-07
- 5.54.0 — 2026-08-07
- 5.53.0 — 2026-07-30
- 5.52.0 — 2026-07-29
- 5.51.1 — 2026-06-19
- 5.50.6 — 2026-06-09
- 5.50.5 — 2026-06-09
- 5.50.1 — 2026-04-14
- 5.50.0 — 2026-03-20
- 5.49.25 — 2026-03-07
- 5.49.24 — 2026-02-17
- … 270 more at https://npm.io/package/metascraper-description/versions

## README

<div align="center">
  <br>
  <img style="width: 500px; margin:3rem 0 1.5rem;" src="https://metascraper.js.org/static/logo-banner.png" alt="metascraper">
  <br>
  <br>
  <p align="center"><strong>metascraper-description</strong>: Get description property from HTML markup.</p>
  <p align="center">See our <a href="https://metascraper.js.org" target='_blank' rel='noopener noreferrer'>website</a> for more information.</p>
  <br>
</div>

## Install

```bash
$ npm install metascraper-description --save
```

## API

### metascraper-description([options])

#### options

##### truncateLength

Type: `number`<br>
Default: `Number.MAX_SAFE_INTEGER`

Truncate the value extracted to a maximum size.

## License

**metascraper-description** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/metascraper/blob/master/LICENSE.md) License.<br>
Authored and maintained by [Microlink](https://microlink.io) with help from [contributors](https://github.com/microlinkhq/metascraper/contributors).

> [microlink.io](https://microlink.io) · GitHub [microlinkhq](https://github.com/microlinkhq) · X [@microlinkhq](https://x.com/microlinkhq)

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