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

Base class for all image optimizers.

Assembly

Cake.ImageOptimizer.dll

Namespace

Cake.ImageOptimizer

Base Types

Object

Derived Types

graph BT Type-->Base0["Object"] Type["BaseOptimizer"] class Type type-node Derived0["BaseLocalOptimizer"]-->Type click Derived0 "/api/Cake.ImageOptimizer/BaseLocalOptimizer" Derived1["BaseRemoteOptimizer"]-->Type click Derived1 "/api/Cake.ImageOptimizer/BaseRemoteOptimizer"

Syntax

public abstract class BaseOptimizer

Constructors

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

Fields

Name	Constant Value	Summary
_Environment		Represents the environment Cake operates in.
_FileSystem		Represents a file system.
_Log		Represents a log.

Properties

Name	Value	Summary
Extensions	IList<string>	A list of extensions supported by the Optimizer
FileSize	int	Gets the maximum file size to optimize.
Name	string	Gets the name of the optimizer.
Timeout	int	Gets the maximum timespan for the request.

Methods

Name	Value	Summary
Supports(string)	bool	Does the specified file.

Extension Methods

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