# imgs-to-webp

> imgs to webp

Latest version **1.1.0** (published 2021-09-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install imgs-to-webp
pnpm add imgs-to-webp
yarn add imgs-to-webp
bun add imgs-to-webp
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-09-03 |
| First published | 2021-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 27.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | hl |
| Maintainers | little-snail |
| Keywords | imgs-to-webp, webp, images, imgs |

## Links

- npm: https://www.npmjs.com/package/imgs-to-webp
- Repository: https://github.com/LuHong-HL/imgs-to-webp
- Homepage: https://github.com/LuHong-HL/imgs-to-webp#readme
- Issues: https://github.com/LuHong-HL/imgs-to-webp/issues
- npm.io page: https://npm.io/package/imgs-to-webp

## Dependencies (2)

- [cwebp-bin](https://npm.io/package/cwebp-bin.md) ^6.1.1
- [loader-utils](https://npm.io/package/loader-utils.md) ^2.0.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2021-09-03
- 1.0.2 — 2021-09-01
- 1.0.1 — 2021-09-01
- 1.0.0 — 2021-08-31

## README

# imgs-to-webp

图片转webp格式

# Getting Started

To begin, you'll need to install `imgs-to-webp`:

```shell
$ npm install imgs-to-webp --save-dev
```

### webpack.config.js

```javascript
module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpe?g|gif)$/i,
        use: [
          {
            loader: 'imgs-to-webp',
          },
        ],
      },
    ],
  },
};
```

# Options

### `name`

输出图片命名规则

```javascript
module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpe?g|gif)$/i,
        use: [
          {
            loader: 'imgs-to-webp',
            options: {
              name: '[name].[hash:8].[ext]'
            }
          },
        ],
      },
    ],
  },
};
```

### `quality`

压缩图片的质量，默认 75

```javascript
module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpe?g|gif)$/i,
        use: [
          {
            loader: 'imgs-to-webp',
            options: {
              quality: 75,
            }
          },
        ],
      },
    ],
  },
};
```

### `outputPath`

图片转换后的路径，默认 `dist/webp`

```javascript
module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpe?g|gif)$/i,
        use: [
          {
            loader: 'imgs-to-webp',
            options: {
              outputPath: `dist/webp`
            }
          },
        ],
      },
    ],
  },
};
```

### `include`

匹配图片路径正则，默认 /src/

```javascript
module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpe?g|gif)$/i,
        use: [
          {
            loader: 'imgs-to-webp',
            options: {
              include: /src/
            }
          },
        ],
      },
    ],
  },
};
```

---
_Source: https://npm.io/package/imgs-to-webp · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._