chore: upgrade typedoc (#766)

docs/README.md

@@ -1,4 +1,4 @@
-imagetools / [Modules](modules.md)
+**imagetools** • [**Docs**](modules.md)
 
 # Imagetools documentation
 
@@ -17,4 +17,4 @@ unclear!
 
 - [Extend Imagetools](guide/extending.md)
 - [Sharp's documentation](https://sharp.pixelplumbing.com)
-- [Caching](guide/caching.md)
+- [Caching](guide/caching.md)

docs/core/src/README.md

@@ -0,0 +1,96 @@
+[**imagetools**](../../README.md) • **Docs**
+
+***
+
+[imagetools](../../modules.md) / core/src
+
+# core/src
+
+## Index
+
+### Interfaces
+
+- [BackgroundOptions](interfaces/BackgroundOptions.md)
+- [BlurOptions](interfaces/BlurOptions.md)
+- [EffortOptions](interfaces/EffortOptions.md)
+- [FitOptions](interfaces/FitOptions.md)
+- [FlattenOptions](interfaces/FlattenOptions.md)
+- [FlipOptions](interfaces/FlipOptions.md)
+- [FlopOptions](interfaces/FlopOptions.md)
+- [FormatOptions](interfaces/FormatOptions.md)
+- [GrayscaleOptions](interfaces/GrayscaleOptions.md)
+- [HSBOptions](interfaces/HSBOptions.md)
+- [ImageMetadata](interfaces/ImageMetadata.md)
+- [Img](interfaces/Img.md)
+- [InvertOptions](interfaces/InvertOptions.md)
+- [KernelOptions](interfaces/KernelOptions.md)
+- [Logger](interfaces/Logger.md)
+- [LosslessOptions](interfaces/LosslessOptions.md)
+- [MedianOptions](interfaces/MedianOptions.md)
+- [NormalizeOptions](interfaces/NormalizeOptions.md)
+- [Picture](interfaces/Picture.md)
+- [PositionOptions](interfaces/PositionOptions.md)
+- [ProcessedImageMetadata](interfaces/ProcessedImageMetadata.md)
+- [ProgressiveOptions](interfaces/ProgressiveOptions.md)
+- [QualityOptions](interfaces/QualityOptions.md)
+- [ResizeOptions](interfaces/ResizeOptions.md)
+- [RotateOptions](interfaces/RotateOptions.md)
+- [TintOptions](interfaces/TintOptions.md)
+- [TransformFactoryContext](interfaces/TransformFactoryContext.md)
+- [TransformResult](interfaces/TransformResult.md)
+
+### Type Aliases
+
+- [FitValue](type-aliases/FitValue.md)
+- [ImageConfig](type-aliases/ImageConfig.md)
+- [ImageTransformation](type-aliases/ImageTransformation.md)
+- [KernelValue](type-aliases/KernelValue.md)
+- [OutputFormat](type-aliases/OutputFormat.md)
+- [PositionValue](type-aliases/PositionValue.md)
+- [TransformFactory](type-aliases/TransformFactory.md)
+- [TransformOption](type-aliases/TransformOption.md)
+
+### Variables
+
+- [builtinOutputFormats](variables/builtinOutputFormats.md)
+- [builtins](variables/builtins.md)
+- [fitValues](variables/fitValues.md)
+- [kernelValues](variables/kernelValues.md)
+- [positionShorthands](variables/positionShorthands.md)
+- [positionValues](variables/positionValues.md)
+
+### Functions
+
+- [applyTransforms](functions/applyTransforms.md)
+- [blur](functions/blur.md)
+- [extractEntries](functions/extractEntries.md)
+- [flatten](functions/flatten.md)
+- [flip](functions/flip.md)
+- [flop](functions/flop.md)
+- [format](functions/format.md)
+- [generateTransforms](functions/generateTransforms.md)
+- [getBackground](functions/getBackground.md)
+- [getEffort](functions/getEffort.md)
+- [getFit](functions/getFit.md)
+- [getKernel](functions/getKernel.md)
+- [getLossless](functions/getLossless.md)
+- [getMetadata](functions/getMetadata.md)
+- [getPosition](functions/getPosition.md)
+- [getProgressive](functions/getProgressive.md)
+- [getQuality](functions/getQuality.md)
+- [grayscale](functions/grayscale.md)
+- [hsb](functions/hsb.md)
+- [imgFormat](functions/imgFormat.md)
+- [invert](functions/invert.md)
+- [median](functions/median.md)
+- [metadataFormat](functions/metadataFormat.md)
+- [normalize](functions/normalize.md)
+- [parseURL](functions/parseURL.md)
+- [pictureFormat](functions/pictureFormat.md)
+- [resize](functions/resize.md)
+- [resolveConfigs](functions/resolveConfigs.md)
+- [rotate](functions/rotate.md)
+- [setMetadata](functions/setMetadata.md)
+- [srcsetFormat](functions/srcsetFormat.md)
+- [tint](functions/tint.md)
+- [urlFormat](functions/urlFormat.md)

docs/core/src/functions/applyTransforms.md

@@ -0,0 +1,25 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / applyTransforms
+
+# Function: applyTransforms()
+
+> **applyTransforms**(`transforms`, `image`, `removeMetadata`): `Promise`\<[`TransformResult`](../interfaces/TransformResult.md)\>
+
+## Parameters
+
+• **transforms**: [`ImageTransformation`](../type-aliases/ImageTransformation.md)[]
+
+• **image**: `Sharp`
+
+• **removeMetadata**: `boolean` = `true`
+
+## Returns
+
+`Promise`\<[`TransformResult`](../interfaces/TransformResult.md)\>
+
+## Defined in
+
+[packages/core/src/lib/apply-transforms.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/lib/apply-transforms.ts#L5)

docs/core/src/functions/blur.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / blur
+
+# Function: blur()
+
+> **blur**(`metadata`, `ctx`): `undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`BlurOptions`](../interfaces/BlurOptions.md)\>
+
+• **ctx**: [`TransformFactoryContext`](../interfaces/TransformFactoryContext.md)
+
+## Returns
+
+`undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Defined in
+
+[packages/core/src/transforms/blur.ts:8](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/blur.ts#L8)

docs/core/src/functions/extractEntries.md

@@ -0,0 +1,21 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / extractEntries
+
+# Function: extractEntries()
+
+> **extractEntries**(`searchParams`): [`string`, `string`[]][]
+
+## Parameters
+
+• **searchParams**: `URLSearchParams`
+
+## Returns
+
+[`string`, `string`[]][]
+
+## Defined in
+
+[packages/core/src/lib/parse-url.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/lib/parse-url.ts#L5)

docs/core/src/functions/flatten.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / flatten
+
+# Function: flatten()
+
+> **flatten**(`metadata`, `ctx`): `undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`FlattenOptions`](../interfaces/FlattenOptions.md)\>
+
+• **ctx**: [`TransformFactoryContext`](../interfaces/TransformFactoryContext.md)
+
+## Returns
+
+`undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Defined in
+
+[packages/core/src/transforms/flatten.ts:9](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/flatten.ts#L9)

docs/core/src/functions/flip.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / flip
+
+# Function: flip()
+
+> **flip**(`metadata`, `ctx`): `undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`FlipOptions`](../interfaces/FlipOptions.md)\>
+
+• **ctx**: [`TransformFactoryContext`](../interfaces/TransformFactoryContext.md)
+
+## Returns
+
+`undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Defined in
+
+[packages/core/src/transforms/flip.ts:8](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/flip.ts#L8)

docs/core/src/functions/flop.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / flop
+
+# Function: flop()
+
+> **flop**(`metadata`, `ctx`): `undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`FlopOptions`](../interfaces/FlopOptions.md)\>
+
+• **ctx**: [`TransformFactoryContext`](../interfaces/TransformFactoryContext.md)
+
+## Returns
+
+`undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Defined in
+
+[packages/core/src/transforms/flop.ts:8](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/flop.ts#L8)

docs/core/src/functions/format.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / format
+
+# Function: format()
+
+> **format**(`metadata`, `ctx`): `undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`FormatOptions`](../interfaces/FormatOptions.md)\>
+
+• **ctx**: [`TransformFactoryContext`](../interfaces/TransformFactoryContext.md)
+
+## Returns
+
+`undefined` \| [`ImageTransformation`](../type-aliases/ImageTransformation.md)
+
+## Defined in
+
+[packages/core/src/transforms/format.ts:13](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/format.ts#L13)

docs/core/src/functions/generateTransforms.md

@@ -0,0 +1,35 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / generateTransforms
+
+# Function: generateTransforms()
+
+> **generateTransforms**(`config`, `factories`, `manualSearchParams`, `logger`?): `object`
+
+## Parameters
+
+• **config**: [`ImageConfig`](../type-aliases/ImageConfig.md)
+
+• **factories**: [`TransformFactory`](../type-aliases/TransformFactory.md)[]
+
+• **manualSearchParams**: `URLSearchParams`
+
+• **logger?**: [`Logger`](../interfaces/Logger.md)
+
+## Returns
+
+`object`
+
+### parametersUsed
+
+> **parametersUsed**: `Set`\<`string`\>
+
+### transforms
+
+> **transforms**: [`ImageTransformation`](../type-aliases/ImageTransformation.md)[]
+
+## Defined in
+
+[packages/core/src/lib/generate-transforms.ts:4](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/lib/generate-transforms.ts#L4)

docs/core/src/functions/getBackground.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / getBackground
+
+# Function: getBackground()
+
+> **getBackground**(`metadata`, `image`): `undefined` \| `string`
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`BackgroundOptions`](../interfaces/BackgroundOptions.md)\>
+
+• **image**: `Sharp`
+
+## Returns
+
+`undefined` \| `string`
+
+## Defined in
+
+[packages/core/src/transforms/background.ts:8](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/background.ts#L8)

docs/core/src/functions/getEffort.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / getEffort
+
+# Function: getEffort()
+
+> **getEffort**(`metadata`, `image`): `undefined` \| `number`
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`EffortOptions`](../interfaces/EffortOptions.md)\>
+
+• **image**: `Sharp`
+
+## Returns
+
+`undefined` \| `number`
+
+## Defined in
+
+[packages/core/src/transforms/effort.ts:26](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/effort.ts#L26)

docs/core/src/functions/getFit.md

@@ -0,0 +1,23 @@
+[**imagetools**](../../../README.md) • **Docs**
+
+***
+
+[imagetools](../../../modules.md) / [core/src](../README.md) / getFit
+
+# Function: getFit()
+
+> **getFit**(`metadata`, `image`): `undefined` \| `"cover"` \| `"contain"` \| `"fill"` \| `"inside"` \| `"outside"`
+
+## Parameters
+
+• **metadata**: `Partial`\<[`ImageConfig`](../type-aliases/ImageConfig.md) & [`FitOptions`](../interfaces/FitOptions.md)\>
+
+• **image**: `Sharp`
+
+## Returns
+
+`undefined` \| `"cover"` \| `"contain"` \| `"fill"` \| `"inside"` \| `"outside"`
+
+## Defined in
+
+[packages/core/src/transforms/fit.ts:12](https://github.com/JonasKruckenberg/imagetools/blob/b6421598cd4879d5c28755c1d558f8b5955cc5a1/packages/core/src/transforms/fit.ts#L12)