imgix-url-builder 0.0.4 → 0.0.6

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