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

An interface for describing an image optimizer factory

Assembly

Cake.ImageOptimizer.dll

Namespace

Cake.ImageOptimizer

Implementing Types

ImageOptimizerFactory

graph BT Type["IImageOptimizerFactory"] class Type type-node Implementing0["ImageOptimizerFactory"]-.->Type click Implementing0 "/api/Cake.ImageOptimizer/ImageOptimizerFactory"

Syntax

public interface IImageOptimizerFactory

Methods

Name	Value	Summary
Add(IImageOptimizer)	void	Adds an optimizer to the factory
Clear()	void	Removes all optimizers from the factory
Configure(ICakeEnvironment)	void	Configure the optimizer
GetByExtension(string)	IImageOptimizer	Get an optimizer from the factory
GetByName(string)	IImageOptimizer	Get an optimizer from the factory
GetByPath(FilePath)	IImageOptimizer	Get an optimizer from the factory
Optimize(string, FilePath, FilePath)	ImageOptimizerResult	Get an optimizer from the factory
Optimize(string, FilePath)	ImageOptimizerResult	Get an optimizer from the factory
Remove(IImageOptimizer)	void	Removes an optimizer from the factory
Supports(string)	bool	Does the optimzer support the image

Extension Methods

Name	Value	Summary
Dump<IImageOptimizerFactory>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<IImageOptimizerFactory>(IImageOptimizerFactory[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<IImageOptimizerFactory>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<IImageOptimizerFactory>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<IImageOptimizerFactory>(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<IImageOptimizerFactory>(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

IImageOptimizerFactory Interface

Summary

Syntax

Methods

Extension Methods