Package Exports
- link-preview-generator
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (link-preview-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
link-preview-generator
Get preview data (a title, description, image, domain name) from a url. Library uses puppeteer headless browser to scrape the web site.
Install
$ npm install link-preview-generatorUsage
const linkPreviewGenerator = require("link-preview-generator");
const previewData = await linkPreviewGenerator(
"https://www.youtube.com/watch?v=8mqqY2Ji7_g"
);
console.log(previewData);
/*
{
title: 'Kiteboarding: Stylish Backroll in 4 Sessions - Ride with Blake: Vlog 20',
description: 'The backroll is a staple in your kiteboarding trick ' +
'bag. With a few small adjustments, you can really ' +
'improve your style and make this basic your own. ' +
'Sessio...',
domain: 'youtube.com',
img: 'https://i.ytimg.com/vi/8mqqY2Ji7_g/hqdefault.jpg'
}
*/API
linkPreviewGenerator(url, puppeteerArgs?, puppeteerAgent?)
Accepts a url, which is scraped and optional parameters puppeteerArgs -- browser options and puppeteerAgent -- browser user agent.
Returns an object with preview data of url.
url
Type: string
Scraped url.
puppeteerArgs
Type: object
Options to set on the Chrome browser.
puppeteerAgent
Type: string
Specific user agent to use.
License
MIT © Andrej Gajdos