Skip to content
Saves a image URL for an avatar to the local file system (and optimizes the image).
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit. 1.0 Aug 20, 2019
AvatarLocalCache.js Don't convert images if they're already in a format. Use default qual… Aug 23, 2019
LICENSE Initial commit Aug 20, 2019
README.md Link to the blog post Aug 26, 2019
package.json v2.0.3 Aug 23, 2019
sample.js Rework to use node-fetch to work with 302 redirects Aug 23, 2019

README.md

Avatar Local Cache

Saves a image URL for an avatar to the local file system (and optimizes the image). Read the blog post that inspired this utility: A Featherweight Facepile.

  • Workaround for large avatar images on hosted services.
  • Image URLs won’t break in the future.
  • Only keeps the smallest images (webp if smallest and one of jpg or png)

Install

npm install avatar-local-cache

Usage

The default behavior will only keep webp if it has the smallest file size and then will pick one of jpg or png based on which one is the smallest of the two. To disable this, see the Keep all formats example below.

const AvatarLocalCache = require("avatar-local-cache");

let cache = new AvatarLocalCache();
cache.fetchUrl("https://opencollective-production.[…].jpeg", "nhoizey").then(function(files) {
    console.log( `Wrote ${files.map(entry => entry.path).join(", ")}.` );
});

The above writes three files but only keeps one: nhoizey.webp (20KB), nhoizey.jpg (22KB), and nhoizey.png (9KB).

  1. It only keeps the webp file if it is the smallest (it is not).
  2. It then picks the smaller of the jpg and the png (in this case, the png wins by 13KB).

This allows you to iterate over the object returned from the promise to create an img (if only one source remains) or a picture element (if the webp survived alongside a jpg or png).

Keep all formats

To disable this file size comparison and file pruning, just set onlyKeepSmallestFormats to false.

let cache = new AvatarLocalCache();
cache.onlyKeepSmallestFormats = false;
You can’t perform that action at this time.