openGraphScraperLite


A simple javascript module for scraping Open Graph and Twitter Card info from given HTML. For Node.js usage, we recommend open-graph-scraper by the same people and can do HTTP requests.

Installation

``bash
npm install open-graph-scraper-lite --save
`

Usage

`javascript
const ogs = require('open-graph-scraper');
const options = {
html:







};
ogs(options)
.then((data) => {
const { result } = data;
console.log('result:', result);
})
`

Results JSON

`javascript
result: {
ogDescription: 'html description example',
ogTitle: 'foobar',
ogType: 'website',
ogImage: [ { url: 'https://www.foo.com/bar.jpg', type: 'jpg' } ],
favicon: 'https://bar.com/foo.png',
charset: 'utf-8',
success: true
}
`

Options

| Name | Info | Default Value | Required |
|----------------------|----------------------------------------------------------------------------|---------------|----------|
| html | You can pass in an HTML string to run ogs on it. (use without options.url) | x | |
| onlyGetOpenGraphInfo | Only fetch open graph info and don't fall back on anything else. | false | |
| customMetaTags | Here you can define custom meta tags you want to scrape. | [] | |

Custom Meta Tag Example

`javascript
const ogs = require('open-graph-scraper');
const options = {
html:







,
customMetaTags: [{
multiple: false, // is there more than one of these tags on a page (normally this is false)
property: 'hostname', // meta tag name/property attribute
fieldName: 'hostnameMetaTag', // name of the result variable
}],
};
ogs(options)
.then((data) => {
const { result } = data;
console.log('hostnameMetaTag:', result.customMetaTags.hostnameMetaTag); // hostnameMetaTag: github.com
})
``