TonyBrobston/jpegasus

**jpegasus**

> [Globals](../README.md) / ["types/Options"](../modules/_types_options_.md) / Options

# Interface: Options

## Hierarchy

* [InputOptions](_types_inputoptions_.inputoptions.md)

  ↳ **Options**

## Index

### Properties

* [allowCrossOriginResourceSharing](_types_options_.options.md#allowcrossoriginresourcesharing)
* [fixImageOrientation](_types_options_.options.md#fiximageorientation)
* [maxHeight](_types_options_.options.md#maxheight)
* [maxWidth](_types_options_.options.md#maxwidth)
* [preserveFileType](_types_options_.options.md#preservefiletype)
* [quality](_types_options_.options.md#quality)
* [returnOriginalIfCompressedFileIsLarger](_types_options_.options.md#returnoriginalifcompressedfileislarger)
* [returnOriginalOnFailure](_types_options_.options.md#returnoriginalonfailure)
* [scaleImageBy](_types_options_.options.md#scaleimageby)
* [transparencyFillColor](_types_options_.options.md#transparencyfillcolor)

## Properties

### allowCrossOriginResourceSharing

• `Readonly` **allowCrossOriginResourceSharing**: boolean

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[allowCrossOriginResourceSharing](_types_inputoptions_.inputoptions.md#allowcrossoriginresourcesharing)*

*Defined in [types/Options.ts:4](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L4)*

___

### fixImageOrientation

• `Readonly` **fixImageOrientation**: boolean

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[fixImageOrientation](_types_inputoptions_.inputoptions.md#fiximageorientation)*

*Defined in [types/Options.ts:5](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L5)*

___

### maxHeight

• `Optional` `Readonly` **maxHeight**: undefined \| number

*Inherited from [InputOptions](_types_inputoptions_.inputoptions.md).[maxHeight](_types_inputoptions_.inputoptions.md#maxheight)*

*Defined in [types/InputOptions.ts:10](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/InputOptions.ts#L10)*

___

### maxWidth

• `Optional` `Readonly` **maxWidth**: undefined \| number

*Inherited from [InputOptions](_types_inputoptions_.inputoptions.md).[maxWidth](_types_inputoptions_.inputoptions.md#maxwidth)*

*Defined in [types/InputOptions.ts:11](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/InputOptions.ts#L11)*

___

### preserveFileType

• `Readonly` **preserveFileType**: boolean

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[preserveFileType](_types_inputoptions_.inputoptions.md#preservefiletype)*

*Defined in [types/Options.ts:6](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L6)*

___

### quality

• `Readonly` **quality**: number

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[quality](_types_inputoptions_.inputoptions.md#quality)*

*Defined in [types/Options.ts:7](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L7)*

___

### returnOriginalIfCompressedFileIsLarger

• `Readonly` **returnOriginalIfCompressedFileIsLarger**: boolean

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[returnOriginalIfCompressedFileIsLarger](_types_inputoptions_.inputoptions.md#returnoriginalifcompressedfileislarger)*

*Defined in [types/Options.ts:9](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L9)*

___

### returnOriginalOnFailure

• `Readonly` **returnOriginalOnFailure**: boolean

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[returnOriginalOnFailure](_types_inputoptions_.inputoptions.md#returnoriginalonfailure)*

*Defined in [types/Options.ts:8](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L8)*

___

### scaleImageBy

• `Readonly` **scaleImageBy**: number

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[scaleImageBy](_types_inputoptions_.inputoptions.md#scaleimageby)*

*Defined in [types/Options.ts:10](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L10)*

___

### transparencyFillColor

• `Readonly` **transparencyFillColor**: string

*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[transparencyFillColor](_types_inputoptions_.inputoptions.md#transparencyfillcolor)*

*Defined in [types/Options.ts:11](https://github.com/TonyBrobston/jpegasus/blob/faa1275/src/types/Options.ts#L11)*