preview-link v2.0.1

preview-link

Package which generates a HTML string as a preview or summary of a webpage.

Custom support for Twitter, GitHub, Wikipedia, Amazon and more to come.
Otherwise uses Open Graph data, with other meta-tags as a fallback to generate the preview.

Usage

Preview-link has a very simple API - it's just one function.

let previewLink = require('preview-link');

//Then either use it with async/await or as a promise
async function getHTML (url) {
    return await previewLink(url);
}

previewLink(url).then(res => /* do something */).catch(err => /* catch something */);

The response object contains two properties

• error (null | string) * A string detailing the error (either no preview available, http error, or unknown)

• html (null | string) * A string giving the html preview