This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.ImageOptimizer.

Summary

Optimizes images in bulk

Assembly

Cake.ImageOptimizer.dll

Namespace

Cake.ImageOptimizer

Interfaces

IBulkImageOptimizer

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IBulkImageOptimizer"] click Interface0 "/api/Cake.ImageOptimizer/IBulkImageOptimizer" Type["BulkImageOptimizer"] class Type type-node

Syntax

public class BulkImageOptimizer : IBulkImageOptimizer

Constructors

Name	Summary
BulkImageOptimizer(IFileSystem, ICakeEnvironment, ICakeLog, IImageOptimizerFactory)	Initializes a new instance of the `BaseOptimizer` class.

Events

Name	Type	Summary
Completed	EventHandler<OptimizedFileEventArgs>	Triggered when the optimizer finishes processing all images
Progress	EventHandler<OptimizedFileEventArgs>	Triggered when the optimizer finishes processing each image

Properties

Name	Value	Summary
ImagesErrored	int	Gets the number of errored images
ImagesOptimized	IList<string>	Gets the list of paths to the optimized images
ImagesSkipped	int	Gets the number of images skipped
SavedPercent	double	Gets the percent in size saved
SavedSize	double	Gets the size in bytes saved during optimization
SizeAfter	double	Gets the size in bytes after optimization
SizeBefore	double	Gets the size in bytes before optimization

Methods

Name	Value	Summary
Clear()	void	Clears all local flags
Optimize(DirectoryPath, DirectoryPath, ImageOptimizerSettings)	IList<OptimizedFile>	Optimizes Images from the settings SourceDirectory
Optimize(string, DirectoryPath, DirectoryPath, IList<IFile>, IList<OptimizedFile>)	IList<OptimizedFile>	Optimizes a list of files using a given optimizer
Optimize(string, IFile, FilePath, IList<OptimizedFile>)	OptimizedFile	Optimizes a list of files using a given optimizer

Extension Methods

Name	Value	Summary
Dump<BulkImageOptimizer>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<BulkImageOptimizer>(BulkImageOptimizer[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<BulkImageOptimizer>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<BulkImageOptimizer>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<BulkImageOptimizer>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<BulkImageOptimizer>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin