https://github.com/optidash-ai/optidash-grunt
The official Grunt plugin for Optidash API
https://github.com/optidash-ai/optidash-grunt
image-analysis image-manipulation image-optimization image-processing image-resizing optidash
Last synced: about 1 month ago
JSON representation
The official Grunt plugin for Optidash API
- Host: GitHub
- URL: https://github.com/optidash-ai/optidash-grunt
- Owner: optidash-ai
- License: mit
- Created: 2020-06-11T12:17:00.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-12T11:49:15.000Z (almost 6 years ago)
- Last Synced: 2025-07-08T21:42:58.139Z (11 months ago)
- Topics: image-analysis, image-manipulation, image-optimization, image-processing, image-resizing, optidash
- Language: JavaScript
- Homepage: https://optidash.ai
- Size: 12.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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 Grunt task for image optimization with Optidash API.
---
### Installation
```bash
$ npm install grunt-optidash --save-dev
```
### Quick example
```js
const grunt = require("grunt");
const optidash = require("grunt-optidash");
grunt.initConfig({
optidash: {
options: {
key: "your-optidash-api-key"
},
dynamic: {
files: [{
expand: true,
cwd: "src/",
src: ["**/*.{png,jpg,jpeg,gif,svg,webp}"],
dest: "dist/"
}]
}
}
});
grunt.loadNpmTasks("grunt-optidash");
grunt.registerTask("default", ["optidash"]);
```
### Options
```js
{
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](https://app.optidash.ai/signup) 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](https://docs.optidash.ai/optimization/overview#lossy-optimization-presets).
* 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](LICENSE) file for more information.