Skip to content

optidash-ai/optidash-gulp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Optidash

Optidash is a modern, AI-powered image optimization and processing API.
We will drastically speed-up your websites and save you money on bandwidth and storage.


The official Gulp plugin for image optimization with Optidash API.


Installation

$ npm install gulp-optidash --save-dev

Quick example

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
}

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: ""

compression

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

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

concurrency

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

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

License

This software is distributed under the MIT License. See the LICENSE file for more information.