Merge pull request #150 from TonyBrobston/update-documentation

docs: updating documentation
TonyBrobston · May 14, 2020 · e8ecd1e · e8ecd1e
2 parents 1deeeae + 076f66b
commit e8ecd1e
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 34 deletions.
diff --git a/docs/interfaces/_types_inputoptions_.inputoptions.md b/docs/interfaces/_types_inputoptions_.inputoptions.md
@@ -16,6 +16,7 @@
 * [maxHeight](_types_inputoptions_.inputoptions.md#optional-maxheight)
 * [maxWidth](_types_inputoptions_.inputoptions.md#optional-maxwidth)
 * [quality](_types_inputoptions_.inputoptions.md#optional-quality)
+* [returnOriginalIfCompressedFileIsLarger](_types_inputoptions_.inputoptions.md#optional-returnoriginalifcompressedfileislarger)
 * [returnOriginalOnFailure](_types_inputoptions_.inputoptions.md#optional-returnoriginalonfailure)
 * [scaleImageBy](_types_inputoptions_.inputoptions.md#optional-scaleimageby)
 
@@ -25,7 +26,7 @@
 
 • **allowCrossOriginResourceSharing**? : *undefined | false | true*
 
-*Defined in [types/InputOptions.ts:4](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/InputOptions.ts#L4)*
+*Defined in [types/InputOptions.ts:4](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/InputOptions.ts#L4)*
 
 ___
 
@@ -35,7 +36,7 @@ ___
 
 *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/78e3a3f/src/types/SharedOptions.ts#L2)*
+*Defined in [types/SharedOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/SharedOptions.ts#L2)*
 
 ___
 
@@ -45,28 +46,36 @@ ___
 
 *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/78e3a3f/src/types/SharedOptions.ts#L3)*
+*Defined in [types/SharedOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/SharedOptions.ts#L3)*
 
 ___
 
 ### `Optional` quality
 
 • **quality**? : *undefined | number*
 
-*Defined in [types/InputOptions.ts:5](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/InputOptions.ts#L5)*
+*Defined in [types/InputOptions.ts:5](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/InputOptions.ts#L5)*
+
+___
+
+### `Optional` returnOriginalIfCompressedFileIsLarger
+
+• **returnOriginalIfCompressedFileIsLarger**? : *undefined | false | true*
+
+*Defined in [types/InputOptions.ts:7](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/InputOptions.ts#L7)*
 
 ___
 
 ### `Optional` returnOriginalOnFailure
 
 • **returnOriginalOnFailure**? : *undefined | false | true*
 
-*Defined in [types/InputOptions.ts:6](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/InputOptions.ts#L6)*
+*Defined in [types/InputOptions.ts:6](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/InputOptions.ts#L6)*
 
 ___
 
 ### `Optional` scaleImageBy
 
 • **scaleImageBy**? : *undefined | number*
 
-*Defined in [types/InputOptions.ts:7](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/InputOptions.ts#L7)*
+*Defined in [types/InputOptions.ts:8](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/InputOptions.ts#L8)*
diff --git a/docs/interfaces/_types_options_.options.md b/docs/interfaces/_types_options_.options.md
@@ -16,6 +16,7 @@
 * [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)
 
@@ -25,7 +26,7 @@
 
 • **allowCrossOriginResourceSharing**: *boolean*
 
-*Defined in [types/Options.ts:4](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/Options.ts#L4)*
+*Defined in [types/Options.ts:4](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/Options.ts#L4)*
 
 ___
 
@@ -35,7 +36,7 @@ ___
 
 *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/78e3a3f/src/types/SharedOptions.ts#L2)*
+*Defined in [types/SharedOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/SharedOptions.ts#L2)*
 
 ___
 
@@ -45,28 +46,36 @@ ___
 
 *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/78e3a3f/src/types/SharedOptions.ts#L3)*
+*Defined in [types/SharedOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/SharedOptions.ts#L3)*
 
 ___
 
 ###  quality
 
 • **quality**: *number*
 
-*Defined in [types/Options.ts:5](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/Options.ts#L5)*
+*Defined in [types/Options.ts:5](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/Options.ts#L5)*
+
+___
+
+###  returnOriginalIfCompressedFileIsLarger
+
+• **returnOriginalIfCompressedFileIsLarger**: *boolean*
+
+*Defined in [types/Options.ts:7](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/Options.ts#L7)*
 
 ___
 
 ###  returnOriginalOnFailure
 
 • **returnOriginalOnFailure**: *boolean*
 
-*Defined in [types/Options.ts:6](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/Options.ts#L6)*
+*Defined in [types/Options.ts:6](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/Options.ts#L6)*
 
 ___
 
 ###  scaleImageBy
 
 • **scaleImageBy**: *number*
 
-*Defined in [types/Options.ts:7](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/Options.ts#L7)*
+*Defined in [types/Options.ts:8](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/Options.ts#L8)*
diff --git a/docs/interfaces/_types_sharedoptions_.sharedoptions.md b/docs/interfaces/_types_sharedoptions_.sharedoptions.md
@@ -23,12 +23,12 @@
 
 • **maxHeight**? : *undefined | number*
 
-*Defined in [types/SharedOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/SharedOptions.ts#L2)*
+*Defined in [types/SharedOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/SharedOptions.ts#L2)*
 
 ___
 
 ### `Optional` maxWidth
 
 • **maxWidth**? : *undefined | number*
 
-*Defined in [types/SharedOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/types/SharedOptions.ts#L3)*
+*Defined in [types/SharedOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/types/SharedOptions.ts#L3)*
diff --git a/docs/modules/_index_.md b/docs/modules/_index_.md
@@ -14,7 +14,7 @@
 
 ▸ **compress**(`file`: File, `inputOptions`: [InputOptions](../interfaces/_types_inputoptions_.inputoptions.md)): *Promise‹File | Blob›*
 
-*Defined in [index.ts:7](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/index.ts#L7)*
+*Defined in [index.ts:7](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/index.ts#L7)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_canvasservice_.md b/docs/modules/_services_canvasservice_.md
@@ -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/78e3a3f/src/services/canvasService.ts#L14)*
+*Defined in [services/canvasService.ts:14](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/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/78e3a3f/src/services/canvasService.ts#L42)*
+*Defined in [services/canvasService.ts:42](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/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/78e3a3f/src/services/canvasService.ts#L3)*
+*Defined in [services/canvasService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/canvasService.ts#L3)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_exifservice_.md b/docs/modules/_services_exifservice_.md
@@ -24,55 +24,55 @@
 
 • **applicationSegmentOneMarker**: *65505* = 65505
 
-*Defined in [services/exifService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/exifService.ts#L1)*
+*Defined in [services/exifService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/exifService.ts#L1)*
 
 ___
 
 ### `Const` beginOfExifHeaderMarker
 
 • **beginOfExifHeaderMarker**: *1165519206* = 1165519206
 
-*Defined in [services/exifService.ts:2](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/exifService.ts#L2)*
+*Defined in [services/exifService.ts:2](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/exifService.ts#L2)*
 
 ___
 
 ### `Const` byteOrderMarker
 
 • **byteOrderMarker**: *18761* = 18761
 
-*Defined in [services/exifService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/exifService.ts#L3)*
+*Defined in [services/exifService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/exifService.ts#L3)*
 
 ___
 
 ### `Const` byteStuffingMarker
 
 • **byteStuffingMarker**: *65280* = 65280
 
-*Defined in [services/exifService.ts:4](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/exifService.ts#L4)*
+*Defined in [services/exifService.ts:4](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/exifService.ts#L4)*
 
 ___
 
 ### `Const` orientationMarker
 
 • **orientationMarker**: *274* = 274
 
-*Defined in [services/exifService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/exifService.ts#L5)*
+*Defined in [services/exifService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/exifService.ts#L5)*
 
 ___
 
 ### `Const` startOfFileMarker
 
 • **startOfFileMarker**: *65496* = 65496
 
-*Defined in [services/exifService.ts:6](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/exifService.ts#L6)*
+*Defined in [services/exifService.ts:6](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/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/78e3a3f/src/services/exifService.ts#L35)*
+*Defined in [services/exifService.ts:35](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/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/78e3a3f/src/services/exifService.ts#L8)*
+*Defined in [services/exifService.ts:8](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/exifService.ts#L8)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_fileservice_.md b/docs/modules/_services_fileservice_.md
@@ -15,7 +15,7 @@
 
 ▸ **create**(`bytes`: Uint8Array[], `type`: string, `name`: string): *File | Blob*
 
-*Defined in [services/fileService.ts:9](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/fileService.ts#L9)*
+*Defined in [services/fileService.ts:9](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/fileService.ts#L9)*
 
 **Parameters:**
 
@@ -33,7 +33,7 @@ ___
 
 ▸ **validate**(`file`: File): *boolean*
 
-*Defined in [services/fileService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/fileService.ts#L1)*
+*Defined in [services/fileService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/fileService.ts#L1)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_imageservice_.md b/docs/modules/_services_imageservice_.md
@@ -14,7 +14,7 @@
 
 ▸ **create**(`file`: File, `options`: [Options](../interfaces/_types_options_.options.md)): *Promise‹HTMLImageElement›*
 
-*Defined in [services/imageService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/imageService.ts#L3)*
+*Defined in [services/imageService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/imageService.ts#L3)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_optionservice_.md b/docs/modules/_services_optionservice_.md
@@ -14,7 +14,7 @@
 
 ▸ **override**(`inputOptions`: [InputOptions](../interfaces/_types_inputoptions_.inputoptions.md)): *[Options](../interfaces/_types_options_.options.md)*
 
-*Defined in [services/optionService.ts:4](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/optionService.ts#L4)*
+*Defined in [services/optionService.ts:4](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/optionService.ts#L4)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_qualityservice_.md b/docs/modules/_services_qualityservice_.md
@@ -14,7 +14,7 @@
 
 ▸ **toFile**(`file`: File, `canvas`: HTMLCanvasElement, `__namedParameters`: object): *File | Blob*
 
-*Defined in [services/qualityService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/qualityService.ts#L5)*
+*Defined in [services/qualityService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/qualityService.ts#L5)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_scaleservice_.md b/docs/modules/_services_scaleservice_.md
@@ -15,7 +15,7 @@
 
 ▸ **determineScale**(`__namedParameters`: object, `__namedParameters`: object): *number*
 
-*Defined in [services/scaleService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/scaleService.ts#L5)*
+*Defined in [services/scaleService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/scaleService.ts#L5)*
 
 **Parameters:**
 
@@ -42,7 +42,7 @@ ___
 
 ▸ **toCanvas**(`file`: File, `options`: [Options](../interfaces/_types_options_.options.md)): *Promise‹HTMLCanvasElement›*
 
-*Defined in [services/scaleService.ts:19](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/scaleService.ts#L19)*
+*Defined in [services/scaleService.ts:19](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/scaleService.ts#L19)*
 
 **Parameters:**
 

diff --git a/docs/modules/_services_windowservice_.md b/docs/modules/_services_windowservice_.md
@@ -14,7 +14,7 @@
 
 ▸ **toByteArray**(`base64`: string): *Uint8Array[]*
 
-*Defined in [services/windowService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/78e3a3f/src/services/windowService.ts#L1)*
+*Defined in [services/windowService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/1deeeae/src/services/windowService.ts#L1)*
 
 **Parameters:**