0.2.0 • Published 5 months ago
fetch-site-metadata v0.2.0
fetch-site-metadata
High-performance metadata scraper for Node.js
Features
- Don't download whole contents to get site metadata.
- Fetch and parse the content of the
headelement only. Interrupt HTTP request when the<body>element starts. - Download only first few kilobytes to determine image size (by
probe-image-sizepackage)
- Fetch and parse the content of the
Install
npm install fetch-site-metadataUsage
This package requires Node.js v16 or higher. ESM only.
import fetchSiteMetadata from 'fetch-site-metadata'
await fetchSiteMetadata('https://github.com/')
// result:
{
title: 'GitHub: Let’s build from here',
description: 'GitHub is where over 94 million developers shape the future of software, together. Contribute to the open source community, manage your Git repositories, review code like a pro, track bugs and feat...',
icon: 'https://github.githubassets.com/favicons/favicon.svg',
image: {
src: 'https://github.githubassets.com/images/modules/site/social-cards/campaign-social.png',
width: '1200',
height: '630',
alt: 'GitHub is where over 94 million developers shape the future of software, together. Contribute to the open source community, manage your Git repositories, review code like a pro, track bugs and feat...'
}
}API
fetchSiteMetadata(url: string | URL, options?: Options)
Return value: Promise<Metadata>
Fetch target site and scrape metadata. This function send multiple requests to determine OG image size and other informations by default.
suppressAdditionalRequest option suppress this behavior. With suppressAdditionalRequestoption, this function fetches only the specified URL and reduces processing time, but provides only information which can be extracted from the specified page.
You can also pass the options for fetch function.
type Options = {
suppressAdditionalRequest?: boolean
} & RequestInit
type ImageInfo = {
src: string
width: string | undefined
height: string | undefined
alt: string | undefined
}
type Metadata = {
title: string | undefined
description: string | undefined
icon: string | undefined
image: ImageInfo | undefined
}// example using fetch options
fetchSiteMetadata('https://example.test', { headers: { 'User-Agent': 'bot' } })