head-metadata

Extracts metadata from the head of a HTML document

Source

npm

Version: 0.0.3

Version published: 9 months ago

Weekly downloads: 5

Maintainers: 1

Weekly downloads

Created: last year

Source

Status: Experimental

head-metadata is a utility for extracting structured metadata (like <meta>, <title>, and <link>) from the <head> of an HTML document.

📖 Usage

Extract Metadata from `<head>`

import { extractHeadMetadata } from 'head-metadata';
import { metaExtractor, titleExtractor, linkExtractor } from 'head-metadata/extractors';

const html = `
  <html>
    <head>
      <title>Example</title>
      <meta name="description" content="An example page" />
      <link rel="canonical" href="https://example.com" />
    </head>
  </html>
`;

const metadata = extractHeadMetadata(html, {
  meta: metaExtractor,
  title: titleExtractor,
  link: linkExtractor
});

console.log(metadata);
/*
{
  title: 'Example',
  meta: {
    description: 'An example page'
  },
  link: {
    canonical: 'https://example.com'
  }
}
*/

Create Custom Extractors

You can write your own extractors to handle any <head> child element:

export const customLinkExtractor = {
	type: 'collection' as const,
	parent: 'link' as const,
	callback: (node) => {
		const rel = node.attributes.find((a) => a.local === 'rel');
		const href = node.attributes.find((a) => a.local === 'href');
		if (rel != null && href != null) {
			return { key: rel.value, value: href.value };
		}

		return null;
	}
} satisfies TCollectionExtractor;

FAQs

What is head-metadata?

Is head-metadata popular?

Is head-metadata well maintained?

Package last updated on 31 May 2025

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install