chore: regenerated docs

JonasKruckenberg · Jan 20, 2023 · 473f3a8 · 473f3a8
1 parent 6842c73
commit 473f3a8
Show file tree

Hide file tree

Showing 36 changed files with 391 additions and 217 deletions.
diff --git a/docs/interfaces/core_src.BackgroundOptions.md b/docs/interfaces/core_src.BackgroundOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/background.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/background.ts#L5)
+[core/src/transforms/background.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/background.ts#L5)
diff --git a/docs/interfaces/core_src.BlurOptions.md b/docs/interfaces/core_src.BlurOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/blur.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/blur.ts#L5)
+[core/src/transforms/blur.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/blur.ts#L5)
diff --git a/docs/interfaces/core_src.FitOptions.md b/docs/interfaces/core_src.FitOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/fit.ts:9](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/fit.ts#L9)
+[core/src/transforms/fit.ts:9](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/fit.ts#L9)
diff --git a/docs/interfaces/core_src.FlattenOptions.md b/docs/interfaces/core_src.FlattenOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/flatten.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/flatten.ts#L6)
+[core/src/transforms/flatten.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/flatten.ts#L6)
diff --git a/docs/interfaces/core_src.FlipOptions.md b/docs/interfaces/core_src.FlipOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/flip.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/flip.ts#L5)
+[core/src/transforms/flip.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/flip.ts#L5)
diff --git a/docs/interfaces/core_src.FlopOptions.md b/docs/interfaces/core_src.FlopOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/flop.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/flop.ts#L5)
+[core/src/transforms/flop.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/flop.ts#L5)
diff --git a/docs/interfaces/core_src.FormatOptions.md b/docs/interfaces/core_src.FormatOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/format.ts:11](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/format.ts#L11)
+[core/src/transforms/format.ts:12](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/format.ts#L12)
diff --git a/docs/interfaces/core_src.GrayscaleOptions.md b/docs/interfaces/core_src.GrayscaleOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/grayscale.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/grayscale.ts#L5)
+[core/src/transforms/grayscale.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/grayscale.ts#L5)
diff --git a/docs/interfaces/core_src.HSBOptions.md b/docs/interfaces/core_src.HSBOptions.md
@@ -20,7 +20,7 @@
 
 #### Defined in
 
-[core/src/transforms/hsb.ts:7](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/hsb.ts#L7)
+[core/src/transforms/hsb.ts:7](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/hsb.ts#L7)
 
 ___
 
@@ -30,7 +30,7 @@ ___
 
 #### Defined in
 
-[core/src/transforms/hsb.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/hsb.ts#L5)
+[core/src/transforms/hsb.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/hsb.ts#L5)
 
 ___
 
@@ -40,4 +40,4 @@ ___
 
 #### Defined in
 
-[core/src/transforms/hsb.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/hsb.ts#L6)
+[core/src/transforms/hsb.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/hsb.ts#L6)
diff --git a/docs/interfaces/core_src.InvertOptions.md b/docs/interfaces/core_src.InvertOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/invert.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/invert.ts#L5)
+[core/src/transforms/invert.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/invert.ts#L5)
diff --git a/docs/interfaces/core_src.KernelOptions.md b/docs/interfaces/core_src.KernelOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/kernel.ts:9](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/kernel.ts#L9)
+[core/src/transforms/kernel.ts:9](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/kernel.ts#L9)
diff --git a/docs/interfaces/core_src.Logger.md b/docs/interfaces/core_src.Logger.md
@@ -0,0 +1,85 @@
+[imagetools](../README.md) / [Modules](../modules.md) / [core/src](../modules/core_src.md) / Logger
+
+# Interface: Logger
+
+[core/src](../modules/core_src.md).Logger
+
+## Table of contents
+
+### Properties
+
+- [error](core_src.Logger.md#error)
+- [info](core_src.Logger.md#info)
+- [warn](core_src.Logger.md#warn)
+
+## Properties
+
+### error
+
+• **error**: (`msg`: `string`) => `void`
+
+#### Type declaration
+
+▸ (`msg`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `msg` | `string` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[core/src/types.ts:8](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L8)
+
+___
+
+### info
+
+• **info**: (`msg`: `string`) => `void`
+
+#### Type declaration
+
+▸ (`msg`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `msg` | `string` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[core/src/types.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L6)
+
+___
+
+### warn
+
+• **warn**: (`msg`: `string`) => `void`
+
+#### Type declaration
+
+▸ (`msg`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `msg` | `string` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[core/src/types.ts:7](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L7)
diff --git a/docs/interfaces/core_src.MedianOptions.md b/docs/interfaces/core_src.MedianOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/median.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/median.ts#L5)
+[core/src/transforms/median.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/median.ts#L5)
diff --git a/docs/interfaces/core_src.NormalizeOptions.md b/docs/interfaces/core_src.NormalizeOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/normalize.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/normalize.ts#L5)
+[core/src/transforms/normalize.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/normalize.ts#L5)
diff --git a/docs/interfaces/core_src.Picture.md b/docs/interfaces/core_src.Picture.md
@@ -29,7 +29,7 @@ The picture output format.
 
 #### Defined in
 
-[core/src/types.ts:44](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/types.ts#L44)
+[core/src/types.ts:53](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L53)
 
 ___
 
@@ -39,4 +39,4 @@ ___
 
 #### Defined in
 
-[core/src/types.ts:43](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/types.ts#L43)
+[core/src/types.ts:52](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L52)
diff --git a/docs/interfaces/core_src.PositionOptions.md b/docs/interfaces/core_src.PositionOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/position.ts:41](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/position.ts#L41)
+[core/src/transforms/position.ts:41](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/position.ts#L41)
diff --git a/docs/interfaces/core_src.ProgressiveOptions.md b/docs/interfaces/core_src.ProgressiveOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/progressive.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/progressive.ts#L5)
+[core/src/transforms/progressive.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/progressive.ts#L5)
diff --git a/docs/interfaces/core_src.QualityOptions.md b/docs/interfaces/core_src.QualityOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/quality.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/quality.ts#L5)
+[core/src/transforms/quality.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/quality.ts#L5)
diff --git a/docs/interfaces/core_src.ResizeOptions.md b/docs/interfaces/core_src.ResizeOptions.md
@@ -14,8 +14,8 @@
 - [height](core_src.ResizeOptions.md#height)
 - [w](core_src.ResizeOptions.md#w)
 - [width](core_src.ResizeOptions.md#width)
-- [withoutEnlargement](core_src.ResizeOptions.md#withoutEnlargement)
-- [withoutReduction](core_src.ResizeOptions.md#withoutReduction)
+- [withoutEnlargement](core_src.ResizeOptions.md#withoutenlargement)
+- [withoutReduction](core_src.ResizeOptions.md#withoutreduction)
 
 ## Properties
 
@@ -25,7 +25,7 @@
 
 #### Defined in
 
-[core/src/transforms/resize.ts:14](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/resize.ts#L14)
+[core/src/transforms/resize.ts:14](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L14)
 
 ___
 
@@ -35,7 +35,7 @@ ___
 
 #### Defined in
 
-[core/src/transforms/resize.ts:13](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/resize.ts#L13)
+[core/src/transforms/resize.ts:13](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L13)
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-[core/src/transforms/resize.ts:12](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/resize.ts#L12)
+[core/src/transforms/resize.ts:12](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L12)
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-[core/src/transforms/resize.ts:11](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/resize.ts#L11)
+[core/src/transforms/resize.ts:11](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L11)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[core/src/transforms/resize.ts:10](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/resize.ts#L10)
+[core/src/transforms/resize.ts:10](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L10)
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-[core/src/transforms/resize.ts:9](https://github.com/JonasKruckenberg/imagetools/blob/a033017/packages/core/src/transforms/resize.ts#L9)
+[core/src/transforms/resize.ts:9](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L9)
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-[core/src/transforms/resize.ts:15](https://github.com/JonasKruckenberg/imagetools/blob/a033017/packages/core/src/transforms/resize.ts#L15)
+[core/src/transforms/resize.ts:15](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L15)
 
 ___
 
@@ -95,4 +95,4 @@ ___
 
 #### Defined in
 
-[core/src/transforms/resize.ts:16](https://github.com/JonasKruckenberg/imagetools/blob/a033017/packages/core/src/transforms/resize.ts#L16)
+[core/src/transforms/resize.ts:16](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/resize.ts#L16)
diff --git a/docs/interfaces/core_src.RotateOptions.md b/docs/interfaces/core_src.RotateOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/rotate.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/rotate.ts#L6)
+[core/src/transforms/rotate.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/rotate.ts#L6)
diff --git a/docs/interfaces/core_src.Source.md b/docs/interfaces/core_src.Source.md
@@ -23,7 +23,7 @@ choose between width descriptor, pixel density descriptor, or no descriptor.
 
 #### Defined in
 
-[core/src/types.ts:35](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/types.ts#L35)
+[core/src/types.ts:44](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L44)
 
 ___
 
@@ -33,4 +33,4 @@ ___
 
 #### Defined in
 
-[core/src/types.ts:36](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/types.ts#L36)
+[core/src/types.ts:45](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L45)
diff --git a/docs/interfaces/core_src.TintOptions.md b/docs/interfaces/core_src.TintOptions.md
@@ -18,4 +18,4 @@
 
 #### Defined in
 
-[core/src/transforms/tint.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/transforms/tint.ts#L5)
+[core/src/transforms/tint.ts:5](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/transforms/tint.ts#L5)
diff --git a/docs/interfaces/core_src.TransformFactoryContext.md b/docs/interfaces/core_src.TransformFactoryContext.md
@@ -8,53 +8,39 @@
 
 ### Properties
 
+- [logger](core_src.TransformFactoryContext.md#logger)
 - [useParam](core_src.TransformFactoryContext.md#useparam)
-- [warn](core_src.TransformFactoryContext.md#warn)
 
 ## Properties
 
-### useParam
-
-• **useParam**: (`parameter`: `string`) => `void`
-
-#### Type declaration
-
-▸ (`parameter`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `parameter` | `string` |
-
-##### Returns
+### logger
 
-`void`
+• **logger**: [`Logger`](core_src.Logger.md)
 
 #### Defined in
 
-[core/src/types.ts:6](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/types.ts#L6)
+[core/src/types.ts:13](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L13)
 
 ___
 
-### warn
+### useParam
 
-• **warn**: (`message`: `string`) => `void`
+• **useParam**: (`parameter`: `string`) => `void`
 
 #### Type declaration
 
-▸ (`message`): `void`
+▸ (`parameter`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `message` | `string` |
+| `parameter` | `string` |
 
 ##### Returns
 
 `void`
 
 #### Defined in
 
-[core/src/types.ts:7](https://github.com/JonasKruckenberg/imagetools/blob/04cb552/packages/core/src/types.ts#L7)
+[core/src/types.ts:12](https://github.com/JonasKruckenberg/imagetools/blob/6842c73/packages/core/src/types.ts#L12)