Class ParamBuilder

Constructors

constructor

new ParamBuilder(initialModifiers?): ParamBuilder
Parameters
- initialModifiers: Map<keyof ParamBuilder, string> = ...
Returns ParamBuilder
- Defined in param-builder.ts:123

Properties

`Readonly`modifiers

modifiers: Map<keyof ParamBuilder, string>

The currently applied imgproxy modifiers

Methods

adjust

adjust(this, ...options): this
Defines the brightness, contrast, and saturation.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#adjust-idadjust for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: AdjustOptions]
Returns this
Example
```
pb().adjust({
  brightness: 100,  // optional
  contrast: 0.8,    // optional
  saturation: 0.9   // optional
});
```
- Defined in param-builder.ts:224

autoRotate

autoRotate(this): this
Automatically rotates the image based on the EXIF orientation parameter.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#auto-rotate for the imgproxy documentation
Parameters
- this: this
Returns this
Example
```
pb().autoRotate();
```
- Defined in param-builder.ts:239

background

background(this, ...options): this
Fills the image background with the specified color.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#background for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: BackgroundOptions]
Returns this
Example
```
pb().background('ff0000');

pb().background({
  r: 255,
  g: 0,
  b: 0
});
```
- Defined in param-builder.ts:260

backgroundAlpha

backgroundAlpha(this, ...options): this
Adds alpha channel to background.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#background-alpha-idbackground-alpha for the imgproxy documentation
Parameters
- this: this
- Rest...options: [percentage: number]
Returns this
Example
```
pb().backgroundAlpha(0.4);
```
- Defined in param-builder.ts:278

blur

blur(this, ...options): this
Applies a gaussian blur filter to the image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#blur for the imgproxy documentation
Parameters
- this: this
- Rest...options: [sigma: number]
Returns this
Example
```
pb().blur(10);
```
- Defined in param-builder.ts:296

blurDetections

blurDetections(this, ...options): this
Detects objects of the provided classes and blurs them.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#blur-detections-idblur-detections for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: BlurDetectionOptions]
Returns this
Example
```
pb().blurDetections({
  sigma: 10,
  classNames: ['face']
});
```
- Defined in param-builder.ts:314

brightness

brightness(this, ...options): this
Adjusts the brightness of an image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#brightness-idbrightness for the imgproxy documentation
Parameters
- this: this
- Rest...options: [value: number]
Returns this
Example
```
pb().brightness(-100);
```
- Defined in param-builder.ts:332

build

build(options?): string
Builds the imgproxy URL

If a path is supplied, the full URL path will be returned, else only the stringified modifiers will be returned.

If a base URL is supplied, the full imgproxy URL will be returned.
Parameters
- Optionaloptions: BuildOptions
  The build options
Returns string
The imgproxy URL
- Defined in param-builder.ts:167

cacheBuster

cacheBuster(this, ...options): this
Adds a cache buster to the imgproxy params.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#cache-buster for the imgproxy documentation
Parameters
- this: this
- Rest...options: [buster: string]
Returns this
Example
```
pb().cacheBuster("abcdef123");
```
- Defined in param-builder.ts:350

clone

clone(this): ParamBuilder
Creates a new param builder instance with a copy of the current modifiers
Parameters
- this: this
Returns ParamBuilder
A copy of this param builder
- Defined in param-builder.ts:135

contrast

contrast(this, ...options): this
Adjust contrast of the resulting image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#contrast-idcontrast for the imgproxy documentation
Parameters
- this: this
- Rest...options: [percentage: number]
Returns this
Example
```
pb().contrast(0.3);
```
- Defined in param-builder.ts:368

crop

crop(this, ...options): this

Crops the image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#crop for the imgproxy documentation

Parameters

this: this
Rest...options: [options?: CropOptions]

Returns this

Example

pb().crop({
  width: 100,                  // optional
  height: 50,                  // optional
  gravity: {                   // optional
    type: GravityType.CENTER,  // required
    offset: {                  // optional
       x: 20,                  // required
       y: 20                   // required
    }
  }
})

disableAnimation

disableAnimation(this, ...options): this
Use a single frame of animated images.

See https://github.com/imgproxy/imgproxy/blob/cfa4b596d1f31656f9116cc16f2a4ff7d15c2837/docs/generating_the_url.md#disable-animation-iddisable-animation for the imgproxy documentation
Parameters
- this: this
- Rest...options: []
Returns this
Example
```
pb().disableAnimation();
```
- Defined in param-builder.ts:408

dpi

dpi(this, ...options): this
When set, imgproxy will replace the image's DPI metadata with the provided value.

See https://github.com/imgproxy/imgproxy/blob/8629c5eca1e422908363f471513bfc887d778a85/docs/generating_the_url.md#dpi-iddpi for the imgproxy documentation
Parameters
- this: this
- Rest...options: [value: number]
Returns this
Example
```
pb().dpi(300);
```
- Defined in param-builder.ts:426

dpr

dpr(this, ...options): this
Multiplies the dimensions according to the specified factor.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#dpr for the imgproxy documentation
Parameters
- this: this
- Rest...options: [value: number]
Returns this
Example
```
pb().dpr(18);
```
- Defined in param-builder.ts:441

drawDetections

drawDetections(this, ...options): this
Detects objects of the provided classes and draws their bounding boxes.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#draw-detections-iddraw-detections for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: DrawDetectionOptions]
Returns this
Example
```
pb().drawDetections({
  classNames: ["face"]
});
```
- Defined in param-builder.ts:459

duotone

duotone(this, ...options): this
Converts the image to duotone with specified intensity and colors.

See https://github.com/imgproxy/imgproxy-docs/blob/7d15484aea6a1fae5f1dfd1806b5551a4774658d/docs/usage/processing.mdx?plain=1#L429 for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: DuotoneOptions]
Returns this
Example
```
pb().duotone({
  intensity: 1.0,   // required
  color1: 'ff0000', // required
  color2: '00ff00'  // required
});
```
- Defined in param-builder.ts:481

enforceThumbnail

enforceThumbnail(this): this
If the source image has an embedded thumbnail, imgproxy will use the embedded thumbnail instead of the main image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#enforce-thumbnail for the imgproxy documentation
Parameters
- this: this
Returns this
Example
```
pb().enforceThumbnail();
```
- Defined in param-builder.ts:497

enlarge

enlarge(this): this
Enlarges the image if it is smaller than the given size.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#enlarge for the imgproxy documentation
Parameters
- this: this
Returns this
Example
```
pb().enlarge();
```
- Defined in param-builder.ts:512

expires

expires(this, ...options): this
Returns a 404 if the expiration date is reached.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#expires for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: ExpiresOptions]
Returns this
Example
```
pb().expires(new Date());

pb().expires(1661431326);
```
- Defined in param-builder.ts:529

extend

extend(this, ...options): this
Extends the image if it is smaller than the given size.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#extend for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options?: ExtendOptions]
Returns this
Example
```
pb().extend();

pb().extend({
  gravity: {
    type: GravityType.NORTH  // required
    offset: {                // optional
      x: 10;                 // required
      y: 20;                 // required
    }
  }
});
```
- Defined in param-builder.ts:554

extendAspectRatio

extendAspectRatio(this, ...options): this
Extends the image to the requested aspect ratio.

See https://github.com/imgproxy/imgproxy/blob/1a9768a2c682e88820064aa3d9a05ea234ff3cc4/docs/generating_the_url.md#extend-aspect-ratio for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options?: ExtendAspectRatioOptions]
Returns this
Example
```
pb().extendAspectRatio();

pb().extendAspectRatio({
  gravity: {
    type: GravityType.NORTH  // required
    offset: {                // optional
      x: 10;                 // required
      y: 20;                 // required
    }
  }
});
```
- Defined in param-builder.ts:579

fallbackImageUrl

fallbackImageUrl(this, ...options): this
Sets a custom fallback image by specifying its URL.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#fallback-image-url-idfallback-image-url for the imgproxy documentation
Parameters
- this: this
- Rest...options: [url: string]
Returns this
Example
```
pb().fallbackImageUrl('https://example.com');
```
- Defined in param-builder.ts:597

fileName

fileName(this, ...options): this
Sets the filename for the Content-Disposition header.

See https://github.com/imgproxy/imgproxy/blob/41b9ebe9277ef3e664e0a842fbc0e912b2640969/docs/generating_the_url.md#filename for the imgproxy documentation
Parameters
- this: this
- Rest...options: [name: string, base64Encoded: boolean]
Returns this
Example
```
// Not encoded
pb().fileName('filename.png');

// Encoded
pb().fileName('ZmlsZW5hbWUucG5n', true);
```
- Defined in param-builder.ts:619

format

format(this, ...options): this
Specifies the resulting image format.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#format for the imgproxy documentation
Parameters
- this: this
- Rest...options: [imageFormat: FormatOptions]
Returns this
Example
```
pb().format('png');
```
- Defined in param-builder.ts:634

formatQuality

formatQuality(this, ...options): this
Sets the desired quality for each format.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#format-quality for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: FormatQualityOptions]
Returns this
Example
```
pb().formatQuality({
  jpeg: 100,
  png: 50,
  // ...
});
```
- Defined in param-builder.ts:653

gifOptions

gifOptions(this, ...options): this
Allows redefining GIF saving options.
Parameters
- this: this
- Rest...options: [options: GifOptions]
Returns this
Deprecated
Automatically applied since version 3.0.0
Example
```
pb().gifOptions({
  optimizeFrames: true,     // optional
  optimizeTransparency: 50  // optional
});
```
- Defined in param-builder.ts:673

gradient

gradient(this, ...options): this
Places a gradient on the processed image.

See https://github.com/imgproxy/imgproxy/blob/cfa4b596d1f31656f9116cc16f2a4ff7d15c2837/docs/generating_the_url.md#gradient-idgradient for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: GradientOptions]
Returns this
Example
```
pb().gradient({
  opacity: 1,       // required
  color: 'ababab',  // optional
  direction: 'up',  // optional
  start: 0.0,       // optional
  stop: 0.7         // optional
});
```
- Defined in param-builder.ts:697

gravity

gravity(this, ...options): this
Sets the gravity.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#gravity for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: GravityOptions]
Returns this
Example
```
pb().gravity({
  type: GravityType.NORTH  // required
  offset: {                // optional
    x: 10,                 // required
    y: 20                  // required
  }
});
```
- Defined in param-builder.ts:718

hashsum

hashsum(this, ...options): this
When hashsum_type is not none, imgproxy will calculate the hashsum of the source image and compare it with the provided hashsum.

See https://github.com/imgproxy/imgproxy-docs/blob/f9d7908d253ec2b31425b988a48f8c28cb271c58/docs/usage/processing.mdx#L916 for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: HashsumOptions]
Returns this
Example
```
pb().hashsum({
  hashsum: 'ABCDEF',       // required
  type: HashsumType.NONE   // optional
});
```
- Defined in param-builder.ts:737

jpegOptions

jpegOptions(this, ...options): this

Allows redefining JPEG saving options.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#jpeg-options-idjpeg-options for the imgproxy documentation

Parameters

this: this
Rest...options: [options: JpegOptions]

Returns this

Example

pb().jpegOptions({
  progressive: boolean,         // optional
  noSubsample: boolean,         // optional
  trellisQuant: boolean,        // optional
  overshootDeringing: boolean,  // optional
  optimizeScans: boolean,       // optional
  quantizationTable: 7          // optional
});

keepCopyright

keepCopyright(this): this
Preserve the copyright info while stripping metadata.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#keep-copyright for the imgproxy documentation
Parameters
- this: this
Returns this
Example
```
pb().keepCopyright();
```
- Defined in param-builder.ts:777

maxBytes

maxBytes(this, ...options): this
Limits the file size to the specified number of bytes.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#max-bytes for the imgproxy documentation
Parameters
- this: this
- Rest...options: [bytes: number]
Returns this
Example
```
pb().maxBytes(10);
```
- Defined in param-builder.ts:792

minHeight

minHeight(this, ...options): this
Defines the minimum height of the resulting image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#min-height for the imgproxy documentation
Parameters
- this: this
- Rest...options: [height: number]
Returns this
Example
```
pb().minHeight(100);
```
- Defined in param-builder.ts:807

minWidth

minWidth(this, ...options): this
Defines the minimum width of the resulting image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#min-width for the imgproxy documentation
Parameters
- this: this
- Rest...options: [width: number]
Returns this
Example
```
pb().minWidth(100);
```
- Defined in param-builder.ts:822

monochrome

monochrome(this, ...options): this
Converts the image to monochrome.

See https://github.com/imgproxy/imgproxy-docs/blob/7d15484aea6a1fae5f1dfd1806b5551a4774658d/docs/usage/processing.mdx?plain=1#L415 for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: MonochromeOptions]
Returns this
Example
```
pb().monochrome({
  intensity: 0.3,  // required
  color: 'ff0000'  // optional
});
```
- Defined in param-builder.ts:840

pad

pad(this, ...options): this
Applies the specified padding to the image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#padding for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: PaddingOptions]
Returns this
Example
```
pb().pad({
  top: 100,    // optional (Note: sets all other sides if not set explicitly)
  right: 100,  // optional
  bottom: 10,  // optional
  left: 10     // optional
});
```
- Defined in param-builder.ts:863

page

page(this, ...options): this
When source image supports pagination (PDF, TIFF) or animation (GIF, WebP), this option allows specifying the page to use.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#page-idpage for the imgproxy documentation
Parameters
- this: this
- Rest...options: [pg: number]
Returns this
Example
```
pb().page(10);
```
- Defined in param-builder.ts:879

pixelate

pixelate(this, ...options): this
Apply the pixelate filter to the resulting image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#pixelate for the imgproxy documentation
Parameters
- this: this
- Rest...options: [pixelSize: number]
Returns this
Example
```
pb().pixelate(5);
```
- Defined in param-builder.ts:894

pngOptions

pngOptions(this, ...options): this
Allows redefining PNG saving options.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#png-options-idpng-options for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: PngOptions]
Returns this
Example
```
pb().pngOptions({
  interlaced: true,         // optional
  quantize: false,          // optional
  quantization_colors: 10   // optional
});
```
- Defined in param-builder.ts:913

preset

preset(this, ...options): this
Sets one or many presets to be used by the imgproxy.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#preset for the imgproxy documentation
Parameters
- this: this
- Rest...options: [presets: PresetOptions]
Returns this
Example
```
pb().preset('mypreset');

pb().preset(['preset1', 'preset2']);
```
- Defined in param-builder.ts:933

quality

quality(this, ...options): this
Redefines the quality of the resulting image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#quality for the imgproxy documentation
Parameters
- this: this
- Rest...options: [percentage: number]
Returns this
Example
```
pb().quality(80);
```
- Defined in param-builder.ts:996

raw

raw(this, ...options): this
Returns a raw unprocessed and unchecked source image

See https://github.com/imgproxy/imgproxy/blob/f95f57bb4df35c69ae2257958006ef54b1c1d8c7/docs/generating_the_url.md#raw for the imgproxy documentation
Parameters
- this: this
- Rest...options: []
Returns this
Example
```
pb().raw();
```
- Defined in param-builder.ts:948

resize

resize(this, ...options): this
Resizes the image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#resize for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: ResizeOptions]
Returns this
Example
```
pb().resize({
  type: ResizeType.AUTO,  // optional
  width: 100,             // optional
  height: 50              // optional
});
```
- Defined in param-builder.ts:1015

resizingAlgorithm

resizingAlgorithm(this, ...options): this
Defines the algorithm that imgproxy will use for resizing.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#resizing-algorithm-idresizing-algorithm for the imgproxy documentation
Parameters
- this: this
- Rest...options: [algorithm: ResizingAlgorithm]
Returns this
Example
```
pb().resizingAlgorithm(ResizingAlgorithm.NEAREST));
```
- Defined in param-builder.ts:963

returnAttachment

returnAttachment(this): this
Returns attachment in the Content-Disposition header.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#return-attachment for the imgproxy documentation
Parameters
- this: this
Returns this
Example
```
pb().returnAttachment();
```
- Defined in param-builder.ts:981

rotate

rotate(this, ...options): this
Rotates the image by the specified angle.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#rotate for the imgproxy documentation
Parameters
- this: this
- Rest...options: [angle: RotationOptions]
Returns this
Example
```
pb().rotate(90);
```
- Defined in param-builder.ts:1030

saturation

saturation(this, ...options): this
Adjust saturation of the resulting image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#saturation-idsaturation for the imgproxy documentation
Parameters
- this: this
- Rest...options: [percentage: number]
Returns this
Example
```
pb().saturation(0.3);
```
- Defined in param-builder.ts:1045

sharpen

sharpen(this, ...options): this
Applies a sharpen filter to the image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#sharpen for the imgproxy documentation
Parameters
- this: this
- Rest...options: [sigma: number]
Returns this
Example
```
pb().sharpen(3);
```
- Defined in param-builder.ts:1063

skipProcessing

skipProcessing(this, ...options): this
Skip the processing of the listed formats.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#skip-processing for the imgproxy documentation
Parameters
- this: this
- Rest...options: [extensions: SkipProcessingOptions]
Returns this
Example
```
pb().skipProcessing(['png', 'svg']);
```
- Defined in param-builder.ts:1078

stripColorProfile

stripColorProfile(this): this
Strips the color profile from the image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#strip-color-profile for the imgproxy documentation
Parameters
- this: this
Returns this
Example
```
pb().stripColorProfile();
```
- Defined in param-builder.ts:1096

stripMetadata

stripMetadata(this): this
Strips the metadata from the image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#strip-metadata for the imgproxy documentation
Parameters
- this: this
Returns this
Example
```
pb().stripMetadata();
```
- Defined in param-builder.ts:1111

style

style(this, ...options): this
Prepend a <style> node with the provided CSS styles to the <svg> node of a source SVG image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#style-idstyle for the imgproxy documentation
Parameters
- this: this
- Rest...options: [styles: StyleOptions]
Returns this
Example
```
pb().style('fill:red;width:30px;');

pb().style({
  fill: 'red';
  width: '30px'
});
```
- Defined in param-builder.ts:1132

trim

trim(this, ...options): this
Trims the image background.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#trim for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: TrimOptions]
Returns this
Example
```
pb().trim({
  threshold: 10,       // required
  color: 'ffffff',     // optional
  equal: {             // optional
    horizontal: true,  // optional
    vertical: true     // optional
  }
});
```
- Defined in param-builder.ts:1154

unset

unset(this, modifier): this
Removes the specified modifier from the currently applied modifiers
Parameters
- this: this
- modifier: Omit<keyof ParamBuilder,
      | "modifiers"
      | "clone"
      | "unset"
      | "build">
  The modifier
Returns this
- Defined in param-builder.ts:145

unsharpen

unsharpen(this, ...options): this
Allows redefining unsharpening options.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#unsharpening-idunsharpening for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: UnsharpeningOptions]
Returns this
Example
```
pb().unsharpen({
  mode: UnsharpeningMode.AUTO,   // optional
  weight: 11,                    // optional
  dividor: 24                    // optional
});
```
- Defined in param-builder.ts:1173

videoThumbnailKeyframes

videoThumbnailKeyframes(this, ...options): this
Specifies whether the latest keyframe before the video thumbnail second should be used for thumbnail generation

See https://github.com/imgproxy/imgproxy-docs/blob/676c6d4b1f5d9fee79abfecf130fc7dda3f9124e/versioned_docs/version-3.24.x/usage/processing.mdx#video-thumbnail-keyframes-pro-video-thumbnail-keyframes for the imgproxy documentation
Parameters
- this: this
- Rest...options: [keyframes: boolean]
Returns this
Example
```
pb().videoThumbnailKeyframes(true);
```
- Defined in param-builder.ts:1189

videoThumbnailSecond

videoThumbnailSecond(this, ...options): this
Redefines the second used for the thumbnail.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#video-thumbnail-second-idvideo-thumbnail-second for the imgproxy documentation
Parameters
- this: this
- Rest...options: [second: number]
Returns this
Example
```
pb().videoThumbnailSecond(3);
```
- Defined in param-builder.ts:1210

videoThumbnailTile

videoThumbnailTile(this, ...options): this

Generates a tiled sprite using the source video frames

See https://github.com/imgproxy/imgproxy-docs/blob/676c6d4b1f5d9fee79abfecf130fc7dda3f9124e/versioned_docs/version-3.24.x/usage/processing.mdx#video-thumbnail-tile-pro-video-thumbnail-tile for the imgproxy documentation

Parameters

this: this
Rest...options: [options: VideoThumbnailTileOptions]

Returns this

Example

pb().videoThumbnailTile({
  step: 1,           // required
  columns: 1,        // required
  rows: 1,           // required
  tileWidth: 50,     // required
  tileHeight: 50,    // required
  extendTile: true,  // optional
  trim: true,        // optional
  fill: true,        // optional
  focusX: 10.3,      // optional
  focusY: 10.3,      // optional
});

watermark

watermark(this, ...options): this

Places a watermark on the processed image.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#watermark for the imgproxy documentation

Parameters

this: this
Rest...options: [options: WatermarkOptions]

Returns this

Example

pb().watermark({
  opacity: 0.8,                          // required
  position: WatermarkPosition.REPLICATE  // optional
  scale: 2                               // optional
});

pb().watermark({
  opacity: 1.0,
  scale: 1,
  position: WatermarkPosition.WEST  // optional
  offset: {                         // optional
    x: 10,                          // optional
    y: 10                           // optional
  }
})

watermarkShadow

watermarkShadow(this, ...options): this
Adds a shadow to the watermark.

See https://github.com/imgproxy/imgproxy/blob/f95f57bb4df35c69ae2257958006ef54b1c1d8c7/docs/generating_the_url.md#watermark-shadow-idwatermark-shadow for the imgproxy documentation
Parameters
- this: this
- Rest...options: [sigma: number]
Returns this
Example
```
pb().watermarkShadow(10);
```
- Defined in param-builder.ts:1289

watermarkSize

watermarkSize(this, ...options): this
Defines the desired width and height of the watermark. imgproxy always uses fit resizing type when resizing watermarks and enlarges them when needed.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#watermark-size-idwatermark-size for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: WatermarkSizeOptions]
Returns this
Example
```
pb().watermarkSize({
  width: 30,  // required
  height: 30  // required
});
```
- Defined in param-builder.ts:1312

watermarkText

watermarkText(this, ...options): this
Generate an image from the provided text and use it as a watermark.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#watermark-text-idwatermark-text for the imgproxy documentation
Parameters
- this: this
- Rest...options: [text: string]
Returns this
Example
```
pb().watermarkText("my watermark");
```
- Defined in param-builder.ts:1330

watermarkUrl

watermarkUrl(this, ...options): this
Use the image from the specified URL as a watermark.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#watermark-url-idwatermark-url for the imgproxy documentation
Parameters
- this: this
- Rest...options: [url: string]
Returns this
Example
```
pb().watermarkUrl('https://example.com');
```
- Defined in param-builder.ts:1348

zoom

zoom(this, ...options): this
Multiply the image dimensions according to the specified factors.

See https://github.com/imgproxy/imgproxy/blob/6f292443eafb2e39f9252175b61faa6b38105a7c/docs/generating_the_url.md#zoom for the imgproxy documentation
Parameters
- this: this
- Rest...options: [options: ZoomOptions]
Returns this
Example
```
pb().zoom(3);
```
- Defined in param-builder.ts:1366

Class ParamBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ParamBuilder

Properties

Readonlymodifiers

Methods

adjust

Parameters

Returns this

Example

autoRotate

Parameters

Returns this

Example

background

Parameters

Returns this

Example

backgroundAlpha

Parameters

Returns this

Example

blur

Parameters

Returns this

Example

blurDetections

Parameters

Returns this

Example

brightness

Parameters

Returns this

Example

build

Parameters

Returns string

cacheBuster

Parameters

Returns this

Example

clone

Parameters

Returns ParamBuilder

contrast

Parameters

Returns this

Example

crop

Parameters

Returns this

Example

disableAnimation

Parameters

Returns this

Example

dpi

Parameters

Returns this

Example

dpr

Parameters

Returns this

Example

drawDetections

Parameters

Returns this

Example

duotone

Parameters

Returns this

Example

enforceThumbnail

Parameters

`Readonly`modifiers