@coffeekraken/s-images-builder

{{#> layout-readme }}

SImagesBuilder

This package expose a simple SImagesBuilder class that lets you build, compress, resize, etc... your images.

Features

This builder class gives you some features like:

• Set a target quality
• Specify max width and height
• Generate .webp version of each images
• Specify multiple resolutions like [1,2,3] that will generate multiple files for each images
• Specify specific parameters for somr sub-directory, etc...
• And more...

Usage

To make use of this builder, you have two choices:

Using the sugar CLI

Simply call this command:

sugar images.build [arguments]

For arguments documentation, simple use:

sugar images.build -h

Using the API

Here's a simple usage example

import __SImagesBuilder from '@coffeekraken/s-images-builder';
const builder = new __SImagesBuilder();
await builder.build({});

Build parameters

{{> interface namespace='@coffeekraken.s-images-builder.node.interface.SImagesBuilderBuildParamsInterface' }}

Settings

{{> interface namespace='@coffeekraken.s-images-builder.node.interface.SImagesBuilderSettingsInterface' }}

API

For more information about the API, please check out the API documentation

{{/ layout-readme }}