rittenhop-dev/versions/5.94.2/node_modules/metascraper-description/README.md

36 lines
1.2 KiB
Markdown
Raw Normal View History

2024-09-23 19:40:12 -04:00
<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) · Twitter [@microlinkhq](https://twitter.com/microlinkhq)