1.0.1 โข Published 1 year ago
@misaon/imgproxy v1.0.1
๐ผ๏ธ @misaon/imgproxy
Generate imgproxy url in browser and Node easily. Lightweight and Fast!
Features
- ๐ย 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%
Usage
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'
// or commonJS
// const { getImageUrl } = require("misaon/imgproxy");
const imageUrl = getImageUrl(sourceImageUrl, {
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)
Modifiers
The list of modifiers that you can use is well typed and can be found here or in imgproxy docs.
Development
- 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
License
Made with ๐งก by @misaon
Published under MIT License.