npm version npm downloads Github Actions Codecov

Generate imgproxy url in browser and Node easily. Lightweight and Fast!

• 👌 Zero configuration
• 🪄 Modern, tiny and tree shaken code
• ⚙️ Written in TypeScript
• 🕒 Async-less methods and crypto computing
• 🚀 Browser and Node support
• 📦 Extendable and customizable
• 📰 Compatible with the latest version of imgproxy
• 🧪 Covered by tests >99%

Install package:

# npm
npm install @misaon/imgproxy
# yarn
yarn add @misaon/imgproxy
# pnpm
pnpm install @misaon/imgproxy

then in your code:

import { getImageUrl } from "@misaon/imgproxy";
const imageUrl = getImageUrl("https://example.com/my-image.jpg", {
 baseURL: "https://my-imgproxy.com", // optional
 secret: "imgproxy-secret-key",
 salt: "imgproxy-salt",
 modifiers: {
 width: "100",
 height: "75",
 // other modifiers... (see below)
 },
});
console.log(imageUrl);

That's all! 🥂

If you like use CommonJS, you can import like this:

const { getImageUrl } = require("misaon/imgproxy");

The list of modifiers that you can use is well typed and can be found here or in imgproxy docs.

• Clone this repository
• Install latest LTS version of Node.js
• Enable Corepack using corepack enable
• Install dependencies using pnpm install
• Run interactive tests using pnpm dev

Made with 🧡 by @misaon

Published under MIT License.