npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fetch-site-metadata

v0.2.0

Published

High-performance metadata scraper

Downloads

132

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

fabonfabon

Keywords

metadataog

Readme

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 head element only. Interrupt HTTP request when the <body> element starts.
    • Download only first few kilobytes to determine image size (by probe-image-size package)

Install

npm install fetch-site-metadata

Usage

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' } })