# image-handler-loader

> A webpack loader for handle css image.

Latest version **2.0.1** (published 2018-07-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install image-handler-loader
pnpm add image-handler-loader
yarn add image-handler-loader
bun add image-handler-loader
```

## 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 | 2.0.1 |
| Published | 2018-07-10 |
| First published | 2018-03-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0 |
| Dependencies | 5 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | chenshihao |
| Maintainers | chenshihao |
| Keywords | webpack, loader |

## Links

- npm: https://www.npmjs.com/package/image-handler-loader
- Repository: https://github.com/ChenShihao/image-handler-loader
- Homepage: https://github.com/ChenShihao/image-handler-loader#readme
- Issues: https://github.com/ChenShihao/image-handler-loader/issues
- npm.io page: https://npm.io/package/image-handler-loader

## Dependencies (5)

- [mime](https://npm.io/package/mime.md) ^2.2.0
- [request](https://npm.io/package/request.md) ^2.85.0
- [file-loader](https://npm.io/package/file-loader.md) ^1.1.11
- [webpack-log](https://npm.io/package/webpack-log.md) ^1.1.2
- [loader-utils](https://npm.io/package/loader-utils.md) ^1.1.0

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 2.0.1 (latest) — 2018-07-10
- 2.0.0 — 2018-07-09
- 1.0.3 — 2018-04-12
- 1.0.2 — 2018-03-13
- 1.0.1 — 2018-03-13
- 1.0.0 — 2018-03-13

## README

# image-handler-loader

[![NPM](https://nodei.co/npm/image-handler-loader.png?compact=true)](https://nodei.co/npm/image-handler-loader/)

[![Build Status](https://travis-ci.com/ChenShihao/image-handler-loader.svg?branch=master)](https://travis-ci.com/ChenShihao/image-handler-loader)
![cli version](https://img.shields.io/npm/v/image-handler-loader.svg)
![node version](https://img.shields.io/node/v/image-handler-loader.svg)
![npm](https://img.shields.io/npm/dt/image-handler-loader.svg)

处理 CSS 中引用的本地图片，支持：

* 上传至服务器并更新 URL
* 转化为 base64 格式

## Install

```sh
npm i --save-dev image-handler-loader
```

## Usage

webpack.config.js

```js
{
    test: /\.(jpe?g|png|gif)$/,
    use: [
        'image-handler-loader'
    ]
}
```

## API

### `options`

* ```threshold : number```

    转化 ```bsae64``` 阈值, 默认为 ```1024``` (Bytes)

    ```js
    {
        test: /\.(jpe?g|png|gif)$/,
        use: [{
            loader: 'image-handler-loader',
            options: {
                threshold: 2 * 1024 // 小于等于 2KB 的图片转化为 base64
            }
        }]
    }
    ```

* ```compress : boolean```

    上传图片是否压缩，默认为 ```true```

    ```js
    {
        test: /\.(jpe?g|png|gif)$/,
        use: [{
            loader: 'image-handler-loader',
            options: {
                compress: true // 压缩图片
            }
        }]
    }
    ```

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