The official Gulp plugin for Optidash API

Head over to the Optidash API docs for a full API reference.

Installation

$ npm install gulp-optidash --save-dev

Quick examples

const gulp = require("gulp"),
const opti = require("gulp-optidash");

exports.default = () => (
    gulp.src("src/images/*")
        .pipe(opti({
            key: "your-optidash-api-key"
        }))
        .pipe(gulp.dest("dist/images"))
);

Options

{
    key: "optidash-api-key"
    compression: "medium",
    concurrency: 6
}

options.key

Your Optidash API Key. If you don't have your API Key just yet, you can sign-up for a free account which comes with a monthly quota of 500 API calls.

  • type: string
  • default: ""

options.compression

Controls compression and optimization mode as described in the Optidash API Docs.

  • type: string
  • values: lossless | low | medium | high
  • default: medium

options.concurrency

Controls the maxium number of input images that may be performed in parallel.

  • type: number
  • values: 1 - 16
  • default: 6

Ready to try Optidash?

Start optimizing your images smarter. Integrate in minutes.