rollup-plugin-napi-image
TypeScript icon, indicating that this package has built-in type declarations

0.6.1 • Public • Published

rollup-plugin-napi-image

Rollup plugin for optimizing images powered by @napi-rs/image, without involving node-gyp.

see example

Usage

1. install

npm install rollup-plugin-napi-image --save-dev
# or you use pnpm
pnpm add  rollup-plugin-napi-image -D

2. add plugin to your config file

  • if you are using rollup, import this plugin and add to plugins field like following:
import { defineConfig } from 'rollup'
import { napiImage } from 'rollup-plugin-napi-image'
// ... other lines

export default defineConfig({
  plugins: [
    /* other plugins */
    napiImage({
      mode: 'lossy',
      quality: 75,
    }),
  ],
})
  • if you are using vite , just replace the first line of above with import { defineConfig } from 'vite'

3. options

name type default description
include RegExp | string | Array<string | RegExp> null A picomatch pattern, or array of patterns, which specifies the files in the build the plugin should operate on. By default all supported images are targeted.
exclude RegExp | string | Array<string | RegExp> null A picomatch pattern, or array of patterns, which specifies the files in the build the plugin should ignore. By default no images are ignored.
mode 'lossy' | 'lossless' The optimization mode applied to images, when mode is lossy , you can specify quality for the process.
quality number 75 Only works when mode is lossy.
toModernExt (ext: SupportedExt) => ModernExt ext => ext A conversion function that converts the specified image format to a modern image format.

4. supported formats

  1. jpg/jpeg
  2. png
  3. webp
  4. avif

License

MIT © nemurubaka

Package Sidebar

Install

npm i rollup-plugin-napi-image

Weekly Downloads

297

Version

0.6.1

License

MIT

Unpacked Size

7.57 kB

Total Files

4

Last publish

Collaborators

  • nemurubaka