diff --git a/docs/README.md b/docs/README.md index 39eb8b6..ed14eb3 100644 --- a/docs/README.md +++ b/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) diff --git a/docs/interfaces/_types_inputoptions_.inputoptions.md b/docs/interfaces/_types_inputoptions_.inputoptions.md index 79ac83f..82d4946 100644 --- a/docs/interfaces/_types_inputoptions_.inputoptions.md +++ b/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,7 +26,7 @@ • **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)* ___ @@ -34,9 +34,7 @@ ___ • **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)* ___ @@ -44,9 +42,7 @@ ___ • **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)* ___ @@ -54,7 +50,7 @@ ___ • **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)* ___ @@ -62,7 +58,7 @@ ___ • **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)* ___ @@ -70,7 +66,7 @@ ___ • **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)* ___ @@ -78,4 +74,4 @@ ___ • **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)* diff --git a/docs/interfaces/_types_options_.options.md b/docs/interfaces/_types_options_.options.md index f9c5819..9884697 100644 --- a/docs/interfaces/_types_options_.options.md +++ b/docs/interfaces/_types_options_.options.md @@ -4,7 +4,7 @@ ## Hierarchy -* [SharedOptions](_types_sharedoptions_.sharedoptions.md) +* [InputOptions](_types_inputoptions_.inputoptions.md) ↳ **Options** @@ -12,21 +12,23 @@ ### 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)* ___ @@ -34,9 +36,9 @@ ___ • **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)* ___ @@ -44,38 +46,46 @@ ___ • **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)* diff --git a/docs/interfaces/_types_sharedoptions_.sharedoptions.md b/docs/interfaces/_types_sharedoptions_.sharedoptions.md deleted file mode 100644 index f931b71..0000000 --- a/docs/interfaces/_types_sharedoptions_.sharedoptions.md +++ /dev/null @@ -1,34 +0,0 @@ -[jpegasus](../README.md) › ["types/SharedOptions"](../modules/_types_sharedoptions_.md) › [SharedOptions](_types_sharedoptions_.sharedoptions.md) - -# Interface: SharedOptions - -## Hierarchy - -* **SharedOptions** - - ↳ [InputOptions](_types_inputoptions_.inputoptions.md) - - ↳ [Options](_types_options_.options.md) - -## Index - -### Properties - -* [maxHeight](_types_sharedoptions_.sharedoptions.md#optional-maxheight) -* [maxWidth](_types_sharedoptions_.sharedoptions.md#optional-maxwidth) - -## Properties - -### `Optional` maxHeight - -• **maxHeight**? : *undefined | number* - -*Defined in [types/SharedOptions.ts:2](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/SharedOptions.ts#L2)* - -___ - -### `Optional` maxWidth - -• **maxWidth**? : *undefined | number* - -*Defined in [types/SharedOptions.ts:3](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/types/SharedOptions.ts#L3)* diff --git a/docs/modules/_index_.md b/docs/modules/_index_.md index dd89319..40462e2 100644 --- a/docs/modules/_index_.md +++ b/docs/modules/_index_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["index"](_index_.md) -# External module: "index" +# Module: "index" ## Index @@ -18,7 +18,7 @@ • **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 @@ -26,7 +26,7 @@ ▸ **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:** diff --git a/docs/modules/_services_canvasservice_.md b/docs/modules/_services_canvasservice_.md index 61fb5d5..a463fde 100644 --- a/docs/modules/_services_canvasservice_.md +++ b/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:** diff --git a/docs/modules/_services_exifservice_.md b/docs/modules/_services_exifservice_.md index 7bbf5cb..fc34cc1 100644 --- a/docs/modules/_services_exifservice_.md +++ b/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,7 +24,7 @@ • **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)* ___ @@ -32,7 +32,7 @@ ___ • **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)* ___ @@ -40,7 +40,7 @@ ___ • **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)* ___ @@ -48,7 +48,7 @@ ___ • **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)* ___ @@ -56,7 +56,7 @@ ___ • **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)* ___ @@ -64,7 +64,7 @@ ___ • **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 @@ -72,7 +72,7 @@ ___ ▸ **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:** diff --git a/docs/modules/_services_fileservice_.md b/docs/modules/_services_fileservice_.md index 42cf264..2282830 100644 --- a/docs/modules/_services_fileservice_.md +++ b/docs/modules/_services_fileservice_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["services/fileService"](_services_fileservice_.md) -# External module: "services/fileService" +# Module: "services/fileService" ## Index @@ -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/03dd45f/src/services/fileService.ts#L9)* +*Defined in [services/fileService.ts:9](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/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/03dd45f/src/services/fileService.ts#L1)* +*Defined in [services/fileService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/fileService.ts#L1)* **Parameters:** diff --git a/docs/modules/_services_imageservice_.md b/docs/modules/_services_imageservice_.md index 8d773e2..82a0095 100644 --- a/docs/modules/_services_imageservice_.md +++ b/docs/modules/_services_imageservice_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["services/imageService"](_services_imageservice_.md) -# External module: "services/imageService" +# Module: "services/imageService" ## Index @@ -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/03dd45f/src/services/imageService.ts#L3)* +*Defined in [services/imageService.ts:3](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/imageService.ts#L3)* **Parameters:** diff --git a/docs/modules/_services_optionservice_.md b/docs/modules/_services_optionservice_.md index 24232c8..2e88e5a 100644 --- a/docs/modules/_services_optionservice_.md +++ b/docs/modules/_services_optionservice_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["services/optionService"](_services_optionservice_.md) -# External module: "services/optionService" +# Module: "services/optionService" ## Index @@ -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/03dd45f/src/services/optionService.ts#L4)* +*Defined in [services/optionService.ts:4](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/optionService.ts#L4)* **Parameters:** diff --git a/docs/modules/_services_qualityservice_.md b/docs/modules/_services_qualityservice_.md index d6d87da..fc663ab 100644 --- a/docs/modules/_services_qualityservice_.md +++ b/docs/modules/_services_qualityservice_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["services/qualityService"](_services_qualityservice_.md) -# External module: "services/qualityService" +# Module: "services/qualityService" ## Index @@ -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/03dd45f/src/services/qualityService.ts#L5)* +*Defined in [services/qualityService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/qualityService.ts#L5)* **Parameters:** diff --git a/docs/modules/_services_scaleservice_.md b/docs/modules/_services_scaleservice_.md index c6f3114..21022a1 100644 --- a/docs/modules/_services_scaleservice_.md +++ b/docs/modules/_services_scaleservice_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["services/scaleService"](_services_scaleservice_.md) -# External module: "services/scaleService" +# Module: "services/scaleService" ## Index @@ -15,7 +15,7 @@ ▸ **determineScale**(`__namedParameters`: object, `__namedParameters`: object): *number* -*Defined in [services/scaleService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/scaleService.ts#L5)* +*Defined in [services/scaleService.ts:5](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/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/03dd45f/src/services/scaleService.ts#L19)* +*Defined in [services/scaleService.ts:19](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/scaleService.ts#L19)* **Parameters:** diff --git a/docs/modules/_services_windowservice_.md b/docs/modules/_services_windowservice_.md index e0852ac..0a44f22 100644 --- a/docs/modules/_services_windowservice_.md +++ b/docs/modules/_services_windowservice_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["services/windowService"](_services_windowservice_.md) -# External module: "services/windowService" +# Module: "services/windowService" ## Index @@ -14,7 +14,7 @@ ▸ **toByteArray**(`base64`: string): *Uint8Array[]* -*Defined in [services/windowService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/03dd45f/src/services/windowService.ts#L1)* +*Defined in [services/windowService.ts:1](https://github.com/TonyBrobston/jpegasus/blob/dccdfc0/src/services/windowService.ts#L1)* **Parameters:** diff --git a/docs/modules/_types_inputoptions_.md b/docs/modules/_types_inputoptions_.md index 3f8c100..81e92e8 100644 --- a/docs/modules/_types_inputoptions_.md +++ b/docs/modules/_types_inputoptions_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["types/InputOptions"](_types_inputoptions_.md) -# External module: "types/InputOptions" +# Module: "types/InputOptions" ## Index diff --git a/docs/modules/_types_options_.md b/docs/modules/_types_options_.md index 52aef5e..b84e5bc 100644 --- a/docs/modules/_types_options_.md +++ b/docs/modules/_types_options_.md @@ -1,6 +1,6 @@ [jpegasus](../README.md) › ["types/Options"](_types_options_.md) -# External module: "types/Options" +# Module: "types/Options" ## Index diff --git a/docs/modules/_types_sharedoptions_.md b/docs/modules/_types_sharedoptions_.md deleted file mode 100644 index f9e99e5..0000000 --- a/docs/modules/_types_sharedoptions_.md +++ /dev/null @@ -1,9 +0,0 @@ -[jpegasus](../README.md) › ["types/SharedOptions"](_types_sharedoptions_.md) - -# External module: "types/SharedOptions" - -## Index - -### Interfaces - -* [SharedOptions](../interfaces/_types_sharedoptions_.sharedoptions.md) diff --git a/src/types/InputOptions.ts b/src/types/InputOptions.ts index 70880e8..e4e59e0 100644 --- a/src/types/InputOptions.ts +++ b/src/types/InputOptions.ts @@ -1,9 +1,9 @@ -import {SharedOptions} from './SharedOptions'; - -export interface InputOptions extends SharedOptions { - allowCrossOriginResourceSharing?: boolean; - quality?: number; - returnOriginalOnFailure?: boolean; - returnOriginalIfCompressedFileIsLarger?: boolean; - scaleImageBy?: number; +export interface InputOptions { + readonly allowCrossOriginResourceSharing?: boolean; + readonly quality?: number; + readonly returnOriginalOnFailure?: boolean; + readonly returnOriginalIfCompressedFileIsLarger?: boolean; + readonly scaleImageBy?: number; + readonly maxHeight?: number; + readonly maxWidth?: number; } diff --git a/src/types/Options.ts b/src/types/Options.ts index 92b7067..17540b3 100644 --- a/src/types/Options.ts +++ b/src/types/Options.ts @@ -1,6 +1,6 @@ -import {SharedOptions} from './SharedOptions'; +import {InputOptions} from './InputOptions'; -export interface Options extends SharedOptions { +export interface Options extends InputOptions { readonly allowCrossOriginResourceSharing: boolean; readonly quality: number; readonly returnOriginalOnFailure: boolean; diff --git a/src/types/SharedOptions.ts b/src/types/SharedOptions.ts deleted file mode 100644 index 2bba7c0..0000000 --- a/src/types/SharedOptions.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface SharedOptions { - maxHeight?: number; - maxWidth?: number; -}