imgix-url-builder 0.0.3 → 0.0.4
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.
- package/dist/index.cjs +118 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +144 -12
- package/dist/index.js +118 -0
- package/dist/index.mjs +118 -0
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +457 -2
- package/dist/node/index.cjs.map +1 -1
- package/dist/node/index.d.ts +166 -23
- package/dist/node/index.mjs +457 -2
- package/dist/node/index.mjs.map +1 -1
- package/package.json +18 -18
- package/src/Client.ts +2 -1
- package/src/buildURL.ts +2 -1
- package/src/buildWidthSrcSet.ts +2 -1
- package/src/node/SecureClient.ts +14 -7
- package/src/node/buildSignedPixelDensitySrcSet.ts +4 -2
- package/src/node/buildSignedURL.ts +4 -2
- package/src/node/buildSignedWidthSrcSet.ts +4 -2
- package/src/types.generated.ts +656 -251
package/dist/node/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
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";
|
|
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}`;
|
|
4
5
|
interface ImgixURLParams {
|
|
5
6
|
/**
|
|
6
7
|
* Aspect ratio
|
|
@@ -18,6 +19,26 @@ interface ImgixURLParams {
|
|
|
18
19
|
* @see https://docs.imgix.com/apis/url/auto
|
|
19
20
|
*/
|
|
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;
|
|
21
42
|
/**
|
|
22
43
|
* Background color
|
|
23
44
|
*
|
|
@@ -684,7 +705,8 @@ interface ImgixURLParams {
|
|
|
684
705
|
/**
|
|
685
706
|
* Json face data
|
|
686
707
|
*
|
|
687
|
-
* Specifies that face data should be included in output when combined with
|
|
708
|
+
* Specifies that face data should be included in output when combined with
|
|
709
|
+
* `fm=json`.
|
|
688
710
|
*
|
|
689
711
|
* @see https://docs.imgix.com/apis/url/face-detection/faces
|
|
690
712
|
*/
|
|
@@ -692,7 +714,8 @@ interface ImgixURLParams {
|
|
|
692
714
|
/**
|
|
693
715
|
* Fill color
|
|
694
716
|
*
|
|
695
|
-
* Sets the fill color for images with additional space created by the fit
|
|
717
|
+
* Sets the fill color for images with additional space created by the fit
|
|
718
|
+
* setting
|
|
696
719
|
*
|
|
697
720
|
* Aliases: `fillcolor`
|
|
698
721
|
*
|
|
@@ -704,7 +727,8 @@ interface ImgixURLParams {
|
|
|
704
727
|
/**
|
|
705
728
|
* Fill color
|
|
706
729
|
*
|
|
707
|
-
* Sets the fill color for images with additional space created by the fit
|
|
730
|
+
* Sets the fill color for images with additional space created by the fit
|
|
731
|
+
* setting
|
|
708
732
|
*
|
|
709
733
|
* Alias for: `fillColor`
|
|
710
734
|
*
|
|
@@ -795,6 +819,18 @@ interface ImgixURLParams {
|
|
|
795
819
|
* @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-z
|
|
796
820
|
*/
|
|
797
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;
|
|
798
834
|
/**
|
|
799
835
|
* Gamma
|
|
800
836
|
*
|
|
@@ -805,6 +841,18 @@ interface ImgixURLParams {
|
|
|
805
841
|
* @see https://docs.imgix.com/apis/url/adjustment/gam
|
|
806
842
|
*/
|
|
807
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;
|
|
808
856
|
/**
|
|
809
857
|
* Grid colors
|
|
810
858
|
*
|
|
@@ -867,6 +915,12 @@ interface ImgixURLParams {
|
|
|
867
915
|
* @see https://docs.imgix.com/apis/url/adjustment/hue
|
|
868
916
|
*/
|
|
869
917
|
hue?: number;
|
|
918
|
+
/**
|
|
919
|
+
* Frame interval
|
|
920
|
+
*
|
|
921
|
+
* Displays every Nth frame starting with the first frame.
|
|
922
|
+
*/
|
|
923
|
+
interval?: number;
|
|
870
924
|
/**
|
|
871
925
|
* Invert
|
|
872
926
|
*
|
|
@@ -897,6 +951,15 @@ interface ImgixURLParams {
|
|
|
897
951
|
* Determine if IPTC data should be passed for JPEG images.
|
|
898
952
|
*/
|
|
899
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;
|
|
900
963
|
/**
|
|
901
964
|
* Lossless compression
|
|
902
965
|
*
|
|
@@ -1584,6 +1647,14 @@ interface ImgixURLParams {
|
|
|
1584
1647
|
number,
|
|
1585
1648
|
number
|
|
1586
1649
|
];
|
|
1650
|
+
/**
|
|
1651
|
+
* Reverse
|
|
1652
|
+
*
|
|
1653
|
+
* Reverses the frame order on the source animation.
|
|
1654
|
+
*
|
|
1655
|
+
* @defaultValue `false`
|
|
1656
|
+
*/
|
|
1657
|
+
reverse?: boolean;
|
|
1587
1658
|
/**
|
|
1588
1659
|
* Rotation
|
|
1589
1660
|
*
|
|
@@ -1634,6 +1705,12 @@ interface ImgixURLParams {
|
|
|
1634
1705
|
* @see https://docs.imgix.com/apis/url/adjustment/sharp
|
|
1635
1706
|
*/
|
|
1636
1707
|
sharp?: number;
|
|
1708
|
+
/**
|
|
1709
|
+
* Frame skip
|
|
1710
|
+
*
|
|
1711
|
+
* Skips every Nth frame starting with the first frame.
|
|
1712
|
+
*/
|
|
1713
|
+
skip?: number;
|
|
1637
1714
|
/**
|
|
1638
1715
|
* Transparency
|
|
1639
1716
|
*
|
|
@@ -2229,6 +2306,58 @@ interface ImgixURLParams {
|
|
|
2229
2306
|
* @see https://docs.imgix.com/apis/url/text/txt-width
|
|
2230
2307
|
*/
|
|
2231
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;
|
|
2232
2361
|
/**
|
|
2233
2362
|
* Text string
|
|
2234
2363
|
*
|
|
@@ -2316,7 +2445,8 @@ interface ImgixURLParams {
|
|
|
2316
2445
|
* The given URL must be a full absolute URL containing the protocol and domain.
|
|
2317
2446
|
*
|
|
2318
2447
|
* URL parameters already applied to the image will be retained. To remove
|
|
2319
|
-
* existing parameters, set the parameter to `undefined` in the `params`
|
|
2448
|
+
* existing parameters, set the parameter to `undefined` in the `params`
|
|
2449
|
+
* argument.
|
|
2320
2450
|
*
|
|
2321
2451
|
* @example
|
|
2322
2452
|
*
|
|
@@ -2348,7 +2478,7 @@ declare const buildURL: (url: string, params: ImgixURLParams) => string;
|
|
|
2348
2478
|
/**
|
|
2349
2479
|
* Parameters for `buildPixelDensitySrcSet`.
|
|
2350
2480
|
*/
|
|
2351
|
-
|
|
2481
|
+
type BuildPixelDensitySrcSetParams = Omit<ImgixURLParams, "dpr"> & {
|
|
2352
2482
|
/**
|
|
2353
2483
|
* The pixel densities to include in the resulting `srcset` value.
|
|
2354
2484
|
*
|
|
@@ -2364,7 +2494,7 @@ declare type BuildPixelDensitySrcSetParams = Omit<ImgixURLParams, "dpr"> & {
|
|
|
2364
2494
|
/**
|
|
2365
2495
|
* Parameters for `buildWidthSrcSet`.
|
|
2366
2496
|
*/
|
|
2367
|
-
|
|
2497
|
+
type BuildWidthSrcSetParams = Omit<ImgixURLParams, "width" | "w"> & {
|
|
2368
2498
|
/**
|
|
2369
2499
|
* The pixel widths to include in the resulting `srcset` value.
|
|
2370
2500
|
*
|
|
@@ -2380,7 +2510,7 @@ declare type BuildWidthSrcSetParams = Omit<ImgixURLParams, "width" | "w"> & {
|
|
|
2380
2510
|
/**
|
|
2381
2511
|
* Options to instantiate a new secure client.
|
|
2382
2512
|
*/
|
|
2383
|
-
|
|
2513
|
+
type SecureClientOptions = {
|
|
2384
2514
|
/**
|
|
2385
2515
|
* The base URL used to construct image URLs from a path. The base URL must
|
|
2386
2516
|
* include the protocol, domain, and optionally a path.
|
|
@@ -2524,10 +2654,12 @@ declare class SecureClient {
|
|
|
2524
2654
|
* signed by appending a signature to the URL parameters. This locks the URL
|
|
2525
2655
|
* and its parameters to the signature to prevent URL tampering.
|
|
2526
2656
|
*
|
|
2527
|
-
* The given URL must be a full absolute URL containing the protocol and
|
|
2657
|
+
* The given URL must be a full absolute URL containing the protocol and
|
|
2658
|
+
* domain.
|
|
2528
2659
|
*
|
|
2529
2660
|
* URL parameters already applied to the image will be retained. To remove
|
|
2530
|
-
* existing parameters, set the parameter to `undefined` in the `params`
|
|
2661
|
+
* existing parameters, set the parameter to `undefined` in the `params`
|
|
2662
|
+
* argument.
|
|
2531
2663
|
*
|
|
2532
2664
|
* @example
|
|
2533
2665
|
*
|
|
@@ -2560,7 +2692,8 @@ declare class SecureClient {
|
|
|
2560
2692
|
buildSignedURL(url: string, params?: ImgixURLParams): string;
|
|
2561
2693
|
/**
|
|
2562
2694
|
* Signs an Imgix image URL by appending a signature to the URL parameters.
|
|
2563
|
-
* This locks the URL and its parameters to the signature to prevent URL
|
|
2695
|
+
* This locks the URL and its parameters to the signature to prevent URL
|
|
2696
|
+
* tampering.
|
|
2564
2697
|
*
|
|
2565
2698
|
* @example
|
|
2566
2699
|
*
|
|
@@ -2585,7 +2718,8 @@ declare class SecureClient {
|
|
|
2585
2718
|
* URLs and their parameters to the signature to prevent URL tampering.
|
|
2586
2719
|
*
|
|
2587
2720
|
* The `width` URL parameter will be applied for each `srcset` entry. If a
|
|
2588
|
-
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
2721
|
+
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
2722
|
+
* ignored.
|
|
2589
2723
|
*
|
|
2590
2724
|
* @example
|
|
2591
2725
|
*
|
|
@@ -2628,7 +2762,8 @@ declare class SecureClient {
|
|
|
2628
2762
|
* to the URLs.
|
|
2629
2763
|
*
|
|
2630
2764
|
* The `width` URL parameter will be applied for each `srcset` entry. If a
|
|
2631
|
-
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
2765
|
+
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
2766
|
+
* ignored.
|
|
2632
2767
|
*
|
|
2633
2768
|
* Note: The returned URLs are not signed. See `buildSignedWidthSrcSet` if
|
|
2634
2769
|
* signatures are required.
|
|
@@ -2680,7 +2815,8 @@ declare class SecureClient {
|
|
|
2680
2815
|
* prevent URL tampering.
|
|
2681
2816
|
*
|
|
2682
2817
|
* The `width` URL parameter will be applied for each `srcset` entry. If a
|
|
2683
|
-
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
2818
|
+
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
2819
|
+
* ignored.
|
|
2684
2820
|
*
|
|
2685
2821
|
* @example
|
|
2686
2822
|
*
|
|
@@ -2725,7 +2861,8 @@ declare class SecureClient {
|
|
|
2725
2861
|
* Builds an `<img>` `srcset` attribute value for a given set of pixel
|
|
2726
2862
|
* densities. It can also optinally apply Imgix URL API parameters to the
|
|
2727
2863
|
* URLs. The URLs are signed by appending a signature to their URL parameters.
|
|
2728
|
-
* This locks the URLs and their parameters to the signature to prevent URL
|
|
2864
|
+
* This locks the URLs and their parameters to the signature to prevent URL
|
|
2865
|
+
* tampering.
|
|
2729
2866
|
*
|
|
2730
2867
|
* The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`
|
|
2731
2868
|
* parameter is provided to the `params` parameter, it will be ignored.
|
|
@@ -2878,7 +3015,8 @@ declare class SecureClient {
|
|
|
2878
3015
|
* The given URL must be a full absolute URL containing the protocol and domain.
|
|
2879
3016
|
*
|
|
2880
3017
|
* URL parameters already applied to the image will be retained. To remove
|
|
2881
|
-
* existing parameters, set the parameter to `undefined` in the `params`
|
|
3018
|
+
* existing parameters, set the parameter to `undefined` in the `params`
|
|
3019
|
+
* argument.
|
|
2882
3020
|
*
|
|
2883
3021
|
* **Important**: This function should only be used in a trusted environment and
|
|
2884
3022
|
* never in a browser. The `secureURLToken` parameter is a secret and should not
|
|
@@ -2907,7 +3045,8 @@ declare class SecureClient {
|
|
|
2907
3045
|
* ```
|
|
2908
3046
|
*
|
|
2909
3047
|
* @param url - Full absolute URL to the Imgix image.
|
|
2910
|
-
* @param secureURLToken - The secret secure URL token for the image's Imgix
|
|
3048
|
+
* @param secureURLToken - The secret secure URL token for the image's Imgix
|
|
3049
|
+
* source.
|
|
2911
3050
|
* @param params - An object of Imgix URL API parameters.
|
|
2912
3051
|
*
|
|
2913
3052
|
* @returns `url` with the given Imgix URL API parameters applied.
|
|
@@ -2924,7 +3063,8 @@ declare const buildSignedURL: (url: string, secureURLToken: string, params: Imgi
|
|
|
2924
3063
|
* and their parameters to the signature to prevent URL tampering.
|
|
2925
3064
|
*
|
|
2926
3065
|
* The `width` URL parameter will be applied for each `srcset` entry. If a
|
|
2927
|
-
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
3066
|
+
* `width` or `w` parameter is provided to the `params` parameter, it will be
|
|
3067
|
+
* ignored.
|
|
2928
3068
|
*
|
|
2929
3069
|
* **Important**: This function should only be used in a trusted environment and
|
|
2930
3070
|
* never in a browser. The `secureURLToken` parameter is a secret and should not
|
|
@@ -2960,7 +3100,8 @@ declare const buildSignedURL: (url: string, secureURLToken: string, params: Imgi
|
|
|
2960
3100
|
* ```
|
|
2961
3101
|
*
|
|
2962
3102
|
* @param url - Full absolute URL to the Imgix image.
|
|
2963
|
-
* @param secureURLToken - The secret secure URL token for the image's Imgix
|
|
3103
|
+
* @param secureURLToken - The secret secure URL token for the image's Imgix
|
|
3104
|
+
* source.
|
|
2964
3105
|
* @param params - An object of Imgix URL API parameters. The `widths` parameter
|
|
2965
3106
|
* defines the resulting `srcset` widths.
|
|
2966
3107
|
*
|
|
@@ -2973,7 +3114,8 @@ declare const buildSignedWidthSrcSet: (url: string, secureURLToken: string, { wi
|
|
|
2973
3114
|
* Builds an `<img>` `srcset` attribute value for a given set of pixel
|
|
2974
3115
|
* densities. It can also optinally apply Imgix URL API parameters to the URLs.
|
|
2975
3116
|
* The URLs are signed by appending a signature to their URL parameters. This
|
|
2976
|
-
* locks the URLs and their parameters to the signature to prevent URL
|
|
3117
|
+
* locks the URLs and their parameters to the signature to prevent URL
|
|
3118
|
+
* tampering.
|
|
2977
3119
|
*
|
|
2978
3120
|
* The `dpr` URL parameter will be applied for each `srcset` entry. If a `dpr`
|
|
2979
3121
|
* parameter is provided to the `params` parameter, it will be ignored.
|
|
@@ -3012,7 +3154,8 @@ declare const buildSignedWidthSrcSet: (url: string, secureURLToken: string, { wi
|
|
|
3012
3154
|
* ```
|
|
3013
3155
|
*
|
|
3014
3156
|
* @param url - Full absolute URL to the Imgix image.
|
|
3015
|
-
* @param secureURLToken - The secret secure URL token for the image's Imgix
|
|
3157
|
+
* @param secureURLToken - The secret secure URL token for the image's Imgix
|
|
3158
|
+
* source.
|
|
3016
3159
|
* @param params - An object of Imgix URL API parameters. The `pixelDensities`
|
|
3017
3160
|
* parameter defines the resulting `srcset` widths.
|
|
3018
3161
|
*
|