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

wtf-plugin-image

v1.1.0

Published

image plugin for wtf_wikipedia

Downloads

58

Readme

Some additional methods for using and rendering images in wtf_wikipedia

const wtf = require('wtf_wikipedia')
wtf.extend(require('wtf-plugin-image'))

wtf.fetch('casa', { lang:'it', wiki: `wiktionary` }).then(async function(doc) {
  let image = doc.images()[0]

  // make a {method: 'HEAD'} request to test the image is there
  let bool = await image.exists()

  // instead of using the redirect api, generate a direct img url
  let url = image.commonsURL()
  // https://upload.wikimedia.org/wikipedia/commons/4/4e/RybnoeDistrict_06-13_Konstantinovo_village_05.jpg

  let img = doc.mainImage()
  //
  // make a request to get the license and attribution information (results are HTML formatted)
  let license = await image.license()
  /* 
  {
    license: 'CC BY-SA 3.0',
    artist: '<b><span class="plainlinks"> ... (more HTML)',
    credit: '<span class="int-own-work" lang="en">Own work</span>',
    attributionRequired: 'true'
  }
  */
})
<script src="https://unpkg.com/wtf_wikipedia"></script>
<script src="https://unpkg.com/wtf-plugin-images"></script>
<script defer>
  wtf.plugin(window.wtfImage)
  wtf.fetch('Hamburg').then((doc) => {
    console.log(doc.mainImage().thumb())
    // https://wikipedia.org/wiki/Special:Redirect/file/Flag_of_Hamburg.svg?width=300
  })
</script>

The document's images method now also accepts an options object as its argument, possible options are:

  • batch
    Request-making methods that you want to call for all the images. (a string for one or array for more)
    It's a best practice as it prevents overwhelming the wiki's servers by making one request for all the
    images beforehand instead of multiple. (the return value of images would be a Promise)
let images = await doc.images({batch: ['license', 'exists']}) // note the "await"
let image = images[0]

// even though they don't make requests, they still return Promises for consistency 
let bool = await image.exists()
let license = await image.license()

plugin also has a method for choosing a good, or representative image for this page, if it exists:

// choose a good image for this article
let doc = await wtf.fetch('Toronto')
let img = doc.mainImage()
console.log(img.src())
// https://wikipedia.org/wiki/Special:Redirect/file/Toronto_Flag.svg

API

  • image.exists() - double-check that the image is on the server
  • image.commonsURL() - instead of the wikimedia redirect server, generate a url for the commons server.
  • image.mainImage() - get only an image that should represent this topic, as a thumbnail.
  • image.license() - get license and attribution information for the image.
  • document.images() - accepts an options object as argument.

MIT