@uehreka/open-graph-scraper-react-native
v1.1.0
Published
React Native scraper module for Open Graph and Twitter Card info
Downloads
4
Maintainers
Readme
openGraphScraperLite
A simple javascript module for scraping Open Graph and Twitter Card info off a site. For Node.js usage, we recommend open-graph-scraper
by the same people.
Installation
npm install open-graph-scraper-lite
Usage
Callback Example:
const ogs = require('open-graph-scraper-lite');
const options = { url: 'http://ogp.me/' };
ogs(options, (error, results, response) => {
console.log('error:', error); // This is returns true or false. True if there was a error. The error it self is inside the results object.
console.log('results:', results); // This contains all of the Open Graph results
console.log('response:', response); // This contains the HTML of page
});
Promise Example:
const ogs = require('open-graph-scraper-lite');
const options = { url: 'http://ogp.me/' };
ogs(options)
.then((data) => {
const { error, result, response } = data;
console.log('error:', error); // This is returns true or false. True if there was a error. The error it self is inside the results object.
console.log('result:', result); // This contains all of the Open Graph results
console.log('response:', response); // This contains the HTML of page
})
Results JSON
Check the return for a success
flag. If success is set to true, then the url input was valid. Otherwise it will be set to false. The above example will return something like...
{
ogTitle: 'Open Graph protocol',
ogType: 'website',
ogUrl: 'http://ogp.me/',
ogDescription: 'The Open Graph protocol enables any web page to become a rich object in a social graph.',
ogImage: {
url: 'http://ogp.me/logo.png',
width: '300',
height: '300',
type: 'image/png'
},
requestUrl: 'http://ogp.me/',
success: true
}
Options
| Name | Info | Default Value | Required | |----------------------|----------------------------------------------------------------------------|---------------|----------| | url | URL of the site. | | x | | timeout | Timeout of the request | 2000 ms | | | html | You can pass in an HTML string to run ogs on it. (use without options.url) | | | | blacklist | Pass in an array of sites you don't want ogs to run on. | [] | | | onlyGetOpenGraphInfo | Only fetch open graph info and don't fall back on anything else. | false | | | ogImageFallback | Fetch other images if no open graph ones are found. | true | | | customMetaTags | Here you can define custom meta tags you want to scrape. | [] | | | allMedia | By default, OGS will only send back the first image/video it finds | false | | | retry | Number of times ogs will retry the request. | 2 | | | headers | An object containing request headers. Useful for setting the user-agent | {} | | | peekSize | Sets the peekSize for the request | 1024 | | | urlValidatorSettings | Sets the options used by validator.js for testing the URL | Here | |
Note: open-graph-scraper-lite
uses ky for requests and most of ky's options should work as open-graph-scraper-lite
options.
Custom Meta Tag Example:
const ogs = require('open-graph-scraper-lite');
const options = {
url: 'https://github.com/jshemas/openGraphScraper',
customMetaTags: [{
multiple: false, // is there more then 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 { error, result, response } = data;
console.log('hostnameMetaTag:', result.hostnameMetaTag); // hostnameMetaTag: github.com
})
Tests
Then you can run the tests by running...
npm run test