webp-jxr-middleware
v1.0.4
Published
Express middleware to replace jpg/png/jpeg with webp/jxr when supported
Downloads
70
Maintainers
Readme
Installation
npm install webp-jxr-middleware
Usage
webp-jxr-middleware should be used before any middleware that is serving files (e.g. express.static
) so that it serves changed format file.
import rewriteImg from 'webp-jxr-middleware';
import express from 'express';
import { join } from 'path';
const app = express();
const serverPath = join(__dirname, 'public');
app.use(rewriteImg(serverPath));
app.use(express.static(serverPath));
ES5
An ES5 compatibility build is also included at lib/es5.js
. To generate it from the source, run npm run build
.
You can then require it like:
var rewriteImg = require('webp-jxr-middleware/lib/es5').default;
Overview
Middleware to serve JXR and WEBP images when the browser supports them. Works with Connect and Express.
It is based off connect-image-optimus and accept-webp. It maintains support for webp and jxr from the connect-image-optimus
and avoids the UA parsing like accept-webp
.
Development Setup
- Fork the repo
- Run
npm install
- Run
./node_modules/.bin/precommit install
- Run
npm run dev
to initiate the development server
Contributing
- Commit your changes following conventional-changelog format
- Push to a new branch (e.g.
git push origin my-awesome-feature
) - Create a new Pull Request
License
MIT