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

page-meta-scraper

v0.1.4

Published

A page metadata scraper

Downloads

11

Readme

pageMetaScraper is a library to scrape metadata from any page. It scrapes Open Graph metadata, regular HTML metadata and uses text and images from the page as well as images from several image search apis as fallback.

CI status DeepSource DeepScan grade npm version

Install

Install with NPM:

npm i --save page-meta-scraper

Install with Yarn:

yarn add page-meta-scraper

Usage

import pageMetaScraper from 'page-meta-scraper'

const url = 'https://example.com'

const metadata = await pageMetaScraper.scrape(url)

// {
//   title: 'page title',
//   description: 'page description',
//   favicon: 'https://example.com/favicon.png',
//   imageUrls: ['https://example.com/page-image.jpg'],
// }

Fallback image APIs

Since some pages don't show any images, ContextualWeb Image Search API and Unsplash Image API can be used as fallback strategies. Both strategies have to be configured and keywords have to be provided to search for images:

import pageMetaScraper from 'page-meta-scraper'

pageMetaScraper.configure({
  useFallbackImages: true,
  imageFallbackStrategies: ['contextualweb', 'unsplash'],

  unsplashBaseUrl: 'URL',
  unsplashClientId: 'URL',
  xRapidapiHost: 'HOST',
  xRapidapiKey: 'KEY',
})

const url = 'https://example.com'
const keywords = ['example', 'key', 'words']

const metadata = await pageMetaScraper.scrape(url, keywords)

The fallback images can also be used by themself:

import pageMetaScraper from 'page-meta-scraper'

pageMetaScraper.configure({
  useFallbackImages: true,
  imageFallbackStrategies: ['contextualweb', 'unsplash'],

  unsplashBaseUrl: '',
  unsplashClientId: '',
  xRapidapiHost: '',
  xRapidapiKey: '',
})

const keywords = ['example', 'key', 'words']

const imageUrls = await pageMetaScraper.fallbackImages(keywords)

ContextualWeb Image Search API

If you want to use the ContextualWeb Image Search API as a fallback strategy you have to provide xRapidapiHost, xRapidapiKey and imageSearchBaseUrl in the config.

Unsplash Image API

If you want to use the Unsplash Image API as a fallback strategy you have to provide unsplashBaseUrl and unsplashClientId in the config.

License

The npm package is available as open source under the terms of the MIT License.