UNPKG

imgix-url-builder

Version:

JavaScript/TypeScript Imgix URL builders for browsers and Node.js

2,285 lines (2,283 loc) 83.6 kB
// Types generated using `imgix-url-params` as a source. export type Ratio = `${number}:${number}`; export 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"; export type Font = | "AlBayan" | "AlBayan-Bold" | "AlNile" | "AlNile-Bold" | "AlTarikh" | "AmericanTypewriter" | "AmericanTypewriter-Bold" | "AmericanTypewriter-Condensed" | "AmericanTypewriter-CondensedBold" | "AmericanTypewriter-CondensedLight" | "AmericanTypewriter-Light" | "AmericanTypewriter-Semibold" | "AndaleMono" | "Apple-Chancery" | "AppleBraille" | "AppleBraille-Outline6Dot" | "AppleBraille-Outline8Dot" | "AppleBraille-Pinpoint6Dot" | "AppleBraille-Pinpoint8Dot" | "AppleColorEmoji" | "AppleGothic" | "AppleMyungjo" | "AppleSDGothicNeo-Bold" | "AppleSDGothicNeo-ExtraBold" | "AppleSDGothicNeo-Heavy" | "AppleSDGothicNeo-Light" | "AppleSDGothicNeo-Medium" | "AppleSDGothicNeo-Regular" | "AppleSDGothicNeo-SemiBold" | "AppleSDGothicNeo-Thin" | "AppleSDGothicNeo-UltraLight" | "AppleSymbols" | "AquaKana" | "AquaKana-Bold" | "Arial-Black" | "Arial-BoldItalicMT" | "Arial-BoldMT" | "Arial-ItalicMT" | "ArialHebrew" | "ArialHebrew-Bold" | "ArialHebrew-Light" | "ArialHebrewScholar" | "ArialHebrewScholar-Bold" | "ArialHebrewScholar-Light" | "ArialMT" | "ArialNarrow" | "ArialNarrow-Bold" | "ArialNarrow-BoldItalic" | "ArialNarrow-Italic" | "ArialRoundedMTBold" | "ArialUnicodeMS" | "Athelas-Bold" | "Athelas-BoldItalic" | "Athelas-Italic" | "Athelas-Regular" | "Avenir-Black" | "Avenir-BlackOblique" | "Avenir-Book" | "Avenir-BookOblique" | "Avenir-Heavy" | "Avenir-HeavyOblique" | "Avenir-Light" | "Avenir-LightOblique" | "Avenir-Medium" | "Avenir-MediumOblique" | "Avenir-Oblique" | "Avenir-Roman" | "AvenirNext-Bold" | "AvenirNext-BoldItalic" | "AvenirNext-DemiBold" | "AvenirNext-DemiBoldItalic" | "AvenirNext-Heavy" | "AvenirNext-HeavyItalic" | "AvenirNext-Italic" | "AvenirNext-Medium" | "AvenirNext-MediumItalic" | "AvenirNext-Regular" | "AvenirNext-UltraLight" | "AvenirNext-UltraLightItalic" | "AvenirNextCondensed-Bold" | "AvenirNextCondensed-BoldItalic" | "AvenirNextCondensed-DemiBold" | "AvenirNextCondensed-DemiBoldItalic" | "AvenirNextCondensed-Heavy" | "AvenirNextCondensed-HeavyItalic" | "AvenirNextCondensed-Italic" | "AvenirNextCondensed-Medium" | "AvenirNextCondensed-MediumItalic" | "AvenirNextCondensed-Regular" | "AvenirNextCondensed-UltraLight" | "AvenirNextCondensed-UltraLightItalic" | "Ayuthaya" | "BIZUDGothic-Bold" | "BIZUDGothic-Regular" | "BIZUDMincho-Regular" | "BIZUDPGothic-Bold" | "BIZUDPGothic-Regular" | "BIZUDPMincho-Regular" | "Baghdad" | "BanglaMN" | "BanglaMN-Bold" | "BanglaSangamMN" | "BanglaSangamMN-Bold" | "Baskerville" | "Baskerville-Bold" | "Baskerville-BoldItalic" | "Baskerville-Italic" | "Baskerville-SemiBold" | "Baskerville-SemiBoldItalic" | "Beirut" | "BigCaslon-Medium" | "BodoniOrnamentsITCTT" | "BodoniSvtyTwoITCTT-Bold" | "BodoniSvtyTwoITCTT-Book" | "BodoniSvtyTwoITCTT-BookIta" | "BodoniSvtyTwoOSITCTT-Bold" | "BodoniSvtyTwoOSITCTT-Book" | "BodoniSvtyTwoOSITCTT-BookIt" | "BodoniSvtyTwoSCITCTT-Book" | "BradleyHandITCTT-Bold" | "BrushScriptMT" | "C059-BdIta" | "C059-Bold" | "C059-Italic" | "C059-Roman" | "CenturySchL-Bold" | "CenturySchL-BoldItal" | "CenturySchL-Ital" | "CenturySchL-Roma" | "Chalkboard" | "Chalkboard-Bold" | "ChalkboardSE-Bold" | "ChalkboardSE-Light" | "ChalkboardSE-Regular" | "Chalkduster" | "Charter-Black" | "Charter-BlackItalic" | "Charter-Bold" | "Charter-BoldItalic" | "Charter-Italic" | "Charter-Roman" | "Cochin" | "Cochin-Bold" | "Cochin-BoldItalic" | "Cochin-Italic" | "ComicSansMS" | "ComicSansMS-Bold" | "Copperplate" | "Copperplate-Bold" | "Copperplate-Light" | "CorsivaHebrew" | "CorsivaHebrew-Bold" | "Courier" | "Courier-Bold" | "Courier-BoldOblique" | "Courier-Oblique" | "CourierNewPS-BoldItalicMT" | "CourierNewPS-BoldMT" | "CourierNewPS-ItalicMT" | "CourierNewPSMT" | "D050000L" | "DFWaWaSC-W5" | "DFWaWaTC-W5" | "DINAlternate-Bold" | "DINCondensed-Bold" | "Damascus" | "DamascusBold" | "DamascusLight" | "DamascusMedium" | "DamascusSemiBold" | "DecoTypeNaskh" | "DejaVuSans" | "DejaVuSans-Bold" | "DejaVuSansMono" | "DejaVuSansMono-Bold" | "DejaVuSerif" | "DejaVuSerif-Bold" | "DelaGothicOne-Regular" | "DevanagariMT" | "DevanagariMT-Bold" | "DevanagariSangamMN" | "DevanagariSangamMN-Bold" | "Didot" | "Didot-Bold" | "Didot-Italic" | "Dingbats" | "DiwanKufi" | "DiwanMishafi" | "DiwanMishafiGold" | "DiwanThuluth" | "DotGothic16-Regular" | "DroidSansFallback" | "EuphemiaUCAS" | "EuphemiaUCAS-Bold" | "EuphemiaUCAS-Italic" | "FZLTTHB--B51-0" | "FZLTTHK--GBK1-0" | "FZLTXHB--B51-0" | "FZLTXHK--GBK1-0" | "FZLTZHB--B51-0" | "FZLTZHK--GBK1-0" | "Farah" | "Farisi" | "FreeMono" | "FreeMonoBold" | "FreeMonoBoldOblique" | "FreeMonoOblique" | "FreeSans" | "FreeSansBold" | "FreeSansBoldOblique" | "FreeSansOblique" | "FreeSerif" | "FreeSerifBold" | "FreeSerifBoldItalic" | "FreeSerifItalic" | "Futura-Bold" | "Futura-CondensedExtraBold" | "Futura-CondensedMedium" | "Futura-Medium" | "Futura-MediumItalic" | "Galvji" | "Galvji-Bold" | "Galvji-BoldOblique" | "Galvji-Oblique" | "GeezaPro" | "GeezaPro-Bold" | "Geneva" | "Georgia" | "Georgia-Bold" | "Georgia-BoldItalic" | "Georgia-Italic" | "GillSans" | "GillSans-Bold" | "GillSans-BoldItalic" | "GillSans-Italic" | "GillSans-Light" | "GillSans-LightItalic" | "GillSans-SemiBold" | "GillSans-SemiBoldItalic" | "GillSans-UltraBold" | "GujaratiMT" | "GujaratiMT-Bold" | "GujaratiSangamMN" | "GujaratiSangamMN-Bold" | "GurmukhiMN" | "GurmukhiMN-Bold" | "GurmukhiSangamMN" | "GurmukhiSangamMN-Bold" | "HachiMaruPop-Regular" | "HannotateSC-W5" | "HannotateSC-W7" | "HannotateTC-W5" | "HannotateTC-W7" | "HanziPenSC-W3" | "HanziPenSC-W5" | "HanziPenTC-W3" | "HanziPenTC-W5" | "Helvetica" | "Helvetica-Bold" | "Helvetica-BoldOblique" | "Helvetica-Light" | "Helvetica-LightOblique" | "Helvetica-Oblique" | "HelveticaNeue" | "HelveticaNeue-Bold" | "HelveticaNeue-BoldItalic" | "HelveticaNeue-CondensedBlack" | "HelveticaNeue-CondensedBold" | "HelveticaNeue-Italic" | "HelveticaNeue-Light" | "HelveticaNeue-LightItalic" | "HelveticaNeue-Medium" | "HelveticaNeue-MediumItalic" | "HelveticaNeue-Thin" | "HelveticaNeue-ThinItalic" | "HelveticaNeue-UltraLight" | "HelveticaNeue-UltraLightItalic" | "Herculanum" | "HinaMincho-Regular" | "HiraKakuPro-W3" | "HiraKakuPro-W6" | "HiraKakuProN-W3" | "HiraKakuProN-W6" | "HiraKakuStd-W8" | "HiraKakuStdN-W8" | "HiraMaruPro-W4" | "HiraMaruProN-W4" | "HiraMinPro-W3" | "HiraMinPro-W6" | "HiraMinProN-W3" | "HiraMinProN-W6" | "HiraginoSans-W0" | "HiraginoSans-W1" | "HiraginoSans-W2" | "HiraginoSans-W3" | "HiraginoSans-W4" | "HiraginoSans-W5" | "HiraginoSans-W6" | "HiraginoSans-W7" | "HiraginoSans-W8" | "HiraginoSans-W9" | "HiraginoSansGB-W3" | "HiraginoSansGB-W6" | "HoeflerText-Black" | "HoeflerText-BlackItalic" | "HoeflerText-Italic" | "HoeflerText-Ornaments" | "HoeflerText-Regular" | "IBMPlexSansJP-Bold" | "IBMPlexSansJP-ExtraLight" | "IBMPlexSansJP-Light" | "IBMPlexSansJP-Medium" | "IBMPlexSansJP-Regular" | "IBMPlexSansJP-SemiBold" | "IBMPlexSansJP-Thin" | "ITFDevanagari-Bold" | "ITFDevanagari-Book" | "ITFDevanagari-Demi" | "ITFDevanagari-Light" | "ITFDevanagari-Medium" | "ITFDevanagariMarathi-Bold" | "ITFDevanagariMarathi-Book" | "ITFDevanagariMarathi-Demi" | "ITFDevanagariMarathi-Light" | "ITFDevanagariMarathi-Medium" | "Impact" | "InaiMathi" | "InaiMathi-Bold" | "IowanOldStyle-Black" | "IowanOldStyle-BlackItalic" | "IowanOldStyle-Bold" | "IowanOldStyle-BoldItalic" | "IowanOldStyle-Italic" | "IowanOldStyle-Roman" | "IowanOldStyle-Titling" | "JCHEadA" | "JCfg" | "JCkg" | "JCsmPC" | "Kailasa" | "Kailasa-Bold" | "KaiseiDecol-Bold" | "KaiseiDecol-Medium" | "KaiseiDecol-Regular" | "KaiseiHarunoUmi-Bold" | "KaiseiHarunoUmi-Medium" | "KaiseiHarunoUmi-Regular" | "KaiseiOpti-Bold" | "KaiseiOpti-Medium" | "KaiseiOpti-Regular" | "KaiseiTokumin-Bold" | "KaiseiTokumin-ExtraBold" | "KaiseiTokumin-Medium" | "KaiseiTokumin-Regular" | "KannadaMN" | "KannadaMN-Bold" | "KannadaSangamMN" | "KannadaSangamMN-Bold" | "Kefa-Bold" | "Kefa-Regular" | "KhmerMN" | "KhmerMN-Bold" | "KhmerSangamMN" | "KiwiMaru-Light" | "KiwiMaru-Medium" | "KiwiMaru-Regular" | "Klee-Demibold" | "Klee-Medium" | "KleeOne-Regular" | "KleeOne-SemiBold" | "KohinoorBangla-Bold" | "KohinoorBangla-Light" | "KohinoorBangla-Medium" | "KohinoorBangla-Regular" | "KohinoorBangla-Semibold" | "KohinoorDevanagari-Bold" | "KohinoorDevanagari-Light" | "KohinoorDevanagari-Medium" | "KohinoorDevanagari-Regular" | "KohinoorDevanagari-Semibold" | "KohinoorGujarati-Bold" | "KohinoorGujarati-Light" | "KohinoorGujarati-Medium" | "KohinoorGujarati-Regular" | "KohinoorGujarati-Semibold" | "KohinoorTelugu-Bold" | "KohinoorTelugu-Light" | "KohinoorTelugu-Medium" | "KohinoorTelugu-Regular" | "KohinoorTelugu-Semibold" | "Kokonor" | "Kosugi-Regular" | "KosugiMaru-Regular" | "Krungthep" | "KufiStandardGK" | "LaoMN" | "LaoMN-Bold" | "LaoSangamMN" | "LastResort" | "Lato-Black" | "Lato-BlackItalic" | "Lato-Bold" | "Lato-BoldItalic" | "Lato-Hairline" | "Lato-HairlineItalic" | "Lato-Heavy" | "Lato-HeavyItalic" | "Lato-Italic" | "Lato-Light" | "Lato-LightItalic" | "Lato-Medium" | "Lato-MediumItalic" | "Lato-Regular" | "Lato-Semibold" | "Lato-SemiboldItalic" | "Lato-Thin" | "Lato-ThinItalic" | "LiHeiPro" | "LiSongPro" | "LiberationMono" | "LiberationMono-Bold" | "LiberationMono-BoldItalic" | "LiberationMono-Italic" | "LiberationSans" | "LiberationSans-Bold" | "LiberationSans-BoldItalic" | "LiberationSans-Italic" | "LiberationSansNarrow" | "LiberationSansNarrow-Bold" | "LiberationSansNarrow-BoldItalic" | "LiberationSansNarrow-Italic" | "LiberationSerif" | "LiberationSerif-Bold" | "LiberationSerif-BoldItalic" | "LiberationSerif-Italic" | "LucidaGrande" | "LucidaGrande-Bold" | "Luminari-Regular" | "MPLUS1-Black" | "MPLUS1-Bold" | "MPLUS1-ExtraBold" | "MPLUS1-ExtraLight" | "MPLUS1-Light" | "MPLUS1-Medium" | "MPLUS1-Regular" | "MPLUS1-SemiBold" | "MPLUS1-Thin" | "MPLUS1Code-Bold" | "MPLUS1Code-ExtraLight" | "MPLUS1Code-Light" | "MPLUS1Code-Medium" | "MPLUS1Code-Regular" | "MPLUS1Code-SemiBold" | "MPLUS1Code-Thin" | "MPLUS1p-Black" | "MPLUS1p-Bold" | "MPLUS1p-ExtraBold" | "MPLUS1p-Light" | "MPLUS1p-Medium" | "MPLUS1p-Regular" | "MPLUS1p-Thin" | "MPLUS2-Black" | "MPLUS2-Bold" | "MPLUS2-ExtraBold" | "MPLUS2-ExtraLight" | "MPLUS2-Light" | "MPLUS2-Medium" | "MPLUS2-Regular" | "MPLUS2-SemiBold" | "MPLUS2-Thin" | "MalayalamMN" | "MalayalamMN-Bold" | "MalayalamSangamMN" | "MalayalamSangamMN-Bold" | "Marion-Bold" | "Marion-Italic" | "Marion-Regular" | "MarkerFelt-Thin" | "MarkerFelt-Wide" | "Menlo-Bold" | "Menlo-BoldItalic" | "Menlo-Italic" | "Menlo-Regular" | "MicrosoftSansSerif" | "MochiyPopOne-Regular" | "MochiyPopPOne-Regular" | "Monaco" | "MonotypeGurmukhi" | "Mshtakan" | "MshtakanBold" | "MshtakanBoldOblique" | "MshtakanOblique" | "MuktaMahee-Bold" | "MuktaMahee-ExtraBold" | "MuktaMahee-ExtraLight" | "MuktaMahee-Light" | "MuktaMahee-Medium" | "MuktaMahee-Regular" | "MuktaMahee-SemiBold" | "Muna" | "MunaBlack" | "MunaBold" | "Murecho-Black" | "Murecho-Bold" | "Murecho-ExtraBold" | "Murecho-ExtraLight" | "Murecho-Light" | "Murecho-Medium" | "Murecho-Regular" | "Murecho-SemiBold" | "Murecho-Thin" | "MyanmarMN" | "MyanmarMN-Bold" | "MyanmarSangamMN" | "MyanmarSangamMN-Bold" | "Nadeem" | "NanumBrush" | "NanumGothic" | "NanumGothicBold" | "NanumGothicExtraBold" | "NanumMyeongjo" | "NanumMyeongjoBold" | "NanumMyeongjoExtraBold" | "NanumPen" | "NewPeninimMT" | "NewPeninimMT-Bold" | "NewPeninimMT-BoldInclined" | "NewPeninimMT-Inclined" | "NewTegomin-Regular" | "NimbusMonL-Bold" | "NimbusMonL-BoldObli" | "NimbusMonL-Regu" | "NimbusMonL-ReguObli" | "NimbusMonoPS-Bold" | "NimbusMonoPS-BoldItalic" | "NimbusMonoPS-Italic" | "NimbusMonoPS-Regular" | "NimbusRomNo9L-Medi" | "NimbusRomNo9L-MediItal" | "NimbusRomNo9L-Regu" | "NimbusRomNo9L-ReguItal" | "NimbusRoman-Bold" | "NimbusRoman-BoldItalic" | "NimbusRoman-Italic" | "NimbusRoman-Regular" | "NimbusSanL-Bold" | "NimbusSanL-BoldCond" | "NimbusSanL-BoldCondItal" | "NimbusSanL-BoldItal" | "NimbusSanL-Regu" | "NimbusSanL-ReguCond" | "NimbusSanL-ReguCondItal" | "NimbusSanL-ReguItal" | "NimbusSans-Bold" | "NimbusSans-BoldItalic" | "NimbusSans-Italic" | "NimbusSans-Regular" | "NimbusSansNarrow-Bold" | "NimbusSansNarrow-BoldOblique" | "NimbusSansNarrow-Oblique" | "NimbusSansNarrow-Regular" | "Noteworthy-Bold" | "Noteworthy-Light" | "NotoMono" | "NotoNastaliqUrdu" | "NotoNastaliqUrdu-Bold" | "NotoSansArmenian-Black" | "NotoSansArmenian-Bold" | "NotoSansArmenian-ExtraBold" | "NotoSansArmenian-ExtraLight" | "NotoSansArmenian-Light" | "NotoSansArmenian-Medium" | "NotoSansArmenian-Regular" | "NotoSansArmenian-SemiBold" | "NotoSansArmenian-Thin" | "NotoSansAvestan-Regular" | "NotoSansBamum-Regular" | "NotoSansBatak-Regular" | "NotoSansBrahmi-Regular" | "NotoSansBuginese-Regular" | "NotoSansBuhid-Regular" | "NotoSansCarian-Regular" | "NotoSansChakma-Regular" | "NotoSansCham-Regular" | "NotoSansCoptic-Regular" | "NotoSansCuneiform-Regular" | "NotoSansCypriot-Regular" | "NotoSansEgyptianHieroglyphs-Regular" | "NotoSansGlagolitic-Regular" | "NotoSansGothic-Regular" | "NotoSansHanunoo-Regular" | "NotoSansImperialAramaic-Regular" | "NotoSansInscriptionalPahlavi-Regular" | "NotoSansInscriptionalParthian-Regular" | "NotoSansJP-Black" | "NotoSansJP-Bold" | "NotoSansJP-Light" | "NotoSansJP-Medium" | "NotoSansJP-Regular" | "NotoSansJP-Thin" | "NotoSansJavanese-Regular" | "NotoSansKaithi-Regular" | "NotoSansKannada-Black" | "NotoSansKannada-Bold" | "NotoSansKannada-ExtraBold" | "NotoSansKannada-ExtraLight" | "NotoSansKannada-Light" | "NotoSansKannada-Medium" | "NotoSansKannada-Regular" | "NotoSansKannada-SemiBold" | "NotoSansKannada-Thin" | "NotoSansKayahLi-Regular" | "NotoSansKharoshthi-Regular" | "NotoSansLepcha-Regular" | "NotoSansLimbu-Regular" | "NotoSansLinearB-Regular" | "NotoSansLisu-Regular" | "NotoSansLycian-Regular" | "NotoSansLydian-Regular" | "NotoSansMandaic-Regular" | "NotoSansMeeteiMayek-Regular" | "NotoSansMongolian" | "NotoSansMyanmar-Black" | "NotoSansMyanmar-Bold" | "NotoSansMyanmar-ExtraBold" | "NotoSansMyanmar-ExtraLight" | "NotoSansMyanmar-Light" | "NotoSansMyanmar-Medium" | "NotoSansMyanmar-Regular" | "NotoSansMyanmar-SemiBold" | "NotoSansMyanmar-Thin" | "NotoSansNKo-Regular" | "NotoSansNewTaiLue-Regular" | "NotoSansOgham-Regular" | "NotoSansOlChiki-Regular" | "NotoSansOldItalic-Regular" | "NotoSansOldPersian-Regular" | "NotoSansOldSouthArabian-Regular" | "NotoSansOldTurkic-Regular" | "NotoSansOriya" | "NotoSansOriya-Bold" | "NotoSansOsmanya-Regular" | "NotoSansPhagsPa-Regular" | "NotoSansPhoenician-Regular" | "NotoSansRejang-Regular" | "NotoSansRunic-Regular" | "NotoSansSamaritan-Regular" | "NotoSansSaurashtra-Regular" | "NotoSansShavian-Regular" | "NotoSansSundanese-Regular" | "NotoSansSylotiNagri-Regular" | "NotoSansSyriac-Regular" | "NotoSansTagalog-Regular" | "NotoSansTagbanwa-Regular" | "NotoSansTaiLe-Regular" | "NotoSansTaiTham" | "NotoSansTaiViet-Regular" | "NotoSansThaana-Regular" | "NotoSansTifinagh-Regular" | "NotoSansUgaritic-Regular" | "NotoSansVai-Regular" | "NotoSansYi-Regular" | "NotoSansZawgyi-Black" | "NotoSansZawgyi-Bold" | "NotoSansZawgyi-ExtraBold" | "NotoSansZawgyi-ExtraLight" | "NotoSansZawgyi-Light" | "NotoSansZawgyi-Medium" | "NotoSansZawgyi-Regular" | "NotoSansZawgyi-SemiBold" | "NotoSansZawgyi-Thin" | "NotoSerifBalinese-Regular" | "NotoSerifJP-Black" | "NotoSerifJP-Bold" | "NotoSerifJP-ExtraLight" | "NotoSerifJP-Light" | "NotoSerifJP-Medium" | "NotoSerifJP-Regular" | "NotoSerifJP-SemiBold" | "NotoSerifMyanmar-Black" | "NotoSerifMyanmar-Bold" | "NotoSerifMyanmar-ExtraBold" | "NotoSerifMyanmar-ExtraLight" | "NotoSerifMyanmar-Light" | "NotoSerifMyanmar-Medium" | "NotoSerifMyanmar-Regular" | "NotoSerifMyanmar-SemiBold" | "NotoSerifMyanmar-Thin" | "Optima-Bold" | "Optima-BoldItalic" | "Optima-ExtraBlack" | "Optima-Italic" | "Optima-Regular" | "OriyaMN" | "OriyaMN-Bold" | "OriyaSangamMN" | "OriyaSangamMN-Bold" | "Osaka" | "Osaka-Mono" | "P052-Bold" | "P052-BoldItalic" | "P052-Italic" | "P052-Roman" | "PTMono-Bold" | "PTMono-Regular" | "PTSans-Bold" | "PTSans-BoldItalic" | "PTSans-Caption" | "PTSans-CaptionBold" | "PTSans-Italic" | "PTSans-Narrow" | "PTSans-NarrowBold" | "PTSans-Regular" | "PTSerif-Bold" | "PTSerif-BoldItalic" | "PTSerif-Caption" | "PTSerif-CaptionItalic" | "PTSerif-Italic" | "PTSerif-Regular" | "Palatino-Bold" | "Palatino-BoldItalic" | "Palatino-Italic" | "Palatino-Roman" | "Papyrus" | "Papyrus-Condensed" | "Phosphate-Inline" | "Phosphate-Solid" | "PingFangHK-Light" | "PingFangHK-Medium" | "PingFangHK-Regular" | "PingFangHK-Semibold" | "PingFangHK-Thin" | "PingFangHK-Ultralight" | "PingFangSC-Light" | "PingFangSC-Medium" | "PingFangSC-Regular" | "PingFangSC-Semibold" | "PingFangSC-Thin" | "PingFangSC-Ultralight" | "PingFangTC-Light" | "PingFangTC-Medium" | "PingFangTC-Regular" | "PingFangTC-Semibold" | "PingFangTC-Thin" | "PingFangTC-Ultralight" | "PlantagenetCherokee" | "PottaOne-Regular" | "Raanana" | "RaananaBold" | "RampartOne-Regular" | "ReggaeOne-Regular" | "RocknRollOne-Regular" | "Rockwell-Bold" | "Rockwell-BoldItalic" | "Rockwell-Italic" | "Rockwell-Regular" | "RoundedMplus1c-Black" | "RoundedMplus1c-Bold" | "RoundedMplus1c-ExtraBold" | "RoundedMplus1c-Light" | "RoundedMplus1c-Medium" | "RoundedMplus1c-Regular" | "RoundedMplus1c-Thin" | "STBaoli-SC-Regular" | "STFangsong" | "STHeiti" | "STHeitiSC-Light" | "STHeitiSC-Medium" | "STHeitiTC-Light" | "STHeitiTC-Medium" | "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" | "STKaiTi-TC-Bold" | "STKaiTi-TC-Regular" | "STKaiti" | "STKaiti-SC-Black" | "STKaiti-SC-Bold" | "STKaiti-SC-Regular" | "STLibian-SC-Regular" | "STSong" | "STSongti-SC-Black" | "STSongti-SC-Bold" | "STSongti-SC-Light" | "STSongti-SC-Regular" | "STSongti-TC-Bold" | "STSongti-TC-Light" | "STSongti-TC-Regular" | "STXihei" | "STXingkai-SC-Bold" | "STXingkai-SC-Light" | "STYuanti-SC-Bold" | "STYuanti-SC-Light" | "STYuanti-SC-Regular" | "STYuanti-TC-Bold" | "STYuanti-TC-Light" | "STYuanti-TC-Regular" | "Sana" | "Sathu" | "SavoyeLetPlain" | "SawarabiGothic-Regular" | "SawarabiMincho-Regular" | "Seravek" | "Seravek-Bold" | "Seravek-BoldItalic" | "Seravek-ExtraLight" | "Seravek-ExtraLightItalic" | "Seravek-Italic" | "Seravek-Light" | "Seravek-LightItalic" | "Seravek-Medium" | "Seravek-MediumItalic" | "ShipporiAntique-Regular" | "ShipporiAntiqueB1-Regular" | "ShipporiMincho-Bold" | "ShipporiMincho-ExtraBold" | "ShipporiMincho-Medium" | "ShipporiMincho-Regular" | "ShipporiMincho-SemiBold" | "ShipporiMinchoB1-Bold" | "ShipporiMinchoB1-ExtraBold" | "ShipporiMinchoB1-Medium" | "ShipporiMinchoB1-Regular" | "ShipporiMinchoB1-SemiBold" | "ShreeDev0714" | "ShreeDev0714-Bold" | "ShreeDev0714-BoldItalic" | "ShreeDev0714-Italic" | "SignPainter-HouseScript" | "SignPainter-HouseScriptSemibold" | "Silom" | "SinhalaMN" | "SinhalaMN-Bold" | "SinhalaSangamMN" | "SinhalaSangamMN-Bold" | "Skia-Black" | "Skia-BlackCondensed" | "Skia-BlackExtended" | "Skia-Bold" | "Skia-Condensed" | "Skia-Extended" | "Skia-Light" | "Skia-LightCondensed" | "Skia-LightExtended" | "Skia-Regular" | "SnellRoundhand" | "SnellRoundhand-Black" | "SnellRoundhand-Bold" | "StandardSymL" | "StandardSymbolsPS" | "Stick-Regular" | "SukhumvitSet-Bold" | "SukhumvitSet-Light" | "SukhumvitSet-Medium" | "SukhumvitSet-SemiBold" | "SukhumvitSet-Text" | "SukhumvitSet-Thin" | "Superclarendon-Black" | "Superclarendon-BlackItalic" | "Superclarendon-Bold" | "Superclarendon-BoldItalic" | "Superclarendon-Italic" | "Superclarendon-Light" | "Superclarendon-LightItalic" | "Superclarendon-Regular" | "Symbol" | "Tahoma" | "Tahoma-Bold" | "TamilMN" | "TamilMN-Bold" | "TamilSangamMN" | "TamilSangamMN-Bold" | "TeluguMN" | "TeluguMN-Bold" | "TeluguSangamMN" | "TeluguSangamMN-Bold" | "Thonburi" | "Thonburi-Bold" | "Thonburi-Light" | "Times-Bold" | "Times-BoldItalic" | "Times-Italic" | "Times-Roman" | "TimesNewRomanPS-BoldItalicMT" | "TimesNewRomanPS-BoldMT" | "TimesNewRomanPS-ItalicMT" | "TimesNewRomanPSMT" | "TrainOne-Regular" | "Trattatello" | "Trebuchet-BoldItalic" | "TrebuchetMS" | "TrebuchetMS-Bold" | "TrebuchetMS-Italic" | "TsukuARdGothic-Bold" | "TsukuARdGothic-Regular" | "TsukuBRdGothic-Bold" | "TsukuBRdGothic-Regular" | "URWBookman-Demi" | "URWBookman-DemiItalic" | "URWBookman-Light" | "URWBookman-LightItalic" | "URWBookmanL-DemiBold" | "URWBookmanL-DemiBoldItal" | "URWBookmanL-Ligh" | "URWBookmanL-LighItal" | "URWChanceryL-MediItal" | "URWGothic-Book" | "URWGothic-BookOblique" | "URWGothic-Demi" | "URWGothic-DemiOblique" | "URWGothicL-Book" | "URWGothicL-BookObli" | "URWGothicL-Demi" | "URWGothicL-DemiObli" | "URWPalladioL-Bold" | "URWPalladioL-BoldItal" | "URWPalladioL-Ital" | "URWPalladioL-Roma" | "Verdana" | "Verdana-Bold" | "Verdana-BoldItalic" | "Verdana-Italic" | "Waseem" | "WaseemLight" | "Webdings" | "Weibei-SC-Bold" | "Weibei-TC-Bold" | "Wingdings-Regular" | "Wingdings2" | "Wingdings3" | "Yomogi-Regular" | "YuGo-Bold" | "YuGo-Medium" | "YuMin-Demibold" | "YuMin-Medium" | "YuMin_36pKn-Demibold" | "YuMin_36pKn-Medium" | "YujiBoku-Regular" | "YujiMai-Regular" | "YujiSyuku-Regular" | "YuppySC-Regular" | "YuppyTC-Regular" | "YuseiMagic-Regular" | "Z003-MediumItalic" | "ZapfDingbatsITC" | "Zapfino" | "ZenAntique-Regular" | "ZenAntiqueSoft-Regular" | "ZenKakuGothicAntique-Black" | "ZenKakuGothicAntique-Bold" | "ZenKakuGothicAntique-Light" | "ZenKakuGothicAntique-Medium" | "ZenKakuGothicAntique-Regular" | "ZenKakuGothicNew-Black" | "ZenKakuGothicNew-Bold" | "ZenKakuGothicNew-Light" | "ZenKakuGothicNew-Medium" | "ZenKakuGothicNew-Regular" | "ZenKurenaido-Regular" | "ZenMaruGothic-Black" | "ZenMaruGothic-Bold" | "ZenMaruGothic-Light" | "ZenMaruGothic-Medium" | "ZenMaruGothic-Regular" | "ZenOldMincho-Black" | "ZenOldMincho-Bold" | "ZenOldMincho-Medium" | "ZenOldMincho-Regular" | "ZenOldMincho-SemiBold"; export type Range = `${number}-${number}` | `${number}-` | `-${number}`; export interface ImgixURLParams { /** * Aspect ratio * * Specifies an aspect ratio to maintain when resizing and cropping the image * * @see https://docs.imgix.com/apis/url/size/ar */ ar?: Ratio; /** * Automatic * * Applies automatic enhancements to images. * * @see https://docs.imgix.com/apis/url/auto */ auto?: ("enhance" | "format" | "redeye" | "compress" | "true")[]; /** * Background removal fallback * * Overrides default fallback behavior for bg-remove failures. * * @defaultValue `true` * * @see https://docs.imgix.com/apis/rendering/background/bg-remove */ bgRemoveFallback?: boolean; /** * Background removal * * Removes background from image. * * Aliases: `backgroundRemove` * * @defaultValue `false` * * @see https://docs.imgix.com/apis/rendering/background/bg-remove */ bgRemove?: boolean; /** * Background removal * * Removes background from image. * * Alias for: `bgRemove` * * @defaultValue `false` * * @see https://docs.imgix.com/apis/rendering/background/bg-remove */ backgroundRemove?: boolean; /** * Background removal fallback * * Overrides default fallback behavior for bg-replace failures. * * @defaultValue `true` * * @see https://docs.imgix.com/apis/rendering/background/bg-replace */ bgReplaceFallback?: boolean; /** * Background replacement negative prompt * * Provides a negative text suggestion for background replacement. * * Aliases: `backgroundReplaceNegativePrompt` * * @defaultValue `false` * * @see https://docs.imgix.com/apis/rendering/background/bg-replace-neg-prompt */ bgReplaceNegPrompt?: string; /** * Background replacement negative prompt * * Provides a negative text suggestion for background replacement. * * Alias for: `bgReplaceNegPrompt` * * @defaultValue `false` * * @see https://docs.imgix.com/apis/rendering/background/bg-replace-neg-prompt */ backgroundReplaceNegativePrompt?: string; /** * Background replacement * * Replaces background from image using a string based prompt. * * Aliases: `backgroundReplace` * * @defaultValue `false` * * @see https://docs.imgix.com/apis/rendering/background/bg-replace */ bgReplace?: string; /** * Background replacement * * Replaces background from image using a string based prompt. * * Alias for: `bgReplace` * * @defaultValue `false` * * @see https://docs.imgix.com/apis/rendering/background/bg-replace */ backgroundReplace?: string; /** * Background color * * Colors the background of padded and partially-transparent images. * * @defaultValue `"fff"` * * @see https://docs.imgix.com/apis/url/bg */ bg?: string | ColorKeyword; /** * Blend align * * Changes the blend alignment relative to the parent image. * * Aliases: `blendalign`, `ba` * * @see https://docs.imgix.com/apis/url/blending/blend-align */ blendAlign?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[]; /** * Blend align * * Changes the blend alignment relative to the parent image. * * Alias for: `blendAlign` * * @see https://docs.imgix.com/apis/url/blending/blend-align */ blendalign?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[]; /** * Blend align * * Changes the blend alignment relative to the parent image. * * Alias for: `blendAlign` * * @see https://docs.imgix.com/apis/url/blending/blend-align */ ba?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[]; /** * Blend alpha * * Changes the alpha of the blend image. * * Aliases: `blendalpha`, `balph` * * @defaultValue `100` * * @see https://docs.imgix.com/apis/url/blending/blend-alpha */ blendAlpha?: number; /** * Blend alpha * * Changes the alpha of the blend image. * * Alias for: `blendAlpha` * * @defaultValue `100` * * @see https://docs.imgix.com/apis/url/blending/blend-alpha */ blendalpha?: number; /** * Blend alpha * * Changes the alpha of the blend image. * * Alias for: `blendAlpha` * * @defaultValue `100` * * @see https://docs.imgix.com/apis/url/blending/blend-alpha */ balph?: number; /** * Blend color * * Specifies a color to use when applying the blend. * * Aliases: `blendcolor`, `blendClr`, `blendclr` * * @see https://docs.imgix.com/apis/url/blending/blend-color */ blendColor?: string | ColorKeyword; /** * Blend color * * Specifies a color to use when applying the blend. * * Alias for: `blendColor` * * @see https://docs.imgix.com/apis/url/blending/blend-color */ blendcolor?: string | ColorKeyword; /** * Blend color * * Specifies a color to use when applying the blend. * * Alias for: `blendColor` * * @see https://docs.imgix.com/apis/url/blending/blend-color */ blendClr?: string | ColorKeyword; /** * Blend color * * Specifies a color to use when applying the blend. * * Alias for: `blendColor` * * @see https://docs.imgix.com/apis/url/blending/blend-color */ blendclr?: string | ColorKeyword; /** * Blend crop * * Specifies the type of crop for blend images. * * Aliases: `blendcrop`, `bc` * * @see https://docs.imgix.com/apis/url/blending/blend-crop */ blendCrop?: ("top" | "bottom" | "left" | "right" | "faces")[]; /** * Blend crop * * Specifies the type of crop for blend images. * * Alias for: `blendCrop` * * @see https://docs.imgix.com/apis/url/blending/blend-crop */ blendcrop?: ("top" | "bottom" | "left" | "right" | "faces")[]; /** * Blend crop * * Specifies the type of crop for blend images. * * Alias for: `blendCrop` * * @see https://docs.imgix.com/apis/url/blending/blend-crop */ bc?: ("top" | "bottom" | "left" | "right" | "faces")[]; /** * Blend fit * * Specifies the fit mode for blend images. * * Aliases: `blendfit`, `bf` * * @defaultValue `"clip"` * * @see https://docs.imgix.com/apis/url/blending/blend-fit */ blendFit?: "clamp" | "clip" | "crop" | "scale" | "max"; /** * Blend fit * * Specifies the fit mode for blend images. * * Alias for: `blendFit` * * @defaultValue `"clip"` * * @see https://docs.imgix.com/apis/url/blending/blend-fit */ blendfit?: "clamp" | "clip" | "crop" | "scale" | "max"; /** * Blend fit * * Specifies the fit mode for blend images. * * Alias for: `blendFit` * * @defaultValue `"clip"` * * @see https://docs.imgix.com/apis/url/blending/blend-fit */ bf?: "clamp" | "clip" | "crop" | "scale" | "max"; /** * Blend height * * Adjusts the height of the blend image. * * Aliases: `blendh`, `bh` * * @see https://docs.imgix.com/apis/url/blending/blend-h */ blendH?: number; /** * Blend height * * Adjusts the height of the blend image. * * Alias for: `blendH` * * @see https://docs.imgix.com/apis/url/blending/blend-h */ blendh?: number; /** * Blend height * * Adjusts the height of the blend image. * * Alias for: `blendH` * * @see https://docs.imgix.com/apis/url/blending/blend-h */ bh?: number; /** * Blend mode * * Sets the blend mode for a blend image. * * Aliases: `blendmode`, `bm` * * @defaultValue `"overlay"` * * @see https://docs.imgix.com/apis/url/blending/blend-mode */ blendMode?: | "color" | "burn" | "dodge" | "darken" | "difference" | "exclusion" | "hardlight" | "hue" | "lighten" | "luminosity" | "multiply" | "overlay" | "saturation" | "screen" | "softlight" | "normal"; /** * Blend mode * * Sets the blend mode for a blend image. * * Alias for: `blendMode` * * @defaultValue `"overlay"` * * @see https://docs.imgix.com/apis/url/blending/blend-mode */ blendmode?: | "color" | "burn" | "dodge" | "darken" | "difference" | "exclusion" | "hardlight" | "hue" | "lighten" | "luminosity" | "multiply" | "overlay" | "saturation" | "screen" | "softlight" | "normal"; /** * Blend mode * * Sets the blend mode for a blend image. * * Alias for: `blendMode` * * @defaultValue `"overlay"` * * @see https://docs.imgix.com/apis/url/blending/blend-mode */ bm?: | "color" | "burn" | "dodge" | "darken" | "difference" | "exclusion" | "hardlight" | "hue" | "lighten" | "luminosity" | "multiply" | "overlay" | "saturation" | "screen" | "softlight" | "normal"; /** * Blend padding * * Applies padding to the blend image. * * Aliases: `blendpad`, `bp` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-pad */ blendPad?: number; /** * Blend padding * * Applies padding to the blend image. * * Alias for: `blendPad` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-pad */ blendpad?: number; /** * Blend padding * * Applies padding to the blend image. * * Alias for: `blendPad` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-pad */ bp?: number; /** * Blend size * * Adjusts the size of the blend image. * * Aliases: `blendsize`, `bs` * * @see https://docs.imgix.com/apis/url/blending/blend-size */ blendSize?: "inherit"; /** * Blend size * * Adjusts the size of the blend image. * * Alias for: `blendSize` * * @see https://docs.imgix.com/apis/url/blending/blend-size */ blendsize?: "inherit"; /** * Blend size * * Adjusts the size of the blend image. * * Alias for: `blendSize` * * @see https://docs.imgix.com/apis/url/blending/blend-size */ bs?: "inherit"; /** * Blend width * * Adjusts the width of the blend image. * * Aliases: `blendw`, `bw` * * @see https://docs.imgix.com/apis/url/blending/blend-w */ blendW?: number; /** * Blend width * * Adjusts the width of the blend image. * * Alias for: `blendW` * * @see https://docs.imgix.com/apis/url/blending/blend-w */ blendw?: number; /** * Blend width * * Adjusts the width of the blend image. * * Alias for: `blendW` * * @see https://docs.imgix.com/apis/url/blending/blend-w */ bw?: number; /** * Blend x position * * Adjusts the x-offset of the blend image relative to its parent. * * Aliases: `blendx`, `bx` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-x */ blendX?: number; /** * Blend x position * * Adjusts the x-offset of the blend image relative to its parent. * * Alias for: `blendX` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-x */ blendx?: number; /** * Blend x position * * Adjusts the x-offset of the blend image relative to its parent. * * Alias for: `blendX` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-x */ bx?: number; /** * Blend y position * * Adjusts the y-offset of the blend image relative to its parent. * * Aliases: `blendy`, `by` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-y */ blendY?: number; /** * Blend y position * * Adjusts the y-offset of the blend image relative to its parent. * * Alias for: `blendY` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-y */ blendy?: number; /** * Blend y position * * Adjusts the y-offset of the blend image relative to its parent. * * Alias for: `blendY` * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/blending/blend-y */ by?: number; /** * Blend * * Specifies the location of the blend image. * * Aliases: `b` * * @see https://docs.imgix.com/apis/url/blending/blend */ blend?: string | ColorKeyword; /** * Blend * * Specifies the location of the blend image. * * Alias for: `blend` * * @see https://docs.imgix.com/apis/url/blending/blend */ b?: string | ColorKeyword; /** * Gaussian blur * * Applies a gaussian blur to an image. * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/stylize/blur */ blur?: number; /** * Border bottom * * Sets bottom border of an image. * * @see https://docs.imgix.com/apis/url/border-and-padding/border-bottom */ borderBottom?: number; /** * Border left * * Sets left border of an image. * * @see https://docs.imgix.com/apis/url/border-and-padding/border-left */ borderLeft?: number; /** * Inner border radius * * Sets the inner radius of the image's border in pixels. * * @see https://docs.imgix.com/apis/url/border-and-padding/border-radius-inner */ borderRadiusInner?: number | [number, number, number, number]; /** * Outer border radius * * Sets the outer radius of the image's border in pixels. * * @see https://docs.imgix.com/apis/url/border-and-padding/border-radius */ borderRadius?: number | [number, number, number, number]; /** * Border right * * Sets right border of an image. * * @see https://docs.imgix.com/apis/url/border-and-padding/border-right */ borderRight?: number; /** * Border top * * Sets top border of an image. * * @see https://docs.imgix.com/apis/url/border-and-padding/border-top */ borderTop?: number; /** * Border size & color * * Applies a border to an image. * * @see https://docs.imgix.com/apis/url/border-and-padding/border */ border?: [number, string | ColorKeyword]; /** * Brightness * * Adjusts the brightness of the source image. * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/adjustment/bri */ bri?: number; /** * Client hints * * Sets one or more Client-Hints headers * * @see https://docs.imgix.com/apis/url/format/ch */ ch?: ("width" | "dpr" | "save-data")[]; /** * Chroma subsampling * * Specifies the output chroma subsampling rate. * * @defaultValue `420` * * @see https://docs.imgix.com/apis/url/format/chromasub */ chromasub?: 444 | 422 | 420; /** * Color quantization * * Limits the number of unique colors in an image. * * @see https://docs.imgix.com/apis/url/format/colorquant */ colorquant?: number; /** * Palette color count * * Specifies how many colors to include in a palette-extraction response. * * @defaultValue `6` * * @see https://docs.imgix.com/apis/url/color-palette/colors */ colors?: number; /** * Contrast * * Adjusts the contrast of the source image. * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/adjustment/con */ con?: number; /** * Mask corner radius * * Specifies the radius value for a rounded corner mask. * * @see https://docs.imgix.com/apis/url/mask/corner-radius */ cornerRadius?: number | [number, number, number, number]; /** * Crop mode * * Specifies how to crop an image. * * @see https://docs.imgix.com/apis/url/size/crop */ crop?: ( | "top" | "bottom" | "left" | "right" | "faces" | "entropy" | "edges" | "focalpoint" )[]; /** * Color space * * Specifies the color space of the output image. * * @see https://docs.imgix.com/apis/url/format/cs */ cs?: "origin" | "srgb" | "adobergb1998" | "tinysrgb" | "strip"; /** * Download * * Forces a URL to use send-file in its response. * * @see https://docs.imgix.com/apis/url/format/dl */ dl?: string; /** * Dots per inch * * Sets the DPI value in the EXIF header. * * @see https://docs.imgix.com/apis/url/format/dpi */ dpi?: number; /** * Device pixel ratio * * Adjusts the device-pixel ratio of the output image. * * @defaultValue `1` * * @see https://docs.imgix.com/apis/url/dpr */ dpr?: number; /** * Duotone alpha * * Changes the alpha of the duotone effect atop the source image. * * @defaultValue `100` * * @see https://docs.imgix.com/apis/url/stylize/duotone-alpha */ duotoneAlpha?: number; /** * Duotone * * Applies a duotone effect to the source image. * * @see https://docs.imgix.com/apis/url/stylize/duotone */ duotone?: [string | ColorKeyword, string | ColorKeyword]; /** * Exposure * * Adjusts the exposure of the output image. * * @defaultValue `0` * * @see https://docs.imgix.com/apis/url/adjustment/exp */ exp?: number; /** * URL expiration timestamp * * A Unix timestamp specifying a UTC time. Requests made to this URL after * that time will output a 404 status code. * * @see https://docs.imgix.com/apis/url/expires */ expires?: number; /** * Face index * * Selects a face to crop to. * * @see https://docs.imgix.com/apis/url/face-detection/faceindex */ faceindex?: number; /** * Face padding * * Adjusts padding around a selected face. * * @defaultValue `1` * * @see https://docs.imgix.com/apis/url/face-detection/facepad */ facepad?: number; /** * Json face data * * Specifies that face data should be included in output when combined with * `fm=json`. * * @see https://docs.imgix.com/apis/url/face-detection/faces */ faces?: 1; /** * Fill color * * Sets the fill color for images with additional space created by the fit * setting * * Aliases: `fillcolor` * * @defaultValue `"fff"` * * @see https://docs.imgix.com/apis/url/fill/fill-color */ fillColor?: string | ColorKeyword; /** * Fill color * * Sets the fill color for images with additional space created by the fit * setting * * Alias for: `fillColor` * * @defaultValue `"fff"` * * @see https://docs.imgix.com/apis/url/fill/fill-color */ fillcolor?: string | ColorKeyword; /** * Fill generative fallback * * Sets the fallback behavior for generative fill. * * Aliases: `fillGenerativeFallback` * * @defaultValue `true` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-fallback */ fillGenFallback?: boolean; /** * Fill generative fallback * * Sets the fallback behavior for generative fill. * * Alias for: `fillGenFallback` * * @defaultValue `true` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-fallback */ fillGenerativeFallback?: boolean; /** * Fill generative negative prompt * * Provides a negative text suggestion to the generative fill parameter. Used * to reduce the probability of a subject, detail, or object appearing in * generative output. * * Aliases: `fillGenerativeNegativePrompt` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-neg-prompt */ fillGenNegPrompt?: string; /** * Fill generative negative prompt * * Provides a negative text suggestion to the generative fill parameter. Used * to reduce the probability of a subject, detail, or object appearing in * generative output. * * Alias for: `fillGenNegPrompt` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-neg-prompt */ fillGenerativeNegativePrompt?: string; /** * Fill generative position * * Sets the position of the Origin Image in relation to the generative fill. * * Aliases: `fillGenerativePosition` * * @defaultValue `"center,middle"` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-pos */ fillGenPos?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[]; /** * Fill generative position * * Sets the position of the Origin Image in relation to the generative fill. * * Alias for: `fillGenPos` * * @defaultValue `"center,middle"` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-pos */ fillGenerativePosition?: ( | "top" | "bottom" | "middle" | "left" | "right" | "center" )[]; /** * Fill generative prompt * * Provides a text suggestion to the generative fill parameter. * * Aliases: `fillGenerativePrompt` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-prompt */ fillGenPrompt?: string; /** * Fill generative prompt * * Provides a text suggestion to the generative fill parameter. * * Alias for: `fillGenPrompt` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-prompt */ fillGenerativePrompt?: string; /** * Fill generative seed * * Sets the generative seed value. Used to generate similar outputs from * different prompts. * * Aliases: `fillGenerativeSeed` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-seed */ fillGenSeed?: number; /** * Fill generative seed * * Sets the generative seed value. Used to generate similar outputs from * different prompts. * * Alias for: `fillGenSeed` * * @see https://docs.imgix.com/apis/url/fill/fill-gen-seed */ fillGenerativeSeed?: number; /** * Fill gradient color space * * Defines the color space as linear, sRGB, Oklab, HSL, or LCH for gradient * color interpolation * * @defaultValue `"srgb"` * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-cs */ fillGradientCs?: "linear" | "srgb" | "oklab" | "hsl" | "lch"; /** * Fill gradient linear direction * * The fill-gradient-linear-direction specifies the gradient's direction, * flowing towards the bottom, top, right, or left * * @defaultValue `"top,bottom"` * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-linear-direction */ fillGradientLinearDirection?: ("top" | "bottom" | "left" | "right")[]; /** * Fill gradient linear * * Blends a gradient between two colors, {color1} and {color2}, along a * straight path * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-linear */ fillGradientLinear?: [string | ColorKeyword, string | ColorKeyword]; /** * Fill gradient radial radius * * Parameter defines the radial gradient's radius as pixels or a percentage * (0.0-1.0) of the image's smallest dimension * * @defaultValue `"0.25,0.5"` * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-radial-radius */ fillGradientRadialRadius?: [number, number]; /** * Fill gradient radial x * * Specifies the location of the radial gradient's center along the x-axis, * using either a pixel value or a floating point percentage (ranging from 0.0 * to 1.0) of the image's width * * @defaultValue `0.5` * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-radial-x */ fillGradientRadialX?: number; /** * Fill gradient radial y * * Parameter sets the radial gradient's center on the y-axis, using pixels or * a 0.0 to 1.0 percentage of the image's height * * @defaultValue `0.5` * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-radial-y */ fillGradientRadialY?: number; /** * Fill gradient radial * * The fill-gradient-radial parameter creates a circular gradient * transitioning from a central color (Color1) to an outer color (Color2) * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-radial */ fillGradientRadial?: [string | ColorKeyword, string | ColorKeyword]; /** * Fill gradient type * * Specifies if a gradient is radial (circular) or linear (straight) * * @defaultValue `"linear"` * * @see https://docs.imgix.com/apis/url/fill/fill-gradient-type */ fillGradientType?: "linear" | "radial"; /** * Fill mode * * Determines how to fill in additional space created by the fit setting * * @see https://docs.imgix.com/apis/url/fill/fill */ fill?: "solid" | "blur" | "gen" | "generative" | "gradient"; /** * Resize fit mode * * Specifies how to map the source image to the output image dimensions. * * Aliases: `f` * * @defaultValue `"clip"` * * @see https://docs.imgix.com/apis/url/size/fit */ fit?: | "clamp" | "clip" | "crop" | "facearea" | "fill" | "fillmax" | "max" | "min" | "scale"; /** * Resize fit mode * * Specifies how to map the source image to the output image dimensions. * * Alias for: `fit` * * @defaultValue `"clip"` * * @see https://docs.imgix.com/apis/url/size/fit */ f?: | "clamp" | "clip" | "crop" | "facearea" | "fill" | "fillmax" | "max" | "min" | "scale"; /** * Flip axis * * Flips an image on a specified axis. * * @see https://docs.imgix.com/apis/url/rotation/flip */ flip?: "h" | "v" | "hv"; /** * Output format * * Changes the format of the output image. * * @see https://docs.im