Merge pull request #160 from TonyBrobston/refactor-options

refactor: clean up options interfaces

docs/README.md

@@ -4,7 +4,7 @@
 
 ## Index
 
-### External modules
+### Modules
 
 * ["index"](modules/_index_.md)
 * ["services/canvasService"](modules/_services_canvasservice_.md)
@@ -17,4 +17,3 @@
 * ["services/windowService"](modules/_services_windowservice_.md)
 * ["types/InputOptions"](modules/_types_inputoptions_.md)
 * ["types/Options"](modules/_types_options_.md)
-* ["types/SharedOptions"](modules/_types_sharedoptions_.md)

docs/interfaces/_types_inputoptions_.inputoptions.md

@@ -4,9 +4,9 @@
 
 ## Hierarchy
 
-* [SharedOptions](_types_sharedoptions_.sharedoptions.md)
+* **InputOptions**
 
-  ↳ **InputOptions**
+  ↳ [Options](_types_options_.options.md)
 
 ## Index
 
@@ -26,56 +26,52 @@
 
 • **allowCrossOriginResourceSharing**? : *undefined | false | true*
 
-*Defined in [types/InputOptions.ts:4](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/InputOptions.ts#L4)*
+*Defined in [types/InputOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L2)*
 
 ___
 
 ### `Optional` maxHeight
 
 • **maxHeight**? : *undefined | number*
 
-*Inherited from [SharedOptions](_types_sharedoptions_.sharedoptions.md).[maxHeight](_types_sharedoptions_.sharedoptions.md#optional-maxheight)*
-
-*Defined in [types/SharedOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/SharedOptions.ts#L2)*
+*Defined in [types/InputOptions.ts:7](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L7)*
 
 ___
 
 ### `Optional` maxWidth
 
 • **maxWidth**? : *undefined | number*
 
-*Inherited from [SharedOptions](_types_sharedoptions_.sharedoptions.md).[maxWidth](_types_sharedoptions_.sharedoptions.md#optional-maxwidth)*
-
-*Defined in [types/SharedOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/SharedOptions.ts#L3)*
+*Defined in [types/InputOptions.ts:8](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L8)*
 
 ___
 
 ### `Optional` quality
 
 • **quality**? : *undefined | number*
 
-*Defined in [types/InputOptions.ts:5](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/InputOptions.ts#L5)*
+*Defined in [types/InputOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L3)*
 
 ___
 
 ### `Optional` returnOriginalIfCompressedFileIsLarger
 
 • **returnOriginalIfCompressedFileIsLarger**? : *undefined | false | true*
 
-*Defined in [types/InputOptions.ts:7](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/InputOptions.ts#L7)*
+*Defined in [types/InputOptions.ts:5](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L5)*
 
 ___
 
 ### `Optional` returnOriginalOnFailure
 
 • **returnOriginalOnFailure**? : *undefined | false | true*
 
-*Defined in [types/InputOptions.ts:6](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/InputOptions.ts#L6)*
+*Defined in [types/InputOptions.ts:4](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L4)*
 
 ___
 
 ### `Optional` scaleImageBy
 
 • **scaleImageBy**? : *undefined | number*
 
-*Defined in [types/InputOptions.ts:8](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/InputOptions.ts#L8)*
+*Defined in [types/InputOptions.ts:6](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L6)*

docs/interfaces/_types_options_.options.md

@@ -4,78 +4,88 @@
 
 ## Hierarchy
 
-* [SharedOptions](_types_sharedoptions_.sharedoptions.md)
+* [InputOptions](_types_inputoptions_.inputoptions.md)
 
   ↳ **Options**
 
 ## Index
 
 ### Properties
 
-* [allowCrossOriginResourceSharing](_types_options_.options.md#allowcrossoriginresourcesharing)
+* [allowCrossOriginResourceSharing](_types_options_.options.md#readonly-allowcrossoriginresourcesharing)
 * [maxHeight](_types_options_.options.md#optional-maxheight)
 * [maxWidth](_types_options_.options.md#optional-maxwidth)
-* [quality](_types_options_.options.md#quality)
-* [returnOriginalIfCompressedFileIsLarger](_types_options_.options.md#returnoriginalifcompressedfileislarger)
-* [returnOriginalOnFailure](_types_options_.options.md#returnoriginalonfailure)
-* [scaleImageBy](_types_options_.options.md#scaleimageby)
+* [quality](_types_options_.options.md#readonly-quality)
+* [returnOriginalIfCompressedFileIsLarger](_types_options_.options.md#readonly-returnoriginalifcompressedfileislarger)
+* [returnOriginalOnFailure](_types_options_.options.md#readonly-returnoriginalonfailure)
+* [scaleImageBy](_types_options_.options.md#readonly-scaleimageby)
 
 ## Properties
 
-###  allowCrossOriginResourceSharing
+### `Readonly` allowCrossOriginResourceSharing
 
 • **allowCrossOriginResourceSharing**: *boolean*
 
-*Defined in [types/Options.ts:4](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/Options.ts#L4)*
+*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[allowCrossOriginResourceSharing](_types_inputoptions_.inputoptions.md#optional-allowcrossoriginresourcesharing)*
+
+*Defined in [types/Options.ts:4](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/Options.ts#L4)*
 
 ___
 
 ### `Optional` maxHeight
 
 • **maxHeight**? : *undefined | number*
 
-*Inherited from [SharedOptions](_types_sharedoptions_.sharedoptions.md).[maxHeight](_types_sharedoptions_.sharedoptions.md#optional-maxheight)*
+*Inherited from [InputOptions](_types_inputoptions_.inputoptions.md).[maxHeight](_types_inputoptions_.inputoptions.md#optional-maxheight)*
 
-*Defined in [types/SharedOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/SharedOptions.ts#L2)*
+*Defined in [types/InputOptions.ts:7](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L7)*
 
 ___
 
 ### `Optional` maxWidth
 
 • **maxWidth**? : *undefined | number*
 
-*Inherited from [SharedOptions](_types_sharedoptions_.sharedoptions.md).[maxWidth](_types_sharedoptions_.sharedoptions.md#optional-maxwidth)*
+*Inherited from [InputOptions](_types_inputoptions_.inputoptions.md).[maxWidth](_types_inputoptions_.inputoptions.md#optional-maxwidth)*
 
-*Defined in [types/SharedOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/SharedOptions.ts#L3)*
+*Defined in [types/InputOptions.ts:8](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/InputOptions.ts#L8)*
 
 ___
 
-###  quality
+### `Readonly` quality
 
 • **quality**: *number*
 
-*Defined in [types/Options.ts:5](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/Options.ts#L5)*
+*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[quality](_types_inputoptions_.inputoptions.md#optional-quality)*
+
+*Defined in [types/Options.ts:5](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/Options.ts#L5)*
 
 ___
 
-###  returnOriginalIfCompressedFileIsLarger
+### `Readonly` returnOriginalIfCompressedFileIsLarger
 
 • **returnOriginalIfCompressedFileIsLarger**: *boolean*
 
-*Defined in [types/Options.ts:7](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/Options.ts#L7)*
+*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[returnOriginalIfCompressedFileIsLarger](_types_inputoptions_.inputoptions.md#optional-returnoriginalifcompressedfileislarger)*
+
+*Defined in [types/Options.ts:7](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/Options.ts#L7)*
 
 ___
 
-###  returnOriginalOnFailure
+### `Readonly` returnOriginalOnFailure
 
 • **returnOriginalOnFailure**: *boolean*
 
-*Defined in [types/Options.ts:6](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/Options.ts#L6)*
+*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[returnOriginalOnFailure](_types_inputoptions_.inputoptions.md#optional-returnoriginalonfailure)*
+
+*Defined in [types/Options.ts:6](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/Options.ts#L6)*
 
 ___
 
-###  scaleImageBy
+### `Readonly` scaleImageBy
 
 • **scaleImageBy**: *number*
 
-*Defined in [types/Options.ts:8](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/Options.ts#L8)*
+*Overrides [InputOptions](_types_inputoptions_.inputoptions.md).[scaleImageBy](_types_inputoptions_.inputoptions.md#optional-scaleimageby)*
+
+*Defined in [types/Options.ts:8](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/types/Options.ts#L8)*

docs/modules/_index_.md

@@ -1,6 +1,6 @@
 [jpegasus](../README.md) › ["index"](_index_.md)
 
-# External module: "index"
+# Module: "index"
 
 ## Index
 
@@ -18,15 +18,15 @@
 
 • **determineOrientation**: *[determineOrientation](_services_exifservice_.md#const-determineorientation)* = exifService.determineOrientation
 
-*Defined in [index.ts:32](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/index.ts#L32)*
+*Defined in [index.ts:30](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/index.ts#L30)*
 
 ## Functions
 
 ### `Const` compress
 
 ▸ **compress**(`file`: File, `inputOptions`: [InputOptions](../interfaces/_types_inputoptions_.inputoptions.md)): *Promise‹File | Blob›*
 
-*Defined in [index.ts:8](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/index.ts#L8)*
+*Defined in [index.ts:8](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/index.ts#L8)*
 
 **Parameters:**
 

docs/modules/_services_canvasservice_.md

@@ -1,6 +1,6 @@
 [jpegasus](../README.md) › ["services/canvasService"](_services_canvasservice_.md)
 
-# External module: "services/canvasService"
+# Module: "services/canvasService"
 
 ## Index
 
@@ -16,7 +16,7 @@
 
 ▸ **correctExifRotation**(`context`: CanvasTransform, `orientation`: number, `height`: number, `width`: number): *void*
 
-*Defined in [services/canvasService.ts:14](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/canvasService.ts#L14)*
+*Defined in [services/canvasService.ts:14](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/canvasService.ts#L14)*
 
 **Parameters:**
 
@@ -35,7 +35,7 @@ ___
 
 ▸ **create**(`file`: File, `image`: HTMLImageElement, `scale`: number): *Promise‹HTMLCanvasElement›*
 
-*Defined in [services/canvasService.ts:42](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/canvasService.ts#L42)*
+*Defined in [services/canvasService.ts:42](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/canvasService.ts#L42)*
 
 **Parameters:**
 
@@ -53,7 +53,7 @@ ___
 
 ▸ **setCanvasDimensions**(`canvas`: HTMLCanvasElement, `orientation`: number, `scaledHeight`: number, `scaledWidth`: number): *void*
 
-*Defined in [services/canvasService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/canvasService.ts#L3)*
+*Defined in [services/canvasService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/canvasService.ts#L3)*
 
 **Parameters:**
 

docs/modules/_services_exifservice_.md

@@ -1,6 +1,6 @@
 [jpegasus](../README.md) › ["services/exifService"](_services_exifservice_.md)
 
-# External module: "services/exifService"
+# Module: "services/exifService"
 
 ## Index
 
@@ -24,55 +24,55 @@
 
 • **applicationSegmentOneMarker**: *65505* = 65505
 
-*Defined in [services/exifService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L1)*
+*Defined in [services/exifService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L1)*
 
 ___
 
 ### `Const` beginOfExifHeaderMarker
 
 • **beginOfExifHeaderMarker**: *1165519206* = 1165519206
 
-*Defined in [services/exifService.ts:2](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L2)*
+*Defined in [services/exifService.ts:2](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L2)*
 
 ___
 
 ### `Const` byteOrderMarker
 
 • **byteOrderMarker**: *18761* = 18761
 
-*Defined in [services/exifService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L3)*
+*Defined in [services/exifService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L3)*
 
 ___
 
 ### `Const` byteStuffingMarker
 
 • **byteStuffingMarker**: *65280* = 65280
 
-*Defined in [services/exifService.ts:4](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L4)*
+*Defined in [services/exifService.ts:4](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L4)*
 
 ___
 
 ### `Const` orientationMarker
 
 • **orientationMarker**: *274* = 274
 
-*Defined in [services/exifService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L5)*
+*Defined in [services/exifService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L5)*
 
 ___
 
 ### `Const` startOfFileMarker
 
 • **startOfFileMarker**: *65496* = 65496
 
-*Defined in [services/exifService.ts:6](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L6)*
+*Defined in [services/exifService.ts:6](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L6)*
 
 ## Functions
 
 ### `Const` determineOrientation
 
 ▸ **determineOrientation**(`file`: File): *Promise‹number›*
 
-*Defined in [services/exifService.ts:35](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L35)*
+*Defined in [services/exifService.ts:35](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L35)*
 
 **Parameters:**
 
@@ -88,7 +88,7 @@ ___
 
 ▸ **parseBytes**(`dataView`: DataView, `resolve`: function): *void*
 
-*Defined in [services/exifService.ts:8](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/exifService.ts#L8)*
+*Defined in [services/exifService.ts:8](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/exifService.ts#L8)*
 
 **Parameters:**