1.1.2 • Published 2 years ago

@spykesocial/react-native-opengraph-scrapper v1.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

React-Native-OpenGraph-Scrapper

A simple pure javascript react-native module for scraping OpenGraph metadata and Twitter Card info off a site.

Installation

  yarn add @spykesocial/react-native-opengraph-scrapper

Usage

Callback Example:

const getOpenGraphData = require('@spykesocial/react-native-opengraph-scrapper');
const options = { url: 'http://ogp.me/' };
getOpenGraphData(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 getOpenGraphData = require('@spykesocial/react-native-opengraph-scrapper');
const options = { url: 'http://ogp.me/' };
getOpenGraphData(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

NameInfoDefault ValueRequired
urlURL of the site.x
timeoutTimeout of the request2000 ms
htmlYou can pass in an HTML string to run ogs on it. (use without options.url)
blacklistPass in an array of sites you don't want ogs to run on.[]
onlyGetOpenGraphInfoOnly fetch open graph info and don't fall back on anything else.false
ogImageFallbackFetch other images if no open graph ones are found.true
customMetaTagsHere you can define custom meta tags you want to scrape.[]
allMediaBy default, OGS will only send back the first image/video it findsfalse
retryNumber of times ogs will retry the request.2
headersAn object containing request headers. Useful for setting the user-agent{}
peekSizeSets the peekSize for the request1024
urlValidatorSettingsSets the options used by validator.js for testing the URLHere

thanks https://github.com/chrisuehlinger/openGraphScraperLite