@jcottam/html-metadata

v2.1.1

Published

3 months ago

This JavaScript library simplifies the extraction of HTML Meta and OpenGraph tags from HTML content or URLs.

Downloads

428

0High
0Medium
0Low

jcottam

social metadata parser cheerio seo open-graph scrape og-tags webpage-scraper html-metadata html-meta-tags

HTML Metadata

@jcottam/html-metadata is a JavaScript library for easy extraction of HTML meta and Open Graph tags from HTML content or URLs. It is useful for social media sharing and SEO.

Compatibility: Works with both Node.js (CommonJS) and modern browsers (ES6).

Features

Extracts HTML meta and Open Graph from HTML content or URLs.
Parses metadata such as og:title, og:description, and favicon.
Developed in TypeScript for better type safety.
Simple integration and customizable error handling.
Fast performance.

Installation

npm install @jcottam/html-metadata

Usage

ES6 and CommonJS syntax supported

Extract tags from a URL

const { extractFromUrl } = require("@jcottam/html-metadata")

extractFromUrl("https://www.retool.com").then((data) => console.log(data))

Extract tags from an HTML string

const { extractFromHTML } = require("@jcottam/html-metadata")

const data = extractFromHTML(
  "<html><head><meta property='og:title' content='Hello World' /></head></html>"
)

Documentation

Methods

extractFromHTML(html: string, options?: Options): ExtractedData
extractFromUrl(url: string, options?: Options): Promise<ExtractedData | null>

Options

type Options = {
  timeout?: number // fetch timeout in ms
  metaTags?: string[] // specific meta tags to extract
}

Example Response

{
  "og:type": "website",
  "og:url": "https://retool.com/",
  "og:title": "Retool | The fastest way to build internal software.",
  "og:description": "Retool is the fastest way to build internal software. Use Retool's building blocks to build apps and workflow automations that connect to your databases and APIs, instantly.",
  "og:image": "https://d3399nw8s4ngfo.cloudfront.net/og-image-default.webp",
  "favicon": "/favicon.png"
}

CORS

To bypass CORS in browsers, run extractFromUrl on a server or use a proxy like AllOrigins.

Third Party Tools

The module utilizes the following third-party tools for testing and functionality:

Vitest: Next-generation testing framework.
Cheerio: A fast, flexible, and lean implementation of core jQuery designed for server-side Node.js.
Shields.io: Concise, consistent, and legible badges for projects.

Contributing

We welcome contributions to the @jcottam/html-metadata module! If you'd like to contribute, please follow these guidelines:

Fork the repository and create a branch.
Make your changes and ensure that the code style and tests pass.
Submit a pull request with a detailed description of your changes.