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

news-builder

v1.2.5

Published

Create images with news from newsapi.org sources

Downloads

44

Readme

news-builder

Module for building images of current news

Creates an image based on news from newsapi.org sources

https://newsapi.org/v1/sources

https://newsapi.org/v1/articles?source=ars-technica&sortBy=top&apiKey=<key>

A key is required to use the newsapi.org service. The key is passed in as a parameter to the module.

sample sources

  • cnn
  • the-verge
  • wired

Not all sources have images or are as up to date as others.

test.ts shows how to use the module

The normal use of this module is to build an npm module that can be used as part of a bigger progress.

index.d.ts describes the interface for the module

The LoggerInterface, KacheInterface and ImageWriterInterface interfaces are dependency injected into the module. Simple versions are provided and used by the test wrapper.

Once instanciated, the CreateImages() method can be called to create a series of images.

To use the test wrapper to build a screen, run the following command.

$ npm start

or

$ node app.js 

Usage: app [options]

Example: app -s cnn -k <key> -c 10

Options:
  -l, --loglevel <level>  set the log level (error, warn, info, debug, verbose (default: "info")
  -s, --source <source>   News source ('google-news')
  -k, --key <key>         default, uses KEY env variable (default: "default"), or pass in a key or 'test' for canned data
  -c, --count <count>     number or screens (default: "10")
  -h, --help              display help for command

To Deploy

First check in changes and make sure the version number is updated in package.json

$ npm publish