# ionic-gulp-image-task

> Image copy and optimisation Gulp task to use in ionic2 projects

Latest version **1.0.1** (published 2016-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install ionic-gulp-image-task
pnpm add ionic-gulp-image-task
yarn add ionic-gulp-image-task
bun add ionic-gulp-image-task
```

## 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.0.1 |
| Published | 2016-05-21 |
| First published | 2016-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Michael Fahrmair |
| Maintainers | fahrmairm |

## Links

- npm: https://www.npmjs.com/package/ionic-gulp-image-task
- Repository: https://github.com/fahrmairm/ionic-gulp-image-task
- Homepage: https://github.com/fahrmairm/ionic-gulp-image-task#readme
- Issues: https://github.com/fahrmairm/ionic-gulp-image-task/issues
- npm.io page: https://npm.io/package/ionic-gulp-image-task

## Dependencies (2)

- [gulp](https://npm.io/package/gulp.md) ^3.9.1
- [gulp-image](https://npm.io/package/gulp-image.md) ^2.0.0

## Recent versions

- 1.0.1 (latest) — 2016-05-21
- 1.0.0 — 2016-05-21

## README

# Image Copy and Optimization Task
Copy image resources to build directory and optimizes them. This project is created in the style of the other ionic-gulp-* tasks used in the ``gulpfile.js`` of starter projects created with the ionic2 generator, e.g. (https://github.com/driftyco/ionic-gulp-tasks). It should be considered temporary until Ionic releases something official. It is published as npm module so that it can be easily included (and reapplied during beta changes) of the ionic2 build-tools. 

## Installation
```
$ npm install --save-dev ionic-gulp-image-task
```
## API

### imageCopyOptimize([options])

Returns a [stream](http://nodejs.org/api/stream.html) of [Vinyl files](https://github.com/wearefractal/vinyl-fs)
that can be [piped](http://nodejs.org/api/stream.html#stream_readable_pipe_destination_options).

#### Available options:
- **src** (String|Array) Glob or array of globs ([What's a glob?](https://github.com/isaacs/node-glob#glob-primer)) matching image source files. Default: `'resources/www/img/**/*'`.
- **dest** (String) Output path for the HTML files. Default: `'www/img'`.

## Example

```
var imageCopyOptimize = require('ionic-gulp-image-task');

gulp.task('image', imageCopyOptimize);

gulp.task('image', function(){
  return imageCopyOptimize({ dest: 'www/my-custom-build-dir'});
});
```

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