# gulp-tinyimage

> An image manipulation plugin for gulp. Resize, Optimise and save all your images with one simple plugin. This plugin is useful if your a developer that receives a ton of high-resolution/filesize images aswell as anything but jpg. This plugin completely re

Latest version **0.2.2** (published 2019-02-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install gulp-tinyimage
pnpm add gulp-tinyimage
yarn add gulp-tinyimage
bun add gulp-tinyimage
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2019-02-28 |
| First published | 2019-02-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | kimichowmein |

## Links

- npm: https://www.npmjs.com/package/gulp-tinyimage
- Repository: https://github.com/kimichowmein/gulp-tinyimage
- Homepage: https://github.com/kimichowmein/gulp-tinyimage#readme
- Issues: https://github.com/kimichowmein/gulp-tinyimage/issues
- npm.io page: https://npm.io/package/gulp-tinyimage

## Dependencies (3)

- [gulp](https://npm.io/package/gulp.md) ^3.9.1
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [sharp](https://npm.io/package/sharp.md) ^0.21.3

## Recent versions

- 0.2.2 (latest) — 2019-02-28
- 0.2.1 — 2019-02-28
- 0.2.0 — 2019-02-27

## README

# gulp-tinyimage

An image manipulation plugin for gulp. Resize, Optimise and save all your images with one simple plugin. This plugin is useful if your a developer that receives a ton of high-resolution/filesize images aswell as anything but jpg. This plugin completely removes the need for ever touching your images. gulp-tinyimage is a work in progress and isn't complete.

## Features
- Highly Configurable
- Designed to output web friendly images

## Getting Started

Install the gulp-tinyimage using NPM or your favourite node package manager
```
$ npm install gulp-tinyimage
```

Add gulp-tinyimage to your gulpfile
```js
var gulpTinyimage = require('gulp-tinyimage');
```

Create a gulp task to start processing images
```js
gulp.task('images', function(done) {
  return gulp.src( imageFiles )
    .pipe(gulpTinyimage({
      maxWidth: 1000,
      maxHeight: 800,
      quality: 70,
      maxFilesize: 400,
      outputFormat: 'jpg',
      styles: {
        small: {
          maxWidth: 600,
          quality: 75
        }
      }
    }))
    .pipe(gulp.dest( './assets/img/' ))
});
```


## Configuration

| Option           | Type        | Default  | Description |
| ---------------- | ----------- | -------- | ----------- |
| maxWidth         | int         | 1000 | Set the maximum width the image can have. It'll be resized if its over |
| quality | int | 70 | The compression quality of the outputted image |
| format | string | jpg | Outputted image format |
| styles | object | null | Contains additional image styles |
| convertSvg | bool | true | Convert any SVGs to your specified format |

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