tmi

TMI (Too Many Images)

Discover your image weight on the web. Find out the image weight in your pages, compare to the HTTPArchive average and discover what images you can optimize further.

Install

$ npm install --save tmi

Quick start

Summary:

$ tmi <url>

Switch between desktop and mobile:

$ tmi <url> --strategy=mobile

Detailed summary with URLs you can optimize:

$ tmi <url> --verbose

Usage

This module is modelled on psi and follows a very similar API.

When using this module for a production-level build process, registering for an API key from the Google Developer Console is recommended.

var tmi = require('tmi');

tmi({
	// key: '...', optional
	url: 'http://html5rocks.com',
	paths: '',           // optional
	locale: 'en_GB',     // optional
	strategy: 'mobile',  // optional
	threshold: 80        // optional
});

Optionally, a callback is also available with access to the response:

tmi(options, function (err, data) {
	console.log(data.score);
	console.log(data.pageStats);
});

Options

url

Required
Type: string

URL of the page for which the PageSpeed Insights API should generate results.

locale

Type: string
Default: en_US

The locale that results should be generated in (e.g 'en_GB').

strategy

Type: string
Default: desktop

The strategy to use when analyzing the page. Valid values are desktop and mobile.

threshold

Type: number
Default: 70

Threshold score that is needed to pass the pagespeed test

paths

Type: array

An array of URL paths that are appended to the URL

key

Type: string
Default: nokey

Google API Key

Unless Specified defaults to use the free tier on PageSpeed Insights. Good for getting a feel for how well this tool works for you.

CLI support

You will probably want to globally install tmi if using as a CLI. This can be done as follows:

$ npm install --global tmi

You can then casually use it with or without your key:

$ tmi http://www.google.com

$ tmi http://www.google.com --key 'YOUR_KEY_GOES_HERE'

Or ask for a more detailed report including image URLs that can be optimized:

$ tmi http://www.google.com --verbose

Similar to gpagespeed, the following optional flags are also supported:

$ tmi <url> --key=<key> --prettyprint=<true> --userIp=<userIp> --locale=<locale> --strategy=<desktop|mobile>

$ tmi http://www.html5rocks.com --strategy=mobile

Good test URLs

Local testing

We plan on adding support for testing localhost and local files in the very near future. Until then, ngrok should be able to help get you mostly there.

License

Apache 2.

ngnguyen1 / tmi

tmi