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

scraper-js

v2.0.0

Published

From the Bay to LA, scraper will collect all of the images from the url you tell it to and return a list of the images that best represent the site.

Downloads

12

Readme

scraper-js

overview

need thumbnails? scraper is a lightweight node.js package designed to return high quality and highly relevant images from a source url fast.

installation


npm install scraper-js

use

import scraper from "scraper-js";

const url =
  "https://barackobama.medium.com/my-2022-end-of-year-lists-ba76b6278801";
const result = await scraper.scrape(url);

Calling scrape returns a ScrapeResult object:

export interface ScrapeResult {
  html: string;
  images: RankedImage[];
  linkedData: Thing | null;
  openGraph:
    | scrapeOpenGraphData.successResultObject
    | scrapeOpenGraphData.errorResultObject;
  featureImage?: RankedImage | null;
}

The recommended version of node.js is 18.

example node server

//
// scraperapp
//
// thumbnail scraping http server. usage is as follows:
// get the address to scrape from the parameters passed to the url
// e.g. localhost:1337/scrape?url=http://www.reddit.com; address to scrape => http://www.reddit.com
// response will be an array of image urls => [http://image1.jpg, http://image2.jpg, ...]
//
// authored by Jason Ibrahim
// copyright (c) 2015 Jason Ibrahim
//

// initialize dependencies
const http = require("http"),
  https = require("https"),
  url = require("url"),
  scraper = require("scraper-js");

// set the port
const port = process.env.port || 80;

// create the server
const server = http
  .createServer(function (req, res) {
    const scrapereg = new RegExp(/^(\/scrape)/),
      query = url.parse(req.url, true).query,
      address = query.url,
      scraper = new Scraper.Scraper();
    // only listen for api calls to /scrape
    if (!req.url.match(scrapereg)) {
      res.writeHead(404);
      res.end("Did you mean /scrape?");
    }
    res.writeHead(200, { "Access-Control-Allow-Origin": "*" });
    // scraper returns a promise that will resolve an array of `RankedImage`
    scraper.scrape(address).then(
      function (result) {
        res.end(JSON.stringify(result.images));
      },
      function (error) {
        res.writeHead(404);
        res.end(JSON.stringify([error]));
      }
    );
    // if we don't get at least one thumbnail within 8 seconds, quit
    setTimeout(function () {
      res.writeHead(408);
      res.end(JSON.stringify(["timeout."]));
    }, 8000);
  })
  .listen(port);

console.log("Scraping on", port);

contributions

improvements, features, bug fixes and any other type of contribution are welcome to this project. please feel free to extend what has been started here and if it solves a particular problem, please submit a pull request so we can share it with others.