@hidoo/gulp-plugin-image-placeholder v1.0.0-alpha.4

@hidoo/gulp-plugin-image-placeholder

Plugin that add image of placeholder for gulp.

Installation

$ npm install --save-dev gulp@next @hidoo/gulp-plugin-image-placeholder

Usage

import { src, dest, task } from 'gulp';
import imagePlaceholder from '@hidoo/gulp-plugin-image-placeholder';

task('placeholder', () =>
  src('/path/to/src').pipe(imagePlaceholder()).pipe(dest('/path/to/dest'))
);

Supported formats

• PNG
• JPEG
• GIF
• SVG

API

imagePlaceholder

return placeholder image.

Parameters

• options Object option (optional, default {})

  • options.append Boolean append placeholder or not (optional, default true)
  • options.suffix String placeholder image suffix (optional, default 'placeholder')
  • options.verbose Boolean out log or not (optional, default false)

Examples

import { src, dest, task } from 'gulp';
import imagePlaceholder from '@hidoo/gulp-plugin-image-placeholder';

task('placeholder', () =>
  src('/path/to/src')
    .pipe(
      imagePlaceholder({
        append: false,
        suffix: 'placehold',
        verbose: true
      })
    )
    .pipe(dest('/path/to/dest'))
);

Returns DestroyableTransform

Test

$ pnpm test

License

MIT