README.md

@ringpublishing/accelerator-images

@ringpublishing/accelerator-images

Table of contents

Classes

• AcceleratorImage
• AcceleratorImageError
• ImageTransformBuilder
• InternalError
• InvalidParameter
• LegacyImage
• UrlError

Interfaces

• AcceleratorImageParams

Type Aliases

• EncodedParameters
• EncodedTransforms
• HashType
• ImageFormat
• ImageQuality
• LegacyImageParams
• OverlayMode
• OverlayPosition
• Rotation

Type Aliases

EncodedParameters

Ƭ EncodedParameters: Record<number, EncodedParameter>

Defined in

src/ImageTransformBuilder.ts:15

---

EncodedTransforms

Ƭ EncodedTransforms: EncodedParameter[][]

Defined in

src/ImageTransformBuilder.ts:14

---

HashType

Ƭ HashType: "md5" | "sha1"

Available hash types for the hash transformation.

See

https://developer.ringpublishing.com/topics/images/transformations.html#hash))

Defined in

src/ImageTransformBuilder.ts:59

---

ImageFormat

Ƭ ImageFormat: "auto" | "original" | "jpeg" | "png" | "bmp" | "tiff" | "webp" | "avif"

Available image formats.

See

https://developer.ringpublishing.com/topics/images/transformations.html#imageformat))

Defined in

src/ImageTransformBuilder.ts:66

---

ImageQuality

Ƭ ImageQuality: "auto" | "low" | "medium" | "high" | "very-high"

Available quality presets.

See

https://developer.ringpublishing.com/topics/images/transformations.html#imagequality))

Defined in

src/ImageTransformBuilder.ts:72

---

LegacyImageParams

Ƭ LegacyImageParams: Omit<AcceleratorImageParams, "transformationHost">

Defined in

src/LegacyImage.ts:5

---

OverlayMode

Ƭ OverlayMode: "over" | "in" | "out" | "atop" | "xor" | "plus" | "minus" | "add" | "subtract" | "difference" | "divide" | "multiply" | "bumpmap" | "copy" | "copy-red" | "copy-green" | "copy-blue" | "copy-opacity" | "copy-cyan" | "copy-magenta" | "copy-yellow" | "copy-black"

Available values for the mode arg of the Overlay transformation.

See

https://developer.ringpublishing.com/topics/images/transformations.html#overlay))

Defined in

src/ImageTransformBuilder.ts:30

---

OverlayPosition

Ƭ OverlayPosition: "stretch" | "top-left" | "top-center" | "top-right" | "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right"

Available values for the position arg of the Overlay transformation.

See

https://developer.ringpublishing.com/topics/images/transformations.html#overlay

Defined in

src/ImageTransformBuilder.ts:22

---

Rotation

Ƭ Rotation: 1 | 2 | 3

Available values for the rotation transformation.

See

https://developer.ringpublishing.com/topics/images/transformations.html#rotate))

Defined in

src/ImageTransformBuilder.ts:79