imgix-url-builder 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2602 @@
1
+ declare type Ratio = `${number}:${number}`;
2
+ declare type ColorKeyword = "aliceblue" | "antiquewhite" | "aqua" | "aquamarine" | "azure" | "beige" | "bisque" | "black" | "blanchedalmond" | "blue" | "blueviolet" | "brown" | "burlywood" | "cadetblue" | "chartreuse" | "chocolate" | "coral" | "cornflowerblue" | "cornsilk" | "crimson" | "cyan" | "darkblue" | "darkcyan" | "darkgoldenrod" | "darkgray" | "darkgreen" | "darkgrey" | "darkkhaki" | "darkmagenta" | "darkolivegreen" | "darkorange" | "darkorchid" | "darkred" | "darksalmon" | "darkseagreen" | "darkslateblue" | "darkslategray" | "darkslategrey" | "darkturquoise" | "darkviolet" | "deeppink" | "deepskyblue" | "dimgray" | "dimgrey" | "dodgerblue" | "firebrick" | "floralwhite" | "forestgreen" | "fuchsia" | "gainsboro" | "ghostwhite" | "gold" | "goldenrod" | "gray" | "green" | "greenyellow" | "grey" | "honeydew" | "hotpink" | "imgixorange" | "imgixblue" | "indianred" | "indigo" | "ivory" | "khaki" | "lavender" | "lavenderblush" | "lawngreen" | "lemonchiffon" | "lightblue" | "lightcoral" | "lightcyan" | "lightgoldenrodyellow" | "lightgray" | "lightgreen" | "lightgrey" | "lightpink" | "lightsalmon" | "lightseagreen" | "lightskyblue" | "lightslategray" | "lightslategrey" | "lightsteelblue" | "lightyellow" | "lime" | "limegreen" | "linen" | "magenta" | "maroon" | "mediumaquamarine" | "mediumblue" | "mediumorchid" | "mediumpurple" | "mediumseagreen" | "mediumslateblue" | "mediumspringgreen" | "mediumturquoise" | "mediumvioletred" | "midnightblue" | "mintcream" | "mistyrose" | "moccasin" | "navajowhite" | "navy" | "oldlace" | "olive" | "olivedrab" | "orange" | "orangered" | "orchid" | "palegoldenrod" | "palegreen" | "paleturquoise" | "palevioletred" | "papayawhip" | "peachpuff" | "peru" | "pink" | "plum" | "powderblue" | "purple" | "rebeccapurple" | "red" | "rosybrown" | "royalblue" | "saddlebrown" | "salmon" | "sandybrown" | "seagreen" | "seashell" | "sienna" | "silver" | "skyblue" | "slateblue" | "slategray" | "slategrey" | "snow" | "springgreen" | "steelblue" | "tan" | "teal" | "thistle" | "tomato" | "turquoise" | "violet" | "wheat" | "white" | "whitesmoke" | "yellow" | "yellowgreen";
3
+ declare type Font = "serif" | "sans-serif" | "monospace" | "cursive" | "fantasy" | "serif,bold" | "sans-serif,bold" | "monospace,bold" | "fantasy,bold" | "serif,italic" | "sans-serif,italic" | "monospace,italic" | "serif,bold,italic" | "sans-serif,bold,italic" | "monospace,bold,italic" | "American Typewriter" | "American Typewriter Condensed" | "American Typewriter Condensed Light" | "American Typewriter Condensed,Bold" | "American Typewriter Light" | "American Typewriter,Bold" | "AndaleMono" | "Arial Narrow" | "Arial Narrow,Bold" | "Arial Narrow,BoldItalic" | "Arial Narrow,Italic" | "Arial Rounded MT,Bold" | "Arial UnicodeMS" | "Arial,BoldItalicMT" | "Arial,BoldMT" | "Arial,ItalicMT" | "Arial-Black" | "ArialMT" | "Athelas,Bold" | "Athelas,BoldItalic" | "Athelas,Italic" | "Athelas-Regular" | "Avenir Next Condensed Demi,Bold" | "Avenir Next Condensed Demi,BoldItalic" | "Avenir Next Condensed Heavy" | "Avenir Next Condensed Heavy,Italic" | "Avenir Next Condensed Medium" | "Avenir Next Condensed Medium,Italic" | "Avenir Next Condensed Regular" | "Avenir Next Condensed Ultra Light" | "Avenir Next Condensed Ultra Light,Italic" | "Avenir Next Condensed,Bold" | "Avenir Next Condensed,BoldItalic" | "Avenir Next Condensed,Italic" | "Avenir Next Demi,Bold" | "Avenir Next Demi,BoldItalic" | "Avenir Next Heavy" | "Avenir Next Heavy,Italic" | "Avenir Next Medium" | "Avenir Next Medium,Italic" | "Avenir Next Regular" | "Avenir Next Ultra Light" | "Avenir Next Ultra Light,Italic" | "Avenir Next,Bold" | "Avenir Next,BoldItalic" | "Avenir Next,Italic" | "Avenir-Black" | "Avenir-BlackOblique" | "Avenir-Book" | "Avenir-BookOblique" | "Avenir-Heavy" | "Avenir-HeavyOblique" | "Avenir-Light" | "Avenir-LightOblique" | "Avenir-Medium" | "Avenir-MediumOblique" | "Avenir-Oblique" | "Avenir-Roman" | "Baskerville" | "Baskerville,Bold" | "Baskerville,BoldItalic" | "Baskerville,Italic" | "BigCaslon-Medium" | "BrushScriptMT" | "Chalkboard" | "Chalkboard SE Light" | "Chalkboard SE Regular" | "Chalkboard SE,Bold" | "Chalkboard,Bold" | "Chalkduster" | "CharcoalCY" | "Charter Black,Italic" | "Charter,Bold" | "Charter,BoldItalic" | "Charter,Italic" | "Charter-Black" | "Charter-Roman" | "Cochin" | "Cochin,Bold" | "Cochin,BoldItalic" | "Cochin,Italic" | "Comic Sans MS,Bold" | "ComicSansMS" | "Copperplate" | "Copperplate,Bold" | "Copperplate-Light" | "Courier" | "Courier New,Bold" | "Courier New,BoldItalic" | "Courier New,Italic" | "Courier,Bold" | "Courier-Oblique" | "CourierNewPSMT" | "DIN Alternate,Bold" | "DIN Condensed,Bold" | "Didot" | "Didot,Bold" | "Didot,Italic" | "Futura Medium,Italic" | "Futura-CondensedMedium" | "Futura-Medium" | "Geneva" | "GenevaCyr" | "Georgia" | "Georgia,Bold" | "Georgia,BoldItalic" | "Georgia,Italic" | "Gill Sans" | "Gill Sans Light,Italic" | "Gill Sans,Bold" | "Gill Sans,BoldItalic" | "Gill Sans,UltraBold" | "GillSans,Italic" | "GillSans-Light" | "Helvetica" | "Helvetica CY,Bold" | "Helvetica Neue" | "Helvetica Neue Condensed Black" | "Helvetica Neue Condensed,Bold" | "Helvetica Neue Light" | "Helvetica Neue Light,Italic" | "Helvetica Neue Medium" | "Helvetica Neue Medium,Italic" | "Helvetica Neue Thin" | "Helvetica Neue Thin,Italic" | "Helvetica Neue UltraLight" | "Helvetica Neue UltraLight,Italic" | "Helvetica Neue,Bold" | "Helvetica Neue,BoldItalic" | "Helvetica Neue,Italic" | "Helvetica,Bold" | "Helvetica-Light" | "Helvetica-LightOblique" | "Helvetica-Oblique" | "HelveticaCY-Oblique" | "HelveticaCY-Plain" | "Herculanum" | "Hoefler Text Black,Italic" | "Hoefler Text,Italic" | "HoeflerText-Black" | "HoeflerText-Ornaments" | "HoeflerText-Regular" | "Impact" | "Iowan Old Style Black,Italic" | "Iowan Old Style,Bold" | "Iowan Old Style,BoldItalic" | "Iowan Old Style,Italic" | "IowanOldStyle-Black" | "IowanOldStyle-Roman" | "IowanOldStyle-Titling" | "Lucida Grande" | "Lucida Grande,Bold" | "Marion,Bold" | "Marion,Italic" | "Marion-Regular" | "Marker Felt Thin" | "Marker Felt Wide" | "Menlo,Bold" | "Menlo,BoldItalic" | "Menlo,Italic" | "Menlo-Regular" | "Monaco" | "Noteworthy,Bold" | "Noteworthy-Light" | "Optima,Bold" | "Optima,BoldItalic" | "Optima,Italic" | "Optima-ExtraBlack" | "Optima-Regular" | "PT Mono,Bold" | "PT Sans Caption,Bold" | "PT Sans Narrow,Bold" | "PT Sans,Bold" | "PT Sans,BoldItalic" | "PT Sans,Italic" | "PT Serif Caption,Italic" | "PT Serif,Bold" | "PT Serif,BoldItalic" | "PT Serif,Italic" | "PTMono-Regular" | "PTSans-Caption" | "PTSans-Narrow" | "PTSans-Regular" | "PTSerif-Caption" | "PTSerif-Regular" | "Palatino,Bold" | "Palatino,BoldItalic" | "Palatino,Italic" | "Palatino-Roman" | "Papyrus" | "Papyrus-Condensed" | "PlantagenetCherokee" | "STBaoli-SC-Regular" | "STYuanti-SC-Light" | "STYuanti-SC-Regular" | "SavoyeLetPlain" | "Seravek" | "Seravek ExtraLight, Italic" | "Seravek Light,Italic" | "Seravek Medium,Italic" | "Seravek,Bold" | "Seravek,BoldItalic" | "Seravek,Italic" | "Seravek-ExtraLight" | "Seravek-Light" | "Seravek-Medium" | "Skia-Regular" | "Skia-Regular_Black" | "Skia-Regular_Black-Condensed" | "Skia-Regular_Black-Extended" | "Skia-Regular_Condensed" | "Skia-Regular_Extended" | "Skia-Regular_Light" | "Skia-Regular_Light-Condensed" | "Skia-Regular_Light-Extended" | "Snell Roundhand,Bold" | "SnellRoundhand" | "SnellRoundhand-Black" | "Superclarendon Black,Italic" | "Superclarendon Light,Italic" | "Superclarendon,Bold" | "Superclarendon,BoldItalic" | "Superclarendon,Italic" | "Superclarendon-Black" | "Superclarendon-Light" | "Superclarendon-Regular" | "Tahoma" | "Tahoma,Bold" | "Times New Roman,Bold" | "Times New Roman,BoldItalic" | "Times New Roman,Italic" | "Times,Bold" | "Times,BoldItalic" | "Times,Italic" | "Times-Roman" | "TimesNewRomanPSMT" | "Trebuchet MS,Bold" | "Trebuchet MS,BoldItalic" | "Trebuchet MS,Italic" | "TrebuchetMS" | "Verdana" | "Verdana,Bold" | "Verdana,BoldItalic" | "Verdana,Italic" | "Waseem" | "WaseemLight" | "Webdings" | "Wingdings-Regular" | "Wingdings2" | "Wingdings3" | "Yuanti SC,Bold" | "YuppySC-Regular" | "Zapf Dingbats" | "Zapfino";
4
+ interface ImgixURLParams {
5
+ /**
6
+ * Aspect ratio
7
+ *
8
+ * Specifies an aspect ratio to maintain when resizing and cropping the image
9
+ *
10
+ * @see https://docs.imgix.com/apis/url/size/ar
11
+ */
12
+ ar?: Ratio;
13
+ /**
14
+ * Automatic
15
+ *
16
+ * Applies automatic enhancements to images.
17
+ *
18
+ * @see https://docs.imgix.com/apis/url/auto
19
+ */
20
+ auto?: ("enhance" | "format" | "redeye" | "compress" | "true")[];
21
+ /**
22
+ * Background color
23
+ *
24
+ * Colors the background of padded and partially-transparent images.
25
+ *
26
+ * @defaultValue `"fff"`
27
+ *
28
+ * @see https://docs.imgix.com/apis/url/bg
29
+ */
30
+ bg?: string | ColorKeyword;
31
+ /**
32
+ * Blend align
33
+ *
34
+ * Changes the blend alignment relative to the parent image.
35
+ *
36
+ * Aliases: `blendalign`, `ba`
37
+ *
38
+ * @see https://docs.imgix.com/apis/url/blending/blend-align
39
+ */
40
+ blendAlign?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[];
41
+ /**
42
+ * Blend align
43
+ *
44
+ * Changes the blend alignment relative to the parent image.
45
+ *
46
+ * Alias for: `blendAlign`
47
+ *
48
+ * @see https://docs.imgix.com/apis/url/blending/blend-align
49
+ */
50
+ blendalign?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[];
51
+ /**
52
+ * Blend align
53
+ *
54
+ * Changes the blend alignment relative to the parent image.
55
+ *
56
+ * Alias for: `blendAlign`
57
+ *
58
+ * @see https://docs.imgix.com/apis/url/blending/blend-align
59
+ */
60
+ ba?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[];
61
+ /**
62
+ * Blend alpha
63
+ *
64
+ * Changes the alpha of the blend image.
65
+ *
66
+ * Aliases: `blendalpha`, `balph`
67
+ *
68
+ * @defaultValue `100`
69
+ *
70
+ * @see https://docs.imgix.com/apis/url/blending/blend-alpha
71
+ */
72
+ blendAlpha?: number;
73
+ /**
74
+ * Blend alpha
75
+ *
76
+ * Changes the alpha of the blend image.
77
+ *
78
+ * Alias for: `blendAlpha`
79
+ *
80
+ * @defaultValue `100`
81
+ *
82
+ * @see https://docs.imgix.com/apis/url/blending/blend-alpha
83
+ */
84
+ blendalpha?: number;
85
+ /**
86
+ * Blend alpha
87
+ *
88
+ * Changes the alpha of the blend image.
89
+ *
90
+ * Alias for: `blendAlpha`
91
+ *
92
+ * @defaultValue `100`
93
+ *
94
+ * @see https://docs.imgix.com/apis/url/blending/blend-alpha
95
+ */
96
+ balph?: number;
97
+ /**
98
+ * Blend color
99
+ *
100
+ * Specifies a color to use when applying the blend.
101
+ *
102
+ * Aliases: `blendcolor`, `blendClr`, `blendclr`
103
+ *
104
+ * @see https://docs.imgix.com/apis/url/blending/blend-color
105
+ */
106
+ blendColor?: string | ColorKeyword;
107
+ /**
108
+ * Blend color
109
+ *
110
+ * Specifies a color to use when applying the blend.
111
+ *
112
+ * Alias for: `blendColor`
113
+ *
114
+ * @see https://docs.imgix.com/apis/url/blending/blend-color
115
+ */
116
+ blendcolor?: string | ColorKeyword;
117
+ /**
118
+ * Blend color
119
+ *
120
+ * Specifies a color to use when applying the blend.
121
+ *
122
+ * Alias for: `blendColor`
123
+ *
124
+ * @see https://docs.imgix.com/apis/url/blending/blend-color
125
+ */
126
+ blendClr?: string | ColorKeyword;
127
+ /**
128
+ * Blend color
129
+ *
130
+ * Specifies a color to use when applying the blend.
131
+ *
132
+ * Alias for: `blendColor`
133
+ *
134
+ * @see https://docs.imgix.com/apis/url/blending/blend-color
135
+ */
136
+ blendclr?: string | ColorKeyword;
137
+ /**
138
+ * Blend crop
139
+ *
140
+ * Specifies the type of crop for blend images.
141
+ *
142
+ * Aliases: `blendcrop`, `bc`
143
+ *
144
+ * @see https://docs.imgix.com/apis/url/blending/blend-crop
145
+ */
146
+ blendCrop?: ("top" | "bottom" | "left" | "right" | "faces")[];
147
+ /**
148
+ * Blend crop
149
+ *
150
+ * Specifies the type of crop for blend images.
151
+ *
152
+ * Alias for: `blendCrop`
153
+ *
154
+ * @see https://docs.imgix.com/apis/url/blending/blend-crop
155
+ */
156
+ blendcrop?: ("top" | "bottom" | "left" | "right" | "faces")[];
157
+ /**
158
+ * Blend crop
159
+ *
160
+ * Specifies the type of crop for blend images.
161
+ *
162
+ * Alias for: `blendCrop`
163
+ *
164
+ * @see https://docs.imgix.com/apis/url/blending/blend-crop
165
+ */
166
+ bc?: ("top" | "bottom" | "left" | "right" | "faces")[];
167
+ /**
168
+ * Blend fit
169
+ *
170
+ * Specifies the fit mode for blend images.
171
+ *
172
+ * Aliases: `blendfit`, `bf`
173
+ *
174
+ * @defaultValue `"clip"`
175
+ *
176
+ * @see https://docs.imgix.com/apis/url/blending/blend-fit
177
+ */
178
+ blendFit?: "clamp" | "clip" | "crop" | "scale" | "max";
179
+ /**
180
+ * Blend fit
181
+ *
182
+ * Specifies the fit mode for blend images.
183
+ *
184
+ * Alias for: `blendFit`
185
+ *
186
+ * @defaultValue `"clip"`
187
+ *
188
+ * @see https://docs.imgix.com/apis/url/blending/blend-fit
189
+ */
190
+ blendfit?: "clamp" | "clip" | "crop" | "scale" | "max";
191
+ /**
192
+ * Blend fit
193
+ *
194
+ * Specifies the fit mode for blend images.
195
+ *
196
+ * Alias for: `blendFit`
197
+ *
198
+ * @defaultValue `"clip"`
199
+ *
200
+ * @see https://docs.imgix.com/apis/url/blending/blend-fit
201
+ */
202
+ bf?: "clamp" | "clip" | "crop" | "scale" | "max";
203
+ /**
204
+ * Blend height
205
+ *
206
+ * Adjusts the height of the blend image.
207
+ *
208
+ * Aliases: `blendh`, `bh`
209
+ *
210
+ * @see https://docs.imgix.com/apis/url/blending/blend-h
211
+ */
212
+ blendH?: number;
213
+ /**
214
+ * Blend height
215
+ *
216
+ * Adjusts the height of the blend image.
217
+ *
218
+ * Alias for: `blendH`
219
+ *
220
+ * @see https://docs.imgix.com/apis/url/blending/blend-h
221
+ */
222
+ blendh?: number;
223
+ /**
224
+ * Blend height
225
+ *
226
+ * Adjusts the height of the blend image.
227
+ *
228
+ * Alias for: `blendH`
229
+ *
230
+ * @see https://docs.imgix.com/apis/url/blending/blend-h
231
+ */
232
+ bh?: number;
233
+ /**
234
+ * Blend mode
235
+ *
236
+ * Sets the blend mode for a blend image.
237
+ *
238
+ * Aliases: `blendmode`, `bm`
239
+ *
240
+ * @defaultValue `"overlay"`
241
+ *
242
+ * @see https://docs.imgix.com/apis/url/blending/blend-mode
243
+ */
244
+ blendMode?: "color" | "burn" | "dodge" | "darken" | "difference" | "exclusion" | "hardlight" | "hue" | "lighten" | "luminosity" | "multiply" | "overlay" | "saturation" | "screen" | "softlight" | "normal";
245
+ /**
246
+ * Blend mode
247
+ *
248
+ * Sets the blend mode for a blend image.
249
+ *
250
+ * Alias for: `blendMode`
251
+ *
252
+ * @defaultValue `"overlay"`
253
+ *
254
+ * @see https://docs.imgix.com/apis/url/blending/blend-mode
255
+ */
256
+ blendmode?: "color" | "burn" | "dodge" | "darken" | "difference" | "exclusion" | "hardlight" | "hue" | "lighten" | "luminosity" | "multiply" | "overlay" | "saturation" | "screen" | "softlight" | "normal";
257
+ /**
258
+ * Blend mode
259
+ *
260
+ * Sets the blend mode for a blend image.
261
+ *
262
+ * Alias for: `blendMode`
263
+ *
264
+ * @defaultValue `"overlay"`
265
+ *
266
+ * @see https://docs.imgix.com/apis/url/blending/blend-mode
267
+ */
268
+ bm?: "color" | "burn" | "dodge" | "darken" | "difference" | "exclusion" | "hardlight" | "hue" | "lighten" | "luminosity" | "multiply" | "overlay" | "saturation" | "screen" | "softlight" | "normal";
269
+ /**
270
+ * Blend padding
271
+ *
272
+ * Applies padding to the blend image.
273
+ *
274
+ * Aliases: `blendpad`, `bp`
275
+ *
276
+ * @defaultValue `0`
277
+ *
278
+ * @see https://docs.imgix.com/apis/url/blending/blend-pad
279
+ */
280
+ blendPad?: number;
281
+ /**
282
+ * Blend padding
283
+ *
284
+ * Applies padding to the blend image.
285
+ *
286
+ * Alias for: `blendPad`
287
+ *
288
+ * @defaultValue `0`
289
+ *
290
+ * @see https://docs.imgix.com/apis/url/blending/blend-pad
291
+ */
292
+ blendpad?: number;
293
+ /**
294
+ * Blend padding
295
+ *
296
+ * Applies padding to the blend image.
297
+ *
298
+ * Alias for: `blendPad`
299
+ *
300
+ * @defaultValue `0`
301
+ *
302
+ * @see https://docs.imgix.com/apis/url/blending/blend-pad
303
+ */
304
+ bp?: number;
305
+ /**
306
+ * Blend size
307
+ *
308
+ * Adjusts the size of the blend image.
309
+ *
310
+ * Aliases: `blendsize`, `bs`
311
+ *
312
+ * @see https://docs.imgix.com/apis/url/blending/blend-size
313
+ */
314
+ blendSize?: "inherit";
315
+ /**
316
+ * Blend size
317
+ *
318
+ * Adjusts the size of the blend image.
319
+ *
320
+ * Alias for: `blendSize`
321
+ *
322
+ * @see https://docs.imgix.com/apis/url/blending/blend-size
323
+ */
324
+ blendsize?: "inherit";
325
+ /**
326
+ * Blend size
327
+ *
328
+ * Adjusts the size of the blend image.
329
+ *
330
+ * Alias for: `blendSize`
331
+ *
332
+ * @see https://docs.imgix.com/apis/url/blending/blend-size
333
+ */
334
+ bs?: "inherit";
335
+ /**
336
+ * Blend width
337
+ *
338
+ * Adjusts the width of the blend image.
339
+ *
340
+ * Aliases: `blendw`, `bw`
341
+ *
342
+ * @see https://docs.imgix.com/apis/url/blending/blend-w
343
+ */
344
+ blendW?: number;
345
+ /**
346
+ * Blend width
347
+ *
348
+ * Adjusts the width of the blend image.
349
+ *
350
+ * Alias for: `blendW`
351
+ *
352
+ * @see https://docs.imgix.com/apis/url/blending/blend-w
353
+ */
354
+ blendw?: number;
355
+ /**
356
+ * Blend width
357
+ *
358
+ * Adjusts the width of the blend image.
359
+ *
360
+ * Alias for: `blendW`
361
+ *
362
+ * @see https://docs.imgix.com/apis/url/blending/blend-w
363
+ */
364
+ bw?: number;
365
+ /**
366
+ * Blend x position
367
+ *
368
+ * Adjusts the x-offset of the blend image relative to its parent.
369
+ *
370
+ * Aliases: `blendx`, `bx`
371
+ *
372
+ * @defaultValue `0`
373
+ *
374
+ * @see https://docs.imgix.com/apis/url/blending/blend-x
375
+ */
376
+ blendX?: number;
377
+ /**
378
+ * Blend x position
379
+ *
380
+ * Adjusts the x-offset of the blend image relative to its parent.
381
+ *
382
+ * Alias for: `blendX`
383
+ *
384
+ * @defaultValue `0`
385
+ *
386
+ * @see https://docs.imgix.com/apis/url/blending/blend-x
387
+ */
388
+ blendx?: number;
389
+ /**
390
+ * Blend x position
391
+ *
392
+ * Adjusts the x-offset of the blend image relative to its parent.
393
+ *
394
+ * Alias for: `blendX`
395
+ *
396
+ * @defaultValue `0`
397
+ *
398
+ * @see https://docs.imgix.com/apis/url/blending/blend-x
399
+ */
400
+ bx?: number;
401
+ /**
402
+ * Blend y position
403
+ *
404
+ * Adjusts the y-offset of the blend image relative to its parent.
405
+ *
406
+ * Aliases: `blendy`, `by`
407
+ *
408
+ * @defaultValue `0`
409
+ *
410
+ * @see https://docs.imgix.com/apis/url/blending/blend-y
411
+ */
412
+ blendY?: number;
413
+ /**
414
+ * Blend y position
415
+ *
416
+ * Adjusts the y-offset of the blend image relative to its parent.
417
+ *
418
+ * Alias for: `blendY`
419
+ *
420
+ * @defaultValue `0`
421
+ *
422
+ * @see https://docs.imgix.com/apis/url/blending/blend-y
423
+ */
424
+ blendy?: number;
425
+ /**
426
+ * Blend y position
427
+ *
428
+ * Adjusts the y-offset of the blend image relative to its parent.
429
+ *
430
+ * Alias for: `blendY`
431
+ *
432
+ * @defaultValue `0`
433
+ *
434
+ * @see https://docs.imgix.com/apis/url/blending/blend-y
435
+ */
436
+ by?: number;
437
+ /**
438
+ * Blend
439
+ *
440
+ * Specifies the location of the blend image.
441
+ *
442
+ * Aliases: `b`
443
+ *
444
+ * @see https://docs.imgix.com/apis/url/blending/blend
445
+ */
446
+ blend?: string | ColorKeyword;
447
+ /**
448
+ * Blend
449
+ *
450
+ * Specifies the location of the blend image.
451
+ *
452
+ * Alias for: `blend`
453
+ *
454
+ * @see https://docs.imgix.com/apis/url/blending/blend
455
+ */
456
+ b?: string | ColorKeyword;
457
+ /**
458
+ * Gaussian blur
459
+ *
460
+ * Applies a gaussian blur to an image.
461
+ *
462
+ * @defaultValue `0`
463
+ *
464
+ * @see https://docs.imgix.com/apis/url/stylize/blur
465
+ */
466
+ blur?: number;
467
+ /**
468
+ * Border bottom
469
+ *
470
+ * Sets bottom border of an image.
471
+ *
472
+ * @see https://docs.imgix.com/apis/url/border-and-padding/border-bottom
473
+ */
474
+ borderBottom?: number;
475
+ /**
476
+ * Border left
477
+ *
478
+ * Sets left border of an image.
479
+ *
480
+ * @see https://docs.imgix.com/apis/url/border-and-padding/border-left
481
+ */
482
+ borderLeft?: number;
483
+ /**
484
+ * Inner border radius
485
+ *
486
+ * Sets the inner radius of the image's border in pixels.
487
+ *
488
+ * @see https://docs.imgix.com/apis/url/border-and-padding/border-radius-inner
489
+ */
490
+ borderRadiusInner?: number | [number, number, number, number];
491
+ /**
492
+ * Outer border radius
493
+ *
494
+ * Sets the outer radius of the image's border in pixels.
495
+ *
496
+ * @see https://docs.imgix.com/apis/url/border-and-padding/border-radius
497
+ */
498
+ borderRadius?: number | [number, number, number, number];
499
+ /**
500
+ * Border right
501
+ *
502
+ * Sets right border of an image.
503
+ *
504
+ * @see https://docs.imgix.com/apis/url/border-and-padding/border-right
505
+ */
506
+ borderRight?: number;
507
+ /**
508
+ * Border top
509
+ *
510
+ * Sets top border of an image.
511
+ *
512
+ * @see https://docs.imgix.com/apis/url/border-and-padding/border-top
513
+ */
514
+ borderTop?: number;
515
+ /**
516
+ * Border size & color
517
+ *
518
+ * Applies a border to an image.
519
+ *
520
+ * @see https://docs.imgix.com/apis/url/border-and-padding/border
521
+ */
522
+ border?: [number, string | ColorKeyword];
523
+ /**
524
+ * Brightness
525
+ *
526
+ * Adjusts the brightness of the source image.
527
+ *
528
+ * @defaultValue `0`
529
+ *
530
+ * @see https://docs.imgix.com/apis/url/adjustment/bri
531
+ */
532
+ bri?: number;
533
+ /**
534
+ * Client hints
535
+ *
536
+ * Sets one or more Client-Hints headers
537
+ *
538
+ * @see https://docs.imgix.com/apis/url/format/ch
539
+ */
540
+ ch?: ("width" | "dpr" | "save-data")[];
541
+ /**
542
+ * Chroma subsampling
543
+ *
544
+ * Specifies the output chroma subsampling rate.
545
+ *
546
+ * @defaultValue `420`
547
+ *
548
+ * @see https://docs.imgix.com/apis/url/format/chromasub
549
+ */
550
+ chromasub?: 444 | 422 | 420;
551
+ /**
552
+ * Color quantization
553
+ *
554
+ * Limits the number of unique colors in an image.
555
+ *
556
+ * @see https://docs.imgix.com/apis/url/format/colorquant
557
+ */
558
+ colorquant?: number;
559
+ /**
560
+ * Palette color count
561
+ *
562
+ * Specifies how many colors to include in a palette-extraction response.
563
+ *
564
+ * @defaultValue `6`
565
+ *
566
+ * @see https://docs.imgix.com/apis/url/color-palette/colors
567
+ */
568
+ colors?: number;
569
+ /**
570
+ * Contrast
571
+ *
572
+ * Adjusts the contrast of the source image.
573
+ *
574
+ * @defaultValue `0`
575
+ *
576
+ * @see https://docs.imgix.com/apis/url/adjustment/con
577
+ */
578
+ con?: number;
579
+ /**
580
+ * Mask corner radius
581
+ *
582
+ * Specifies the radius value for a rounded corner mask.
583
+ *
584
+ * @see https://docs.imgix.com/apis/url/mask/corner-radius
585
+ */
586
+ cornerRadius?: number | [number, number, number, number];
587
+ /**
588
+ * Crop mode
589
+ *
590
+ * Specifies how to crop an image.
591
+ *
592
+ * @see https://docs.imgix.com/apis/url/size/crop
593
+ */
594
+ crop?: ("top" | "bottom" | "left" | "right" | "faces" | "entropy" | "edges" | "focalpoint")[];
595
+ /**
596
+ * Color space
597
+ *
598
+ * Specifies the color space of the output image.
599
+ *
600
+ * @see https://docs.imgix.com/apis/url/format/cs
601
+ */
602
+ cs?: "srgb" | "adobergb1998" | "tinysrgb" | "strip";
603
+ /**
604
+ * Download
605
+ *
606
+ * Forces a URL to use send-file in its response.
607
+ *
608
+ * @see https://docs.imgix.com/apis/url/format/dl
609
+ */
610
+ dl?: string;
611
+ /**
612
+ * Dots per inch
613
+ *
614
+ * Sets the DPI value in the EXIF header.
615
+ *
616
+ * @see https://docs.imgix.com/apis/url/format/dpi
617
+ */
618
+ dpi?: number;
619
+ /**
620
+ * Device pixel ratio
621
+ *
622
+ * Adjusts the device-pixel ratio of the output image.
623
+ *
624
+ * @defaultValue `1`
625
+ *
626
+ * @see https://docs.imgix.com/apis/url/dpr
627
+ */
628
+ dpr?: number;
629
+ /**
630
+ * Duotone alpha
631
+ *
632
+ * Changes the alpha of the duotone effect atop the source image.
633
+ *
634
+ * @defaultValue `100`
635
+ *
636
+ * @see https://docs.imgix.com/apis/url/stylize/duotone-alpha
637
+ */
638
+ duotoneAlpha?: number;
639
+ /**
640
+ * Duotone
641
+ *
642
+ * Applies a duotone effect to the source image.
643
+ *
644
+ * @see https://docs.imgix.com/apis/url/stylize/duotone
645
+ */
646
+ duotone?: [string | ColorKeyword, string | ColorKeyword];
647
+ /**
648
+ * Exposure
649
+ *
650
+ * Adjusts the exposure of the output image.
651
+ *
652
+ * @defaultValue `0`
653
+ *
654
+ * @see https://docs.imgix.com/apis/url/adjustment/exp
655
+ */
656
+ exp?: number;
657
+ /**
658
+ * URL expiration timestamp
659
+ *
660
+ * A Unix timestamp specifying a UTC time. Requests made to this URL after
661
+ * that time will output a 404 status code.
662
+ *
663
+ * @see https://docs.imgix.com/apis/url/expires
664
+ */
665
+ expires?: number;
666
+ /**
667
+ * Face index
668
+ *
669
+ * Selects a face to crop to.
670
+ *
671
+ * @see https://docs.imgix.com/apis/url/face-detection/faceindex
672
+ */
673
+ faceindex?: number;
674
+ /**
675
+ * Face padding
676
+ *
677
+ * Adjusts padding around a selected face.
678
+ *
679
+ * @defaultValue `1`
680
+ *
681
+ * @see https://docs.imgix.com/apis/url/face-detection/facepad
682
+ */
683
+ facepad?: number;
684
+ /**
685
+ * Json face data
686
+ *
687
+ * Specifies that face data should be included in output when combined with `fm=json`.
688
+ *
689
+ * @see https://docs.imgix.com/apis/url/face-detection/faces
690
+ */
691
+ faces?: 1;
692
+ /**
693
+ * Fill color
694
+ *
695
+ * Sets the fill color for images with additional space created by the fit setting
696
+ *
697
+ * Aliases: `fillcolor`
698
+ *
699
+ * @defaultValue `"fff"`
700
+ *
701
+ * @see https://docs.imgix.com/apis/url/fill/fill-color
702
+ */
703
+ fillColor?: string | ColorKeyword;
704
+ /**
705
+ * Fill color
706
+ *
707
+ * Sets the fill color for images with additional space created by the fit setting
708
+ *
709
+ * Alias for: `fillColor`
710
+ *
711
+ * @defaultValue `"fff"`
712
+ *
713
+ * @see https://docs.imgix.com/apis/url/fill/fill-color
714
+ */
715
+ fillcolor?: string | ColorKeyword;
716
+ /**
717
+ * Fill mode
718
+ *
719
+ * Determines how to fill in additional space created by the fit setting
720
+ *
721
+ * @see https://docs.imgix.com/apis/url/fill/fill
722
+ */
723
+ fill?: "solid" | "blur";
724
+ /**
725
+ * Resize fit mode
726
+ *
727
+ * Specifies how to map the source image to the output image dimensions.
728
+ *
729
+ * Aliases: `f`
730
+ *
731
+ * @defaultValue `"clip"`
732
+ *
733
+ * @see https://docs.imgix.com/apis/url/size/fit
734
+ */
735
+ fit?: "clamp" | "clip" | "crop" | "facearea" | "fill" | "fillmax" | "max" | "min" | "scale";
736
+ /**
737
+ * Resize fit mode
738
+ *
739
+ * Specifies how to map the source image to the output image dimensions.
740
+ *
741
+ * Alias for: `fit`
742
+ *
743
+ * @defaultValue `"clip"`
744
+ *
745
+ * @see https://docs.imgix.com/apis/url/size/fit
746
+ */
747
+ f?: "clamp" | "clip" | "crop" | "facearea" | "fill" | "fillmax" | "max" | "min" | "scale";
748
+ /**
749
+ * Flip axis
750
+ *
751
+ * Flips an image on a specified axis.
752
+ *
753
+ * @see https://docs.imgix.com/apis/url/rotation/flip
754
+ */
755
+ flip?: "h" | "v" | "hv";
756
+ /**
757
+ * Output format
758
+ *
759
+ * Changes the format of the output image.
760
+ *
761
+ * @see https://docs.imgix.com/apis/url/format/fm
762
+ */
763
+ fm?: "gif" | "jpg" | "jp2" | "json" | "jxr" | "pjpg" | "mp4" | "png" | "png8" | "png32" | "webp" | "webm" | "blurhash" | "avif";
764
+ /**
765
+ * Focal point debug
766
+ *
767
+ * Displays crosshairs identifying the location of the set focal point
768
+ *
769
+ * @defaultValue `false`
770
+ *
771
+ * @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-debug
772
+ */
773
+ fpDebug?: boolean;
774
+ /**
775
+ * Focal point x position
776
+ *
777
+ * Sets the relative horizontal value for the focal point of an image
778
+ *
779
+ * @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-x
780
+ */
781
+ fpX?: number;
782
+ /**
783
+ * Focal point y position
784
+ *
785
+ * Sets the relative vertical value for the focal point of an image
786
+ *
787
+ * @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-y
788
+ */
789
+ fpY?: number;
790
+ /**
791
+ * Focal point zoom
792
+ *
793
+ * Sets the relative zoom value for the focal point of an image
794
+ *
795
+ * @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-z
796
+ */
797
+ fpZ?: number;
798
+ /**
799
+ * Gamma
800
+ *
801
+ * Adjusts the gamma of the source image.
802
+ *
803
+ * @defaultValue `0`
804
+ *
805
+ * @see https://docs.imgix.com/apis/url/adjustment/gam
806
+ */
807
+ gam?: number;
808
+ /**
809
+ * Grid colors
810
+ *
811
+ * Sets grid colors for the transparency checkerboard grid.
812
+ */
813
+ gridColors?: [string | ColorKeyword, string | ColorKeyword];
814
+ /**
815
+ * Grid size
816
+ *
817
+ * Sets grid size for the transparency checkerboard grid.
818
+ */
819
+ gridSize?: number;
820
+ /**
821
+ * Image height
822
+ *
823
+ * Adjusts the height of the output image.
824
+ *
825
+ * Aliases: `height`
826
+ *
827
+ * @see https://docs.imgix.com/apis/url/size/h
828
+ */
829
+ h?: number;
830
+ /**
831
+ * Image height
832
+ *
833
+ * Adjusts the height of the output image.
834
+ *
835
+ * Alias for: `h`
836
+ *
837
+ * @see https://docs.imgix.com/apis/url/size/h
838
+ */
839
+ height?: number;
840
+ /**
841
+ * Highlight
842
+ *
843
+ * Adjusts the highlights of the source image.
844
+ *
845
+ * @defaultValue `0`
846
+ *
847
+ * @see https://docs.imgix.com/apis/url/adjustment/high
848
+ */
849
+ high?: number;
850
+ /**
851
+ * Halftone
852
+ *
853
+ * Applies a half-tone effect to the source image.
854
+ *
855
+ * @defaultValue `0`
856
+ *
857
+ * @see https://docs.imgix.com/apis/url/stylize/htn
858
+ */
859
+ htn?: number;
860
+ /**
861
+ * Hue shift
862
+ *
863
+ * Adjusts the hue of the source image.
864
+ *
865
+ * @defaultValue `0`
866
+ *
867
+ * @see https://docs.imgix.com/apis/url/adjustment/hue
868
+ */
869
+ hue?: number;
870
+ /**
871
+ * Invert
872
+ *
873
+ * Inverts the colors on the source image.
874
+ *
875
+ * Aliases: `inv`
876
+ *
877
+ * @defaultValue `false`
878
+ *
879
+ * @see https://docs.imgix.com/apis/url/adjustment/invert
880
+ */
881
+ invert?: boolean;
882
+ /**
883
+ * Invert
884
+ *
885
+ * Inverts the colors on the source image.
886
+ *
887
+ * Alias for: `invert`
888
+ *
889
+ * @defaultValue `false`
890
+ *
891
+ * @see https://docs.imgix.com/apis/url/adjustment/invert
892
+ */
893
+ inv?: boolean;
894
+ /**
895
+ * IPTC Passthrough
896
+ *
897
+ * Determine if IPTC data should be passed for JPEG images.
898
+ */
899
+ iptc?: "allow" | "block";
900
+ /**
901
+ * Lossless compression
902
+ *
903
+ * Specifies that the output image should be a lossless variant.
904
+ *
905
+ * @defaultValue `false`
906
+ *
907
+ * @see https://docs.imgix.com/apis/url/format/lossless
908
+ */
909
+ lossless?: boolean;
910
+ /**
911
+ * Watermark alignment mode
912
+ *
913
+ * Changes the watermark alignment relative to the parent image.
914
+ *
915
+ * Aliases: `ma`, `markalign`
916
+ *
917
+ * @see https://docs.imgix.com/apis/url/watermark/mark-align
918
+ */
919
+ markAlign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
920
+ /**
921
+ * Watermark alignment mode
922
+ *
923
+ * Changes the watermark alignment relative to the parent image.
924
+ *
925
+ * Alias for: `markAlign`
926
+ *
927
+ * @see https://docs.imgix.com/apis/url/watermark/mark-align
928
+ */
929
+ ma?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
930
+ /**
931
+ * Watermark alignment mode
932
+ *
933
+ * Changes the watermark alignment relative to the parent image.
934
+ *
935
+ * Alias for: `markAlign`
936
+ *
937
+ * @see https://docs.imgix.com/apis/url/watermark/mark-align
938
+ */
939
+ markalign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
940
+ /**
941
+ * Watermark alpha
942
+ *
943
+ * Changes the alpha of the watermark image.
944
+ *
945
+ * Aliases: `markalpha`, `malph`
946
+ *
947
+ * @defaultValue `100`
948
+ *
949
+ * @see https://docs.imgix.com/apis/url/watermark/mark-alpha
950
+ */
951
+ markAlpha?: number;
952
+ /**
953
+ * Watermark alpha
954
+ *
955
+ * Changes the alpha of the watermark image.
956
+ *
957
+ * Alias for: `markAlpha`
958
+ *
959
+ * @defaultValue `100`
960
+ *
961
+ * @see https://docs.imgix.com/apis/url/watermark/mark-alpha
962
+ */
963
+ markalpha?: number;
964
+ /**
965
+ * Watermark alpha
966
+ *
967
+ * Changes the alpha of the watermark image.
968
+ *
969
+ * Alias for: `markAlpha`
970
+ *
971
+ * @defaultValue `100`
972
+ *
973
+ * @see https://docs.imgix.com/apis/url/watermark/mark-alpha
974
+ */
975
+ malph?: number;
976
+ /**
977
+ * Watermark base url
978
+ *
979
+ * Changes base URL of the watermark image.
980
+ *
981
+ * Aliases: `mb`, `markbase`
982
+ *
983
+ * @see https://docs.imgix.com/apis/url/watermark/mark-base
984
+ */
985
+ markBase?: string;
986
+ /**
987
+ * Watermark base url
988
+ *
989
+ * Changes base URL of the watermark image.
990
+ *
991
+ * Alias for: `markBase`
992
+ *
993
+ * @see https://docs.imgix.com/apis/url/watermark/mark-base
994
+ */
995
+ mb?: string;
996
+ /**
997
+ * Watermark base url
998
+ *
999
+ * Changes base URL of the watermark image.
1000
+ *
1001
+ * Alias for: `markBase`
1002
+ *
1003
+ * @see https://docs.imgix.com/apis/url/watermark/mark-base
1004
+ */
1005
+ markbase?: string;
1006
+ /**
1007
+ * Watermark fit mode
1008
+ *
1009
+ * Specifies the fit mode for watermark images.
1010
+ *
1011
+ * Aliases: `mf`, `markfit`
1012
+ *
1013
+ * @defaultValue `"clip"`
1014
+ *
1015
+ * @see https://docs.imgix.com/apis/url/watermark/mark-fit
1016
+ */
1017
+ markFit?: "clip" | "crop" | "fill" | "max" | "scale";
1018
+ /**
1019
+ * Watermark fit mode
1020
+ *
1021
+ * Specifies the fit mode for watermark images.
1022
+ *
1023
+ * Alias for: `markFit`
1024
+ *
1025
+ * @defaultValue `"clip"`
1026
+ *
1027
+ * @see https://docs.imgix.com/apis/url/watermark/mark-fit
1028
+ */
1029
+ mf?: "clip" | "crop" | "fill" | "max" | "scale";
1030
+ /**
1031
+ * Watermark fit mode
1032
+ *
1033
+ * Specifies the fit mode for watermark images.
1034
+ *
1035
+ * Alias for: `markFit`
1036
+ *
1037
+ * @defaultValue `"clip"`
1038
+ *
1039
+ * @see https://docs.imgix.com/apis/url/watermark/mark-fit
1040
+ */
1041
+ markfit?: "clip" | "crop" | "fill" | "max" | "scale";
1042
+ /**
1043
+ * Watermark height
1044
+ *
1045
+ * Adjusts the height of the watermark image.
1046
+ *
1047
+ * Aliases: `mh`, `markh`
1048
+ *
1049
+ * @see https://docs.imgix.com/apis/url/watermark/mark-h
1050
+ */
1051
+ markH?: number;
1052
+ /**
1053
+ * Watermark height
1054
+ *
1055
+ * Adjusts the height of the watermark image.
1056
+ *
1057
+ * Alias for: `markH`
1058
+ *
1059
+ * @see https://docs.imgix.com/apis/url/watermark/mark-h
1060
+ */
1061
+ mh?: number;
1062
+ /**
1063
+ * Watermark height
1064
+ *
1065
+ * Adjusts the height of the watermark image.
1066
+ *
1067
+ * Alias for: `markH`
1068
+ *
1069
+ * @see https://docs.imgix.com/apis/url/watermark/mark-h
1070
+ */
1071
+ markh?: number;
1072
+ /**
1073
+ * Watermark padding
1074
+ *
1075
+ * Applies padding to the watermark image.
1076
+ *
1077
+ * Aliases: `mp`, `markpad`
1078
+ *
1079
+ * @defaultValue `5`
1080
+ *
1081
+ * @see https://docs.imgix.com/apis/url/watermark/mark-pad
1082
+ */
1083
+ markPad?: number;
1084
+ /**
1085
+ * Watermark padding
1086
+ *
1087
+ * Applies padding to the watermark image.
1088
+ *
1089
+ * Alias for: `markPad`
1090
+ *
1091
+ * @defaultValue `5`
1092
+ *
1093
+ * @see https://docs.imgix.com/apis/url/watermark/mark-pad
1094
+ */
1095
+ mp?: number;
1096
+ /**
1097
+ * Watermark padding
1098
+ *
1099
+ * Applies padding to the watermark image.
1100
+ *
1101
+ * Alias for: `markPad`
1102
+ *
1103
+ * @defaultValue `5`
1104
+ *
1105
+ * @see https://docs.imgix.com/apis/url/watermark/mark-pad
1106
+ */
1107
+ markpad?: number;
1108
+ /**
1109
+ * Watermark rotation
1110
+ *
1111
+ * Rotates a watermark or tiled watermarks by a specified number of degrees.
1112
+ *
1113
+ * @defaultValue `0`
1114
+ *
1115
+ * @see https://docs.imgix.com/apis/url/watermark/mark-rot
1116
+ */
1117
+ markRot?: number;
1118
+ /**
1119
+ * Watermark scale
1120
+ *
1121
+ * Adjusts the scale of the watermark image.
1122
+ *
1123
+ * Aliases: `ms`, `markscale`
1124
+ *
1125
+ * @see https://docs.imgix.com/apis/url/watermark/mark-scale
1126
+ */
1127
+ markScale?: number;
1128
+ /**
1129
+ * Watermark scale
1130
+ *
1131
+ * Adjusts the scale of the watermark image.
1132
+ *
1133
+ * Alias for: `markScale`
1134
+ *
1135
+ * @see https://docs.imgix.com/apis/url/watermark/mark-scale
1136
+ */
1137
+ ms?: number;
1138
+ /**
1139
+ * Watermark scale
1140
+ *
1141
+ * Adjusts the scale of the watermark image.
1142
+ *
1143
+ * Alias for: `markScale`
1144
+ *
1145
+ * @see https://docs.imgix.com/apis/url/watermark/mark-scale
1146
+ */
1147
+ markscale?: number;
1148
+ /**
1149
+ * Watermark tile
1150
+ *
1151
+ * Adds tiled watermark.
1152
+ *
1153
+ * Aliases: `mtile`, `marktile`
1154
+ *
1155
+ * @see https://docs.imgix.com/apis/url/watermark/mark-tile
1156
+ */
1157
+ markTile?: "grid";
1158
+ /**
1159
+ * Watermark tile
1160
+ *
1161
+ * Adds tiled watermark.
1162
+ *
1163
+ * Alias for: `markTile`
1164
+ *
1165
+ * @see https://docs.imgix.com/apis/url/watermark/mark-tile
1166
+ */
1167
+ mtile?: "grid";
1168
+ /**
1169
+ * Watermark tile
1170
+ *
1171
+ * Adds tiled watermark.
1172
+ *
1173
+ * Alias for: `markTile`
1174
+ *
1175
+ * @see https://docs.imgix.com/apis/url/watermark/mark-tile
1176
+ */
1177
+ marktile?: "grid";
1178
+ /**
1179
+ * Watermark width
1180
+ *
1181
+ * Adjusts the width of the watermark image.
1182
+ *
1183
+ * Aliases: `mw`, `markw`
1184
+ *
1185
+ * @see https://docs.imgix.com/apis/url/watermark/mark-w
1186
+ */
1187
+ markW?: number;
1188
+ /**
1189
+ * Watermark width
1190
+ *
1191
+ * Adjusts the width of the watermark image.
1192
+ *
1193
+ * Alias for: `markW`
1194
+ *
1195
+ * @see https://docs.imgix.com/apis/url/watermark/mark-w
1196
+ */
1197
+ mw?: number;
1198
+ /**
1199
+ * Watermark width
1200
+ *
1201
+ * Adjusts the width of the watermark image.
1202
+ *
1203
+ * Alias for: `markW`
1204
+ *
1205
+ * @see https://docs.imgix.com/apis/url/watermark/mark-w
1206
+ */
1207
+ markw?: number;
1208
+ /**
1209
+ * Watermark x position
1210
+ *
1211
+ * Adjusts the x-offset of the watermark image relative to its parent.
1212
+ *
1213
+ * Aliases: `mx`, `markx`
1214
+ *
1215
+ * @see https://docs.imgix.com/apis/url/watermark/mark-x
1216
+ */
1217
+ markX?: number;
1218
+ /**
1219
+ * Watermark x position
1220
+ *
1221
+ * Adjusts the x-offset of the watermark image relative to its parent.
1222
+ *
1223
+ * Alias for: `markX`
1224
+ *
1225
+ * @see https://docs.imgix.com/apis/url/watermark/mark-x
1226
+ */
1227
+ mx?: number;
1228
+ /**
1229
+ * Watermark x position
1230
+ *
1231
+ * Adjusts the x-offset of the watermark image relative to its parent.
1232
+ *
1233
+ * Alias for: `markX`
1234
+ *
1235
+ * @see https://docs.imgix.com/apis/url/watermark/mark-x
1236
+ */
1237
+ markx?: number;
1238
+ /**
1239
+ * Watermark y position
1240
+ *
1241
+ * Adjusts the y-offset of the watermark image relative to its parent.
1242
+ *
1243
+ * Aliases: `my`, `marky`
1244
+ *
1245
+ * @see https://docs.imgix.com/apis/url/watermark/mark-y
1246
+ */
1247
+ markY?: number;
1248
+ /**
1249
+ * Watermark y position
1250
+ *
1251
+ * Adjusts the y-offset of the watermark image relative to its parent.
1252
+ *
1253
+ * Alias for: `markY`
1254
+ *
1255
+ * @see https://docs.imgix.com/apis/url/watermark/mark-y
1256
+ */
1257
+ my?: number;
1258
+ /**
1259
+ * Watermark y position
1260
+ *
1261
+ * Adjusts the y-offset of the watermark image relative to its parent.
1262
+ *
1263
+ * Alias for: `markY`
1264
+ *
1265
+ * @see https://docs.imgix.com/apis/url/watermark/mark-y
1266
+ */
1267
+ marky?: number;
1268
+ /**
1269
+ * Watermark image url
1270
+ *
1271
+ * Specifies the location of the watermark image.
1272
+ *
1273
+ * Aliases: `m`
1274
+ *
1275
+ * @see https://docs.imgix.com/apis/url/watermark/mark
1276
+ */
1277
+ mark?: string;
1278
+ /**
1279
+ * Watermark image url
1280
+ *
1281
+ * Specifies the location of the watermark image.
1282
+ *
1283
+ * Alias for: `mark`
1284
+ *
1285
+ * @see https://docs.imgix.com/apis/url/watermark/mark
1286
+ */
1287
+ m?: string;
1288
+ /**
1289
+ * Mask background color
1290
+ *
1291
+ * Colors the background of the transparent mask area of images
1292
+ *
1293
+ * Aliases: `maskbg`
1294
+ *
1295
+ * @defaultValue `"fff"`
1296
+ *
1297
+ * @see https://docs.imgix.com/apis/url/mask/mask-bg
1298
+ */
1299
+ maskBg?: string | ColorKeyword;
1300
+ /**
1301
+ * Mask background color
1302
+ *
1303
+ * Colors the background of the transparent mask area of images
1304
+ *
1305
+ * Alias for: `maskBg`
1306
+ *
1307
+ * @defaultValue `"fff"`
1308
+ *
1309
+ * @see https://docs.imgix.com/apis/url/mask/mask-bg
1310
+ */
1311
+ maskbg?: string | ColorKeyword;
1312
+ /**
1313
+ * Mask type
1314
+ *
1315
+ * Defines the type of mask and specifies the URL if that type is selected.
1316
+ *
1317
+ * @see https://docs.imgix.com/apis/url/mask
1318
+ */
1319
+ mask?: "ellipse" | "corners" | string;
1320
+ /**
1321
+ * Maximum height
1322
+ *
1323
+ * Specifies the maximum height of the output image in pixels.
1324
+ *
1325
+ * Aliases: `maxHeight`
1326
+ *
1327
+ * @see https://docs.imgix.com/apis/url/size/max-height
1328
+ */
1329
+ maxH?: number;
1330
+ /**
1331
+ * Maximum height
1332
+ *
1333
+ * Specifies the maximum height of the output image in pixels.
1334
+ *
1335
+ * Alias for: `maxH`
1336
+ *
1337
+ * @see https://docs.imgix.com/apis/url/size/max-height
1338
+ */
1339
+ maxHeight?: number;
1340
+ /**
1341
+ * Maximum width
1342
+ *
1343
+ * Specifies the maximum width of the output image in pixels.
1344
+ *
1345
+ * Aliases: `maxWidth`
1346
+ *
1347
+ * @see https://docs.imgix.com/apis/url/size/max-width
1348
+ */
1349
+ maxW?: number;
1350
+ /**
1351
+ * Maximum width
1352
+ *
1353
+ * Specifies the maximum width of the output image in pixels.
1354
+ *
1355
+ * Alias for: `maxW`
1356
+ *
1357
+ * @see https://docs.imgix.com/apis/url/size/max-width
1358
+ */
1359
+ maxWidth?: number;
1360
+ /**
1361
+ * Minimum height
1362
+ *
1363
+ * Specifies the minimum height of the output image in pixels.
1364
+ *
1365
+ * Aliases: `minHeight`
1366
+ *
1367
+ * @see https://docs.imgix.com/apis/url/size/min-height
1368
+ */
1369
+ minH?: number;
1370
+ /**
1371
+ * Minimum height
1372
+ *
1373
+ * Specifies the minimum height of the output image in pixels.
1374
+ *
1375
+ * Alias for: `minH`
1376
+ *
1377
+ * @see https://docs.imgix.com/apis/url/size/min-height
1378
+ */
1379
+ minHeight?: number;
1380
+ /**
1381
+ * Minimum width
1382
+ *
1383
+ * Specifies the minimum width of the output image in pixels.
1384
+ *
1385
+ * Aliases: `minWidth`
1386
+ *
1387
+ * @see https://docs.imgix.com/apis/url/size/min-width
1388
+ */
1389
+ minW?: number;
1390
+ /**
1391
+ * Minimum width
1392
+ *
1393
+ * Specifies the minimum width of the output image in pixels.
1394
+ *
1395
+ * Alias for: `minW`
1396
+ *
1397
+ * @see https://docs.imgix.com/apis/url/size/min-width
1398
+ */
1399
+ minWidth?: number;
1400
+ /**
1401
+ * Monochrome
1402
+ *
1403
+ * Applies a monochrome effect to the source image.
1404
+ *
1405
+ * Aliases: `mono`
1406
+ *
1407
+ * @see https://docs.imgix.com/apis/url/stylize/monochrome
1408
+ */
1409
+ monochrome?: string | ColorKeyword;
1410
+ /**
1411
+ * Monochrome
1412
+ *
1413
+ * Applies a monochrome effect to the source image.
1414
+ *
1415
+ * Alias for: `monochrome`
1416
+ *
1417
+ * @see https://docs.imgix.com/apis/url/stylize/monochrome
1418
+ */
1419
+ mono?: string | ColorKeyword;
1420
+ /**
1421
+ * Noise reduction bound
1422
+ *
1423
+ * Reduces the noise in an image.
1424
+ *
1425
+ * @defaultValue `20`
1426
+ *
1427
+ * @see https://docs.imgix.com/apis/url/noise-reduction/nr
1428
+ */
1429
+ nr?: number;
1430
+ /**
1431
+ * Noise reduction sharpen
1432
+ *
1433
+ * Provides a threshold by which to sharpen an image.
1434
+ *
1435
+ * @defaultValue `20`
1436
+ *
1437
+ * @see https://docs.imgix.com/apis/url/noise-reduction/nrs
1438
+ */
1439
+ nrs?: number;
1440
+ /**
1441
+ * Orientation
1442
+ *
1443
+ * Changes the image orientation.
1444
+ *
1445
+ * Aliases: `or`
1446
+ *
1447
+ * @see https://docs.imgix.com/apis/url/rotation/orient
1448
+ */
1449
+ orient?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 90 | 180 | 270;
1450
+ /**
1451
+ * Orientation
1452
+ *
1453
+ * Changes the image orientation.
1454
+ *
1455
+ * Alias for: `orient`
1456
+ *
1457
+ * @see https://docs.imgix.com/apis/url/rotation/orient
1458
+ */
1459
+ or?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 90 | 180 | 270;
1460
+ /**
1461
+ * Padding bottom
1462
+ *
1463
+ * Sets bottom padding of an image.
1464
+ *
1465
+ * @see https://docs.imgix.com/apis/url/border-and-padding/pad-bottom
1466
+ */
1467
+ padBottom?: number;
1468
+ /**
1469
+ * Padding left
1470
+ *
1471
+ * Sets left padding of an image.
1472
+ *
1473
+ * @see https://docs.imgix.com/apis/url/border-and-padding/pad-left
1474
+ */
1475
+ padLeft?: number;
1476
+ /**
1477
+ * Padding right
1478
+ *
1479
+ * Sets right padding of an image.
1480
+ *
1481
+ * @see https://docs.imgix.com/apis/url/border-and-padding/pad-right
1482
+ */
1483
+ padRight?: number;
1484
+ /**
1485
+ * Padding top
1486
+ *
1487
+ * Sets top padding of an image.
1488
+ *
1489
+ * @see https://docs.imgix.com/apis/url/border-and-padding/pad-top
1490
+ */
1491
+ padTop?: number;
1492
+ /**
1493
+ * Padding
1494
+ *
1495
+ * Pads an image.
1496
+ *
1497
+ * @defaultValue `0`
1498
+ *
1499
+ * @see https://docs.imgix.com/apis/url/border-and-padding/pad
1500
+ */
1501
+ pad?: number;
1502
+ /**
1503
+ * Pdf page number
1504
+ *
1505
+ * Selects a page from a PDF for display.
1506
+ *
1507
+ * @defaultValue `1`
1508
+ *
1509
+ * @see https://docs.imgix.com/apis/url/pdf/page
1510
+ */
1511
+ page?: number;
1512
+ /**
1513
+ * Color palette extraction
1514
+ *
1515
+ * Specifies an output format for palette-extraction.
1516
+ *
1517
+ * @see https://docs.imgix.com/apis/url/color-palette/palette
1518
+ */
1519
+ palette?: "css" | "json";
1520
+ /**
1521
+ * Pdf annotation
1522
+ *
1523
+ * Enables or disables PDF annotation.
1524
+ *
1525
+ * Aliases: `annotation`
1526
+ *
1527
+ * @defaultValue `true`
1528
+ *
1529
+ * @see https://docs.imgix.com/apis/url/pdf/pdf-annotation
1530
+ */
1531
+ pdfAnnotation?: boolean;
1532
+ /**
1533
+ * Pdf annotation
1534
+ *
1535
+ * Enables or disables PDF annotation.
1536
+ *
1537
+ * Alias for: `pdfAnnotation`
1538
+ *
1539
+ * @defaultValue `true`
1540
+ *
1541
+ * @see https://docs.imgix.com/apis/url/pdf/pdf-annotation
1542
+ */
1543
+ annotation?: boolean;
1544
+ /**
1545
+ * Css prefix
1546
+ *
1547
+ * Specifies a CSS prefix for all classes in palette-extraction.
1548
+ *
1549
+ * @defaultValue `"image"`
1550
+ *
1551
+ * @see https://docs.imgix.com/apis/url/color-palette/prefix
1552
+ */
1553
+ prefix?: string;
1554
+ /**
1555
+ * Pixellate
1556
+ *
1557
+ * Applies a pixelation effect to an image.
1558
+ *
1559
+ * @defaultValue `0`
1560
+ *
1561
+ * @see https://docs.imgix.com/apis/url/stylize/px
1562
+ */
1563
+ px?: number;
1564
+ /**
1565
+ * Output quality
1566
+ *
1567
+ * Adjusts the quality of an output image.
1568
+ *
1569
+ * @defaultValue `75`
1570
+ *
1571
+ * @see https://docs.imgix.com/apis/url/format/q
1572
+ */
1573
+ q?: number;
1574
+ /**
1575
+ * Source rectangle region
1576
+ *
1577
+ * Crops an image to a specified rectangle.
1578
+ *
1579
+ * @see https://docs.imgix.com/apis/url/size/rect
1580
+ */
1581
+ rect?: [
1582
+ number | "left" | "center" | "right",
1583
+ number | "top" | "middle" | "bottom",
1584
+ number,
1585
+ number
1586
+ ];
1587
+ /**
1588
+ * Rotation
1589
+ *
1590
+ * Rotates an image by a specified number of degrees.
1591
+ *
1592
+ * @defaultValue `0`
1593
+ *
1594
+ * @see https://docs.imgix.com/apis/url/rotation/rot
1595
+ */
1596
+ rot?: number;
1597
+ /**
1598
+ * Saturation
1599
+ *
1600
+ * Adjusts the saturation of an image.
1601
+ *
1602
+ * @defaultValue `0`
1603
+ *
1604
+ * @see https://docs.imgix.com/apis/url/adjustment/sat
1605
+ */
1606
+ sat?: number;
1607
+ /**
1608
+ * Sepia tone
1609
+ *
1610
+ * Applies a sepia effect to an image.
1611
+ *
1612
+ * @defaultValue `0`
1613
+ *
1614
+ * @see https://docs.imgix.com/apis/url/stylize/sepia
1615
+ */
1616
+ sepia?: number;
1617
+ /**
1618
+ * Shadow
1619
+ *
1620
+ * Adjusts the highlights of the source image.
1621
+ *
1622
+ * @defaultValue `0`
1623
+ *
1624
+ * @see https://docs.imgix.com/apis/url/adjustment/shad
1625
+ */
1626
+ shad?: number;
1627
+ /**
1628
+ * Sharpen
1629
+ *
1630
+ * Adjusts the sharpness of the source image.
1631
+ *
1632
+ * @defaultValue `0`
1633
+ *
1634
+ * @see https://docs.imgix.com/apis/url/adjustment/sharp
1635
+ */
1636
+ sharp?: number;
1637
+ /**
1638
+ * Transparency
1639
+ *
1640
+ * Adds checkerboard behind images which support transparency.
1641
+ *
1642
+ * @see https://docs.imgix.com/apis/url/fill/transparency
1643
+ */
1644
+ transparency?: "grid";
1645
+ /**
1646
+ * Trim color
1647
+ *
1648
+ * Specifies a trim color on a trim operation.
1649
+ *
1650
+ * Aliases: `trimcolor`
1651
+ *
1652
+ * @see https://docs.imgix.com/apis/url/trim/trim-color
1653
+ */
1654
+ trimColor?: string | ColorKeyword;
1655
+ /**
1656
+ * Trim color
1657
+ *
1658
+ * Specifies a trim color on a trim operation.
1659
+ *
1660
+ * Alias for: `trimColor`
1661
+ *
1662
+ * @see https://docs.imgix.com/apis/url/trim/trim-color
1663
+ */
1664
+ trimcolor?: string | ColorKeyword;
1665
+ /**
1666
+ * Trim mean difference
1667
+ *
1668
+ * Specifies the mean difference on a trim operation.
1669
+ *
1670
+ * Aliases: `trimmd`
1671
+ *
1672
+ * @defaultValue `11`
1673
+ *
1674
+ * @see https://docs.imgix.com/apis/url/trim/trim-md
1675
+ */
1676
+ trimMd?: number;
1677
+ /**
1678
+ * Trim mean difference
1679
+ *
1680
+ * Specifies the mean difference on a trim operation.
1681
+ *
1682
+ * Alias for: `trimMd`
1683
+ *
1684
+ * @defaultValue `11`
1685
+ *
1686
+ * @see https://docs.imgix.com/apis/url/trim/trim-md
1687
+ */
1688
+ trimmd?: number;
1689
+ /**
1690
+ * Trim padding
1691
+ *
1692
+ * Pads the area of the source image before trimming.
1693
+ *
1694
+ * Aliases: `trimpad`
1695
+ *
1696
+ * @defaultValue `0`
1697
+ *
1698
+ * @see https://docs.imgix.com/apis/url/trim/trim-pad
1699
+ */
1700
+ trimPad?: number;
1701
+ /**
1702
+ * Trim padding
1703
+ *
1704
+ * Pads the area of the source image before trimming.
1705
+ *
1706
+ * Alias for: `trimPad`
1707
+ *
1708
+ * @defaultValue `0`
1709
+ *
1710
+ * @see https://docs.imgix.com/apis/url/trim/trim-pad
1711
+ */
1712
+ trimpad?: number;
1713
+ /**
1714
+ * Trim standard deviation
1715
+ *
1716
+ * Specifies the standard deviation on a trim operation.
1717
+ *
1718
+ * Aliases: `trimsd`
1719
+ *
1720
+ * @defaultValue `10`
1721
+ *
1722
+ * @see https://docs.imgix.com/apis/url/trim/trim-sd
1723
+ */
1724
+ trimSd?: number;
1725
+ /**
1726
+ * Trim standard deviation
1727
+ *
1728
+ * Specifies the standard deviation on a trim operation.
1729
+ *
1730
+ * Alias for: `trimSd`
1731
+ *
1732
+ * @defaultValue `10`
1733
+ *
1734
+ * @see https://docs.imgix.com/apis/url/trim/trim-sd
1735
+ */
1736
+ trimsd?: number;
1737
+ /**
1738
+ * Trim tolerance
1739
+ *
1740
+ * Specifies the tolerance on a trim operation.
1741
+ *
1742
+ * Aliases: `trimtol`
1743
+ *
1744
+ * @defaultValue `0`
1745
+ *
1746
+ * @see https://docs.imgix.com/apis/url/trim/trim-tol
1747
+ */
1748
+ trimTol?: number;
1749
+ /**
1750
+ * Trim tolerance
1751
+ *
1752
+ * Specifies the tolerance on a trim operation.
1753
+ *
1754
+ * Alias for: `trimTol`
1755
+ *
1756
+ * @defaultValue `0`
1757
+ *
1758
+ * @see https://docs.imgix.com/apis/url/trim/trim-tol
1759
+ */
1760
+ trimtol?: number;
1761
+ /**
1762
+ * Trim image
1763
+ *
1764
+ * Trims the source image.
1765
+ *
1766
+ * @see https://docs.imgix.com/apis/url/trim/trim
1767
+ */
1768
+ trim?: "auto" | "color";
1769
+ /**
1770
+ * Text align
1771
+ *
1772
+ * Sets the vertical and horizontal alignment of rendered text relative to the
1773
+ * base image.
1774
+ *
1775
+ * Aliases: `txtalign`, `ta`
1776
+ *
1777
+ * @see https://docs.imgix.com/apis/url/text/txt-align
1778
+ */
1779
+ txtAlign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
1780
+ /**
1781
+ * Text align
1782
+ *
1783
+ * Sets the vertical and horizontal alignment of rendered text relative to the
1784
+ * base image.
1785
+ *
1786
+ * Alias for: `txtAlign`
1787
+ *
1788
+ * @see https://docs.imgix.com/apis/url/text/txt-align
1789
+ */
1790
+ txtalign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
1791
+ /**
1792
+ * Text align
1793
+ *
1794
+ * Sets the vertical and horizontal alignment of rendered text relative to the
1795
+ * base image.
1796
+ *
1797
+ * Alias for: `txtAlign`
1798
+ *
1799
+ * @see https://docs.imgix.com/apis/url/text/txt-align
1800
+ */
1801
+ ta?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
1802
+ /**
1803
+ * Text clipping mode
1804
+ *
1805
+ * Sets the clipping properties of rendered text.
1806
+ *
1807
+ * Aliases: `txtclip`, `tcl`
1808
+ *
1809
+ * @defaultValue `"end"`
1810
+ *
1811
+ * @see https://docs.imgix.com/apis/url/text/txt-clip
1812
+ */
1813
+ txtClip?: ("start" | "middle" | "end" | "ellipsis")[];
1814
+ /**
1815
+ * Text clipping mode
1816
+ *
1817
+ * Sets the clipping properties of rendered text.
1818
+ *
1819
+ * Alias for: `txtClip`
1820
+ *
1821
+ * @defaultValue `"end"`
1822
+ *
1823
+ * @see https://docs.imgix.com/apis/url/text/txt-clip
1824
+ */
1825
+ txtclip?: ("start" | "middle" | "end" | "ellipsis")[];
1826
+ /**
1827
+ * Text clipping mode
1828
+ *
1829
+ * Sets the clipping properties of rendered text.
1830
+ *
1831
+ * Alias for: `txtClip`
1832
+ *
1833
+ * @defaultValue `"end"`
1834
+ *
1835
+ * @see https://docs.imgix.com/apis/url/text/txt-clip
1836
+ */
1837
+ tcl?: ("start" | "middle" | "end" | "ellipsis")[];
1838
+ /**
1839
+ * Text color
1840
+ *
1841
+ * Specifies the color of rendered text.
1842
+ *
1843
+ * Aliases: `txtcolor`, `txtClr`, `txtclr`, `tc`
1844
+ *
1845
+ * @see https://docs.imgix.com/apis/url/text/txt-color
1846
+ */
1847
+ txtColor?: string | ColorKeyword;
1848
+ /**
1849
+ * Text color
1850
+ *
1851
+ * Specifies the color of rendered text.
1852
+ *
1853
+ * Alias for: `txtColor`
1854
+ *
1855
+ * @see https://docs.imgix.com/apis/url/text/txt-color
1856
+ */
1857
+ txtcolor?: string | ColorKeyword;
1858
+ /**
1859
+ * Text color
1860
+ *
1861
+ * Specifies the color of rendered text.
1862
+ *
1863
+ * Alias for: `txtColor`
1864
+ *
1865
+ * @see https://docs.imgix.com/apis/url/text/txt-color
1866
+ */
1867
+ txtClr?: string | ColorKeyword;
1868
+ /**
1869
+ * Text color
1870
+ *
1871
+ * Specifies the color of rendered text.
1872
+ *
1873
+ * Alias for: `txtColor`
1874
+ *
1875
+ * @see https://docs.imgix.com/apis/url/text/txt-color
1876
+ */
1877
+ txtclr?: string | ColorKeyword;
1878
+ /**
1879
+ * Text color
1880
+ *
1881
+ * Specifies the color of rendered text.
1882
+ *
1883
+ * Alias for: `txtColor`
1884
+ *
1885
+ * @see https://docs.imgix.com/apis/url/text/txt-color
1886
+ */
1887
+ tc?: string | ColorKeyword;
1888
+ /**
1889
+ * Text fit mode
1890
+ *
1891
+ * Specifies the fit approach for rendered text.
1892
+ *
1893
+ * Aliases: `txtfit`
1894
+ *
1895
+ * @see https://docs.imgix.com/apis/url/text/txt-fit
1896
+ */
1897
+ txtFit?: "max";
1898
+ /**
1899
+ * Text fit mode
1900
+ *
1901
+ * Specifies the fit approach for rendered text.
1902
+ *
1903
+ * Alias for: `txtFit`
1904
+ *
1905
+ * @see https://docs.imgix.com/apis/url/text/txt-fit
1906
+ */
1907
+ txtfit?: "max";
1908
+ /**
1909
+ * Text font
1910
+ *
1911
+ * Selects a font for rendered text.
1912
+ *
1913
+ * Aliases: `tf`, `txtfont`
1914
+ *
1915
+ * @see https://docs.imgix.com/apis/url/text/txt-font
1916
+ */
1917
+ txtFont?: Font;
1918
+ /**
1919
+ * Text font
1920
+ *
1921
+ * Selects a font for rendered text.
1922
+ *
1923
+ * Alias for: `txtFont`
1924
+ *
1925
+ * @see https://docs.imgix.com/apis/url/text/txt-font
1926
+ */
1927
+ tf?: Font;
1928
+ /**
1929
+ * Text font
1930
+ *
1931
+ * Selects a font for rendered text.
1932
+ *
1933
+ * Alias for: `txtFont`
1934
+ *
1935
+ * @see https://docs.imgix.com/apis/url/text/txt-font
1936
+ */
1937
+ txtfont?: Font;
1938
+ /**
1939
+ * Text leading
1940
+ *
1941
+ * Sets the leading (line spacing) for rendered text. Only works on the
1942
+ * multi-line text endpoint.
1943
+ *
1944
+ * Aliases: `txtlead`
1945
+ *
1946
+ * @defaultValue `0`
1947
+ *
1948
+ * @see https://docs.imgix.com/apis/url/typesetting/txt-lead
1949
+ */
1950
+ txtLead?: number;
1951
+ /**
1952
+ * Text leading
1953
+ *
1954
+ * Sets the leading (line spacing) for rendered text. Only works on the
1955
+ * multi-line text endpoint.
1956
+ *
1957
+ * Alias for: `txtLead`
1958
+ *
1959
+ * @defaultValue `0`
1960
+ *
1961
+ * @see https://docs.imgix.com/apis/url/typesetting/txt-lead
1962
+ */
1963
+ txtlead?: number;
1964
+ /**
1965
+ * Text ligatures
1966
+ *
1967
+ * Controls the level of ligature substitution
1968
+ *
1969
+ * Aliases: `txtlig`
1970
+ *
1971
+ * @see https://docs.imgix.com/apis/url/text/txt-lig
1972
+ */
1973
+ txtLig?: 0 | 1 | 2;
1974
+ /**
1975
+ * Text ligatures
1976
+ *
1977
+ * Controls the level of ligature substitution
1978
+ *
1979
+ * Alias for: `txtLig`
1980
+ *
1981
+ * @see https://docs.imgix.com/apis/url/text/txt-lig
1982
+ */
1983
+ txtlig?: 0 | 1 | 2;
1984
+ /**
1985
+ * Text outline color
1986
+ *
1987
+ * Specifies a text outline color.
1988
+ *
1989
+ * Aliases: `txtlinecolor`, `txtLineClr`, `txtlineclr`
1990
+ *
1991
+ * @defaultValue `"fff"`
1992
+ *
1993
+ * @see https://docs.imgix.com/apis/url/text/txt-line-color
1994
+ */
1995
+ txtLineColor?: string | ColorKeyword;
1996
+ /**
1997
+ * Text outline color
1998
+ *
1999
+ * Specifies a text outline color.
2000
+ *
2001
+ * Alias for: `txtLineColor`
2002
+ *
2003
+ * @defaultValue `"fff"`
2004
+ *
2005
+ * @see https://docs.imgix.com/apis/url/text/txt-line-color
2006
+ */
2007
+ txtlinecolor?: string | ColorKeyword;
2008
+ /**
2009
+ * Text outline color
2010
+ *
2011
+ * Specifies a text outline color.
2012
+ *
2013
+ * Alias for: `txtLineColor`
2014
+ *
2015
+ * @defaultValue `"fff"`
2016
+ *
2017
+ * @see https://docs.imgix.com/apis/url/text/txt-line-color
2018
+ */
2019
+ txtLineClr?: string | ColorKeyword;
2020
+ /**
2021
+ * Text outline color
2022
+ *
2023
+ * Specifies a text outline color.
2024
+ *
2025
+ * Alias for: `txtLineColor`
2026
+ *
2027
+ * @defaultValue `"fff"`
2028
+ *
2029
+ * @see https://docs.imgix.com/apis/url/text/txt-line-color
2030
+ */
2031
+ txtlineclr?: string | ColorKeyword;
2032
+ /**
2033
+ * Text outline
2034
+ *
2035
+ * Outlines the rendered text with a specified color.
2036
+ *
2037
+ * Aliases: `txtline`, `tl`
2038
+ *
2039
+ * @defaultValue `0`
2040
+ *
2041
+ * @see https://docs.imgix.com/apis/url/text/txt-line
2042
+ */
2043
+ txtLine?: number;
2044
+ /**
2045
+ * Text outline
2046
+ *
2047
+ * Outlines the rendered text with a specified color.
2048
+ *
2049
+ * Alias for: `txtLine`
2050
+ *
2051
+ * @defaultValue `0`
2052
+ *
2053
+ * @see https://docs.imgix.com/apis/url/text/txt-line
2054
+ */
2055
+ txtline?: number;
2056
+ /**
2057
+ * Text outline
2058
+ *
2059
+ * Outlines the rendered text with a specified color.
2060
+ *
2061
+ * Alias for: `txtLine`
2062
+ *
2063
+ * @defaultValue `0`
2064
+ *
2065
+ * @see https://docs.imgix.com/apis/url/text/txt-line
2066
+ */
2067
+ tl?: number;
2068
+ /**
2069
+ * Text padding
2070
+ *
2071
+ * Specifies the padding (in device-independent pixels) between a textbox and
2072
+ * the edges of the base image.
2073
+ *
2074
+ * Aliases: `txtpad`, `tp`
2075
+ *
2076
+ * @see https://docs.imgix.com/apis/url/text/txt-pad
2077
+ */
2078
+ txtPad?: number;
2079
+ /**
2080
+ * Text padding
2081
+ *
2082
+ * Specifies the padding (in device-independent pixels) between a textbox and
2083
+ * the edges of the base image.
2084
+ *
2085
+ * Alias for: `txtPad`
2086
+ *
2087
+ * @see https://docs.imgix.com/apis/url/text/txt-pad
2088
+ */
2089
+ txtpad?: number;
2090
+ /**
2091
+ * Text padding
2092
+ *
2093
+ * Specifies the padding (in device-independent pixels) between a textbox and
2094
+ * the edges of the base image.
2095
+ *
2096
+ * Alias for: `txtPad`
2097
+ *
2098
+ * @see https://docs.imgix.com/apis/url/text/txt-pad
2099
+ */
2100
+ tp?: number;
2101
+ /**
2102
+ * Text shadow
2103
+ *
2104
+ * Applies a shadow to rendered text.
2105
+ *
2106
+ * Aliases: `txtshad`, `tsh`
2107
+ *
2108
+ * @defaultValue `0`
2109
+ *
2110
+ * @see https://docs.imgix.com/apis/url/text/txt-shad
2111
+ */
2112
+ txtShad?: number;
2113
+ /**
2114
+ * Text shadow
2115
+ *
2116
+ * Applies a shadow to rendered text.
2117
+ *
2118
+ * Alias for: `txtShad`
2119
+ *
2120
+ * @defaultValue `0`
2121
+ *
2122
+ * @see https://docs.imgix.com/apis/url/text/txt-shad
2123
+ */
2124
+ txtshad?: number;
2125
+ /**
2126
+ * Text shadow
2127
+ *
2128
+ * Applies a shadow to rendered text.
2129
+ *
2130
+ * Alias for: `txtShad`
2131
+ *
2132
+ * @defaultValue `0`
2133
+ *
2134
+ * @see https://docs.imgix.com/apis/url/text/txt-shad
2135
+ */
2136
+ tsh?: number;
2137
+ /**
2138
+ * Text font size
2139
+ *
2140
+ * Sets the font size of rendered text.
2141
+ *
2142
+ * Aliases: `tsz`, `txtsize`
2143
+ *
2144
+ * @defaultValue `12`
2145
+ *
2146
+ * @see https://docs.imgix.com/apis/url/text/txt-size
2147
+ */
2148
+ txtSize?: number;
2149
+ /**
2150
+ * Text font size
2151
+ *
2152
+ * Sets the font size of rendered text.
2153
+ *
2154
+ * Alias for: `txtSize`
2155
+ *
2156
+ * @defaultValue `12`
2157
+ *
2158
+ * @see https://docs.imgix.com/apis/url/text/txt-size
2159
+ */
2160
+ tsz?: number;
2161
+ /**
2162
+ * Text font size
2163
+ *
2164
+ * Sets the font size of rendered text.
2165
+ *
2166
+ * Alias for: `txtSize`
2167
+ *
2168
+ * @defaultValue `12`
2169
+ *
2170
+ * @see https://docs.imgix.com/apis/url/text/txt-size
2171
+ */
2172
+ txtsize?: number;
2173
+ /**
2174
+ * Text tracking
2175
+ *
2176
+ * Sets the tracking (letter spacing) for rendered text. Only works on the
2177
+ * multi-line text endpoint.
2178
+ *
2179
+ * Aliases: `txttrack`, `tt`
2180
+ *
2181
+ * @defaultValue `0`
2182
+ *
2183
+ * @see https://docs.imgix.com/apis/url/typesetting/txt-track
2184
+ */
2185
+ txtTrack?: number;
2186
+ /**
2187
+ * Text tracking
2188
+ *
2189
+ * Sets the tracking (letter spacing) for rendered text. Only works on the
2190
+ * multi-line text endpoint.
2191
+ *
2192
+ * Alias for: `txtTrack`
2193
+ *
2194
+ * @defaultValue `0`
2195
+ *
2196
+ * @see https://docs.imgix.com/apis/url/typesetting/txt-track
2197
+ */
2198
+ txttrack?: number;
2199
+ /**
2200
+ * Text tracking
2201
+ *
2202
+ * Sets the tracking (letter spacing) for rendered text. Only works on the
2203
+ * multi-line text endpoint.
2204
+ *
2205
+ * Alias for: `txtTrack`
2206
+ *
2207
+ * @defaultValue `0`
2208
+ *
2209
+ * @see https://docs.imgix.com/apis/url/typesetting/txt-track
2210
+ */
2211
+ tt?: number;
2212
+ /**
2213
+ * Text width
2214
+ *
2215
+ * Sets the width of rendered text.
2216
+ *
2217
+ * Aliases: `txtwidth`
2218
+ *
2219
+ * @see https://docs.imgix.com/apis/url/text/txt-width
2220
+ */
2221
+ txtWidth?: number;
2222
+ /**
2223
+ * Text width
2224
+ *
2225
+ * Sets the width of rendered text.
2226
+ *
2227
+ * Alias for: `txtWidth`
2228
+ *
2229
+ * @see https://docs.imgix.com/apis/url/text/txt-width
2230
+ */
2231
+ txtwidth?: number;
2232
+ /**
2233
+ * Text string
2234
+ *
2235
+ * Sets the text string to render.
2236
+ *
2237
+ * Aliases: `t`
2238
+ *
2239
+ * @see https://docs.imgix.com/apis/url/text/txt
2240
+ */
2241
+ txt?: string;
2242
+ /**
2243
+ * Text string
2244
+ *
2245
+ * Sets the text string to render.
2246
+ *
2247
+ * Alias for: `txt`
2248
+ *
2249
+ * @see https://docs.imgix.com/apis/url/text/txt
2250
+ */
2251
+ t?: string;
2252
+ /**
2253
+ * Unsharp mask
2254
+ *
2255
+ * Sharpens the source image using an unsharp mask.
2256
+ *
2257
+ * @defaultValue `0`
2258
+ *
2259
+ * @see https://docs.imgix.com/apis/url/adjustment/usm
2260
+ */
2261
+ usm?: number;
2262
+ /**
2263
+ * Unsharp mask radius
2264
+ *
2265
+ * Specifies the radius for an unsharp mask operation.
2266
+ *
2267
+ * @defaultValue `2.5`
2268
+ *
2269
+ * @see https://docs.imgix.com/apis/url/adjustment/usmrad
2270
+ */
2271
+ usmrad?: number;
2272
+ /**
2273
+ * Vibrance
2274
+ *
2275
+ * Adjusts the vibrance of an image.
2276
+ *
2277
+ * @defaultValue `0`
2278
+ *
2279
+ * @see https://docs.imgix.com/apis/url/adjustment/vib
2280
+ */
2281
+ vib?: number;
2282
+ /**
2283
+ * Image width
2284
+ *
2285
+ * Adjusts the width of the output image.
2286
+ *
2287
+ * Aliases: `width`
2288
+ *
2289
+ * @see https://docs.imgix.com/apis/url/size/w
2290
+ */
2291
+ w?: number;
2292
+ /**
2293
+ * Image width
2294
+ *
2295
+ * Adjusts the width of the output image.
2296
+ *
2297
+ * Alias for: `w`
2298
+ *
2299
+ * @see https://docs.imgix.com/apis/url/size/w
2300
+ */
2301
+ width?: number;
2302
+ /**
2303
+ * Signed URL hash
2304
+ *
2305
+ * Secure a URL to prevent URL parameter changes. Note that this parameter
2306
+ * requires a secret token and should only be generated on a server.
2307
+ *
2308
+ * @see https://docs.imgix.com/setup/securing-images
2309
+ */
2310
+ s?: string;
2311
+ }
2312
+
2313
+ /**
2314
+ * Parameters for `buildPixelDensitySrcSet`.
2315
+ */
2316
+ declare type BuildPixelDensitySrcSetParams = Omit<ImgixURLParams, "dpr"> & {
2317
+ /**
2318
+ * The pixel densities to include in the resulting `srcset` value.
2319
+ *
2320
+ * @example
2321
+ *
2322
+ * ```ts
2323
+ * [1, 2, 3];
2324
+ * ```
2325
+ */
2326
+ pixelDensities: number[];
2327
+ };
2328
+ /**
2329
+ * Builds an `<img>` `srcset` attribute value for a given set of pixel
2330
+ * densities. It can also optinally apply Imgix URL API parameters to the URLs.
2331
+ *
2332
+ * The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`
2333
+ * parameter is provided to the `params` parameter, it will be ignored.
2334
+ *
2335
+ * @example
2336
+ *
2337
+ * ```ts
2338
+ * const srcset = buildPixelDensitySrcSet(
2339
+ * "https://example.imgix.net/image.png",
2340
+ * { pixelDensities: [1, 2, 3] },
2341
+ * );
2342
+ * // => https://example.imgix.net/image.png?dpr=1 1x,
2343
+ * // https://example.imgix.net/image.png?dpr=2 2x,
2344
+ * // https://example.imgix.net/image.png?dpr=3 3x
2345
+ * ```
2346
+ *
2347
+ * @example
2348
+ *
2349
+ * ```ts
2350
+ * const srcset = buildPixelDensitySrcSet(
2351
+ * "https://example.imgix.net/image.png",
2352
+ * {
2353
+ * pixelDensities: [1, 2, 3],
2354
+ * sat: -100,
2355
+ * },
2356
+ * );
2357
+ * // => https://example.imgix.net/image.png?dpr=1&sat=-100 1x,
2358
+ * // https://example.imgix.net/image.png?dpr=2&sat=-100 2x,
2359
+ * // https://example.imgix.net/image.png?dpr=3&sat=-100 3x
2360
+ * ```
2361
+ *
2362
+ * @param url - Full absolute URL to the Imgix image.
2363
+ * @param params - An object of Imgix URL API parameters. The `pixelDensities`
2364
+ * parameter defines the resulting `srcset` widths.
2365
+ *
2366
+ * @returns A `srcset` attribute value for `url` with the given Imgix URL API
2367
+ * parameters applied.
2368
+ */
2369
+ declare const buildPixelDensitySrcSet: (url: string, { pixelDensities, ...params }: BuildPixelDensitySrcSetParams) => string;
2370
+
2371
+ /**
2372
+ * Parameters for `buildWidthSrcSet`.
2373
+ */
2374
+ declare type BuildWidthSrcSetParams = Omit<ImgixURLParams, "width" | "w"> & {
2375
+ /**
2376
+ * The pixel widths to include in the resulting `srcset` value.
2377
+ *
2378
+ * @example
2379
+ *
2380
+ * ```ts
2381
+ * [400, 800, 1600];
2382
+ * ```
2383
+ */
2384
+ widths: number[];
2385
+ };
2386
+ /**
2387
+ * Builds an `<img>` `srcset` attribute value for a given set of widths. It can
2388
+ * also optinally apply Imgix URL API parameters to the URLs.
2389
+ *
2390
+ * The `width` URL parameter will be applied for each `srcset` entry. If a
2391
+ * `width` or `w` parameter is provided to the `params` parameter, it will be ignored.
2392
+ *
2393
+ * @example
2394
+ *
2395
+ * ```ts
2396
+ * const srcset = buildWidthSrcSet("https://example.imgix.net/image.png", {
2397
+ * widths: [400, 800, 1600],
2398
+ * });
2399
+ * // => https://example.imgix.net/image.png?width=400 400w,
2400
+ * // https://example.imgix.net/image.png?width=800 800w,
2401
+ * // https://example.imgix.net/image.png?width=1600 1600w
2402
+ * ```
2403
+ *
2404
+ * @example
2405
+ *
2406
+ * ```ts
2407
+ * const srcset = buildWidthSrcSet("https://example.imgix.net/image.png", {
2408
+ * widths: [400, 800, 1600],
2409
+ * sat: -100,
2410
+ * });
2411
+ * // => https://example.imgix.net/image.png?width=400&sat=-100 400w,
2412
+ * // https://example.imgix.net/image.png?width=800&sat=-100 800w,
2413
+ * // https://example.imgix.net/image.png?width=1600&sat=-100 1600w
2414
+ * ```
2415
+ *
2416
+ * @param url - Full absolute URL to the Imgix image.
2417
+ * @param params - An object of Imgix URL API parameters. The `widths` parameter
2418
+ * defines the resulting `srcset` widths.
2419
+ *
2420
+ * @returns A `srcset` attribute value for `url` with the given Imgix URL API
2421
+ * parameters applied.
2422
+ */
2423
+ declare const buildWidthSrcSet: (url: string, { widths, ...params }: BuildWidthSrcSetParams) => string;
2424
+
2425
+ /**
2426
+ * Options to instantiate a new client.
2427
+ */
2428
+ declare type ClientOptions = {
2429
+ /**
2430
+ * The base URL used to construct image URLs from a path. The base URL must
2431
+ * include the protocol, domain, and optionally a path.
2432
+ *
2433
+ * @example `https://example.imgix.net`
2434
+ *
2435
+ * @example `https://example.imgix.net/folder`
2436
+ */
2437
+ baseURL: string;
2438
+ };
2439
+ /**
2440
+ * An Imgix Rendering API client. A client is paired to a single Imgix domain.
2441
+ */
2442
+ declare class Client {
2443
+ baseURL: string;
2444
+ /**
2445
+ * Creates a new `Client` instance for an Imgix domain.
2446
+ *
2447
+ * @param options - Options to instantiate a new client.
2448
+ *
2449
+ * @returns A `Client` instance for the given Imgix domain.
2450
+ */
2451
+ constructor(options: ClientOptions);
2452
+ /**
2453
+ * Builds a URL to an Imgix image with Imgix URL API parameters for the
2454
+ * client's base URL.
2455
+ *
2456
+ * @example
2457
+ *
2458
+ * ```ts
2459
+ * const client = new Client({ baseURL: "https://example.imgix.net" });
2460
+ * const url = client.buildURLForPath("/image.png", { width: 400 });
2461
+ * // => https://example.imgix.net/image.png?width=400
2462
+ * ```
2463
+ *
2464
+ * @example
2465
+ *
2466
+ * ```ts
2467
+ * const client = new Client({
2468
+ * baseURL: "https://example.imgix.net/folder",
2469
+ * });
2470
+ * const url = client.buildURLForPath("./image.png", { width: 400 });
2471
+ * // => https://example.imgix.net/folder/image.png?width=400
2472
+ * ```
2473
+ *
2474
+ * @param path - Path to the image relative to the client's base URL.
2475
+ * @param params - An object of Imgix URL API parameters.
2476
+ *
2477
+ * @returns The full absolute URL to the image with the given Imgix URL API
2478
+ * parameters applied.
2479
+ */
2480
+ buildURLForPath(path: string, params?: ImgixURLParams): string;
2481
+ /**
2482
+ * Builds an `<img>` `srcset` attribute value for a given set of widths for
2483
+ * the client's base URL. It can also optinally apply Imgix URL API parameters
2484
+ * to the URLs.
2485
+ *
2486
+ * The `width` URL parameter will be applied for each `srcset` entry. If a
2487
+ * `width` or `w` parameter is provided to the `params` parameter, it will be ignored.
2488
+ *
2489
+ * @example
2490
+ *
2491
+ * ```ts
2492
+ * const client = new Client({ baseURL: "https://example.imgix.net" });
2493
+ * const srcset = client.buildWidthSrcSetForPath("/image.png", {
2494
+ * widths: [400, 800, 1600],
2495
+ * });
2496
+ * // => https://example.imgix.net/image.png?width=400 400w,
2497
+ * // https://example.imgix.net/image.png?width=800 800w,
2498
+ * // https://example.imgix.net/image.png?width=1600 1600w
2499
+ * ```
2500
+ *
2501
+ * @example
2502
+ *
2503
+ * ```ts
2504
+ * const client = new Client({
2505
+ * baseURL: "https://example.imgix.net",
2506
+ * });
2507
+ * const srcset = client.buildWidthSrcSetForPath("/image.png", {
2508
+ * widths: [400, 800, 1600],
2509
+ * sat: -100,
2510
+ * });
2511
+ * // => https://example.imgix.net/image.png?width=400&sat=-100 400w,
2512
+ * // https://example.imgix.net/image.png?width=800&sat=-100 800w,
2513
+ * // https://example.imgix.net/image.png?width=1600&sat=-100 1600w
2514
+ * ```
2515
+ *
2516
+ * @param path - Path to the image relative to the client's base URL.
2517
+ * @param params - An object of Imgix URL API parameters. The `widths`
2518
+ * parameter defines the resulting `srcset` widths.
2519
+ *
2520
+ * @returns A `srcset` attribute value for `url` with the given Imgix URL API
2521
+ * parameters applied.
2522
+ */
2523
+ buildWidthSrcSetForPath(path: string, params: BuildWidthSrcSetParams): string;
2524
+ /**
2525
+ * Builds an `<img>` `srcset` attribute value for a given set of pixel
2526
+ * densities for the client's base URL. It can also optinally apply Imgix URL
2527
+ * API parameters to the URLs.
2528
+ *
2529
+ * The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`
2530
+ * parameter is provided to the `params` parameter, it will be ignored.
2531
+ *
2532
+ * @example
2533
+ *
2534
+ * ```ts
2535
+ * const client = new Client({ baseURL: "https://example.imgix.net" });
2536
+ * const srcset = client.buildPixelDensitySrcSetForPath("/image.png", {
2537
+ * pixelDensities: [1, 2, 3],
2538
+ * });
2539
+ * // => https://example.imgix.net/image.png?dpr=1 1x,
2540
+ * // https://example.imgix.net/image.png?dpr=2 2x,
2541
+ * // https://example.imgix.net/image.png?dpr=3 3x
2542
+ * ```
2543
+ *
2544
+ * @example
2545
+ *
2546
+ * ```ts
2547
+ * const client = new Client({ baseURL: "https://example.imgix.net" });
2548
+ * const srcset = client.buildPixelDensitySrcSetForPath("/image.png", {
2549
+ * pixelDensities: [1, 2, 3],
2550
+ * sat: -100,
2551
+ * });
2552
+ * // => https://example.imgix.net/image.png?dpr=1&sat=-100 1x,
2553
+ * // https://example.imgix.net/image.png?dpr=2&sat=-100 2x,
2554
+ * // https://example.imgix.net/image.png?dpr=3&sat=-100 3x
2555
+ * ```
2556
+ *
2557
+ * @param path - Path to the image relative to the client's base URL.
2558
+ * @param params - An object of Imgix URL API parameters. The `pixelDensities`
2559
+ * parameter defines the resulting `srcset` widths.
2560
+ *
2561
+ * @returns A `srcset` attribute value for `url` with the given Imgix URL API
2562
+ * parameters applied.
2563
+ */
2564
+ buildPixelDensitySrcSetForPath(path: string, params: BuildPixelDensitySrcSetParams): string;
2565
+ }
2566
+
2567
+ /**
2568
+ * Builds a URL to an Imgix image with Imgix URL API parameters.
2569
+ *
2570
+ * The given URL must be a full absolute URL containing the protocol and domain.
2571
+ *
2572
+ * URL parameters already applied to the image will be retained. To remove
2573
+ * existing parameters, set the parameter to `undefined` in the `params` argument.
2574
+ *
2575
+ * @example
2576
+ *
2577
+ * ```ts
2578
+ * const url = buildURL("https://example.imgix.net/image.png", {
2579
+ * width: 400,
2580
+ * });
2581
+ * // => https://example.imgix.net/image.png?width=400
2582
+ * ```
2583
+ *
2584
+ * @example
2585
+ *
2586
+ * ```ts
2587
+ * const url = buildURL("https://example.imgix.net/image.png?width=400", {
2588
+ * height: 300,
2589
+ * });
2590
+ * // => https://example.imgix.net/image.png?width=400&height=300
2591
+ * ```
2592
+ *
2593
+ * @param url - Full absolute URL to the Imgix image.
2594
+ * @param params - An object of Imgix URL API parameters.
2595
+ *
2596
+ * @returns `url` with the given Imgix URL API parameters applied.
2597
+ *
2598
+ * @see Imgix URL API reference: https://docs.imgix.com/apis/rendering
2599
+ */
2600
+ declare const buildURL: (url: string, params: ImgixURLParams) => string;
2601
+
2602
+ export { BuildPixelDensitySrcSetParams, BuildWidthSrcSetParams, Client, ClientOptions, ColorKeyword, Font, ImgixURLParams, Ratio, buildPixelDensitySrcSet, buildURL, buildWidthSrcSet };