devmehq / open-graph-extractor

Extract Open Graph and Metadata from html in node.js

Open Graph Extractor

A simple tools for scraping Open Graph and Twitter Card info off from html.

API / Cloud Hosted Service

We offer this URL Scrapping & Metadata Service in our Scalable Cloud API Service Offering - You could try it here URL Scrapping & Metadata Service

Self-hosting - installation and usage instructions

Installation

Install the module through YARN:

yarn add @devmehq/open-graph-extractor

Or NPM

npm install @devmehq/open-graph-extractor

Examples

// use your favorite request library, in this example i will use axios to get the html
import axios from "axios";
import { extractOpenGraph } from '@devmehq/open-graph-extractor';
const { data: html } = axios.get('https://ogp.me')
const openGraph = extractOpenGraph(html);

Results JSON

{
  ogTitle: 'Open Graph protocol',
  ogType: 'website',
  ogUrl: 'https://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'
  }
} 

Configuration options

customMetaTags

Here you can define custom meta tags you want to scrape. Default: [].

allMedia

By default, OGS will only send back the first image/video it finds. Default: false.

onlyGetOpenGraphInfo

Only fetch open graph info and don't fall back on anything else. Default: false.

ogImageFallback

Fetch other images if no open graph ones are found. Default: false.

Testing

yarn test

Contributing

Please feel free to open an issue or create a pull request and fix bugs or add features, All contributions are welcome. Thank you!

LICENSE MIT

open-graph-extractor's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency ts-jest to v29.1.5
• chore(deps): update dependency eslint to v9
• chore(deps): update dependency eslint-plugin-unused-imports to v4
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/ci.yml

• styfle/cancel-workflow-action 0.12.1
• actions/checkout v4
• FranzDiebold/github-env-vars-action v2
• actions/setup-node v4

.github/workflows/release.yml

• styfle/cancel-workflow-action 0.12.1
• actions/checkout v4
• FranzDiebold/github-env-vars-action v2
• actions/setup-node v4

npm

package.json

• cheerio 1.0.0-rc.12
• @types/chai 4.3.16
• @types/cheerio 0.22.35
• @types/jest ^29.5.12
• @types/node 20.14.2
• @typescript-eslint/eslint-plugin 7.13.0
• @typescript-eslint/parser 7.13.0
• axios 1.7.2
• eslint 8.57.0
• eslint-config-prettier 9.1.0
• eslint-plugin-prettier 5.1.3
• eslint-plugin-unused-imports 3.2.0
• husky 9.0.11
• jest ^29.7.0
• lint-staged 15.2.7
• prettier 3.3.2
• ts-jest ^29.1.2
• typescript 5.4.5
• node >= 12.0

---

• Check this box to trigger a request for Renovate to run again on this repository