@types/react-imgix - npm Package Compare versions

Comparing version 9.2.1 to 9.3.0

react-imgix/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for react-imgix 9.2
+// Type definitions for react-imgix 9.3
 // Project: https://github.com/imgix/react-imgix
@@ -13,229 +13,240 @@ // Definitions by: Sherwin Heydarbeygi <https://github.com/sherwinski>
 interface AdjustmentParams {
-  bri?: ImgixParamType | undefined;
-  con?: ImgixParamType | undefined;
-  exp?: ImgixParamType | undefined;
-  gam?: ImgixParamType | undefined;
-  high?: ImgixParamType | undefined;
-  hue?: ImgixParamType | undefined;
-  invert?: ImgixParamType | undefined;
-  sat?: ImgixParamType | undefined;
-  shad?: ImgixParamType | undefined;
-  sharp?: ImgixParamType | undefined;
-  usm?: ImgixParamType | undefined;
-  usmrad?: ImgixParamType | undefined;
-  vib?: ImgixParamType | undefined;
+    bri?: ImgixParamType | undefined;
+    con?: ImgixParamType | undefined;
+    exp?: ImgixParamType | undefined;
+    gam?: ImgixParamType | undefined;
+    high?: ImgixParamType | undefined;
+    hue?: ImgixParamType | undefined;
+    invert?: ImgixParamType | undefined;
+    sat?: ImgixParamType | undefined;
+    shad?: ImgixParamType | undefined;
+    sharp?: ImgixParamType | undefined;
+    usm?: ImgixParamType | undefined;
+    usmrad?: ImgixParamType | undefined;
+    vib?: ImgixParamType | undefined;
 }
 
-interface AutomaticParams   {
-  auto?: ImgixParamType | undefined;
+interface AutomaticParams {
+    auto?: ImgixParamType | undefined;
 }
 
 interface BlendingParams {
-  'blend-align'?: ImgixParamType | undefined;
-  'blend-alpha'?: ImgixParamType | undefined;
-  'blend-crop'?: ImgixParamType | undefined;
-  'blend-fit'?: ImgixParamType | undefined;
-  'blend-mode'?: ImgixParamType | undefined;
-  'blend-pad'?: ImgixParamType | undefined;
-  'blend-size'?: ImgixParamType | undefined;
-  'blend-x'?: ImgixParamType | undefined;
-  'blend-y'?: ImgixParamType | undefined;
-  'blend'?: ImgixParamType | undefined;
+    'blend-align'?: ImgixParamType | undefined;
+    'blend-alpha'?: ImgixParamType | undefined;
+    'blend-crop'?: ImgixParamType | undefined;
+    'blend-fit'?: ImgixParamType | undefined;
+    'blend-mode'?: ImgixParamType | undefined;
+    'blend-pad'?: ImgixParamType | undefined;
+    'blend-size'?: ImgixParamType | undefined;
+    'blend-x'?: ImgixParamType | undefined;
+    'blend-y'?: ImgixParamType | undefined;
+    blend?: ImgixParamType | undefined;
 }
 
 interface BorderAndPaddingParams {
-  'border-radius-inner'?: ImgixParamType | undefined;
-  'border-radius'?: ImgixParamType | undefined;
-  border?: ImgixParamType | undefined;
-  pad?: ImgixParamType | undefined;
+    'border-radius-inner'?: ImgixParamType | undefined;
+    'border-radius'?: ImgixParamType | undefined;
+    border?: ImgixParamType | undefined;
+    pad?: ImgixParamType | undefined;
 }
 
 interface ColorPaletteParams {
-  colors?: ImgixParamType | undefined;
-  palette?: ImgixParamType | undefined;
-  prefix?: ImgixParamType | undefined;
+    colors?: ImgixParamType | undefined;
+    palette?: ImgixParamType | undefined;
+    prefix?: ImgixParamType | undefined;
 }
 
 interface FaceDetectionParams {
-  faceindex?: ImgixParamType | undefined;
-  facepad?: ImgixParamType | undefined;
-  faces?: ImgixParamType | undefined;
+    faceindex?: ImgixParamType | undefined;
+    facepad?: ImgixParamType | undefined;
+    faces?: ImgixParamType | undefined;
 }
 
 interface FillParams {
-  bg?: ImgixParamType | undefined;
-  'fill-color'?: ImgixParamType | undefined;
-  fill?: ImgixParamType | undefined;
+    bg?: ImgixParamType | undefined;
+    'fill-color'?: ImgixParamType | undefined;
+    fill?: ImgixParamType | undefined;
 }
 
 interface FocalPointCropParams {
-  'fp-debug'?: ImgixParamType | undefined;
-  'fp-x'?: ImgixParamType | undefined;
-  'fp-y'?: ImgixParamType | undefined;
-  'fp-z'?: ImgixParamType | undefined;
+    'fp-debug'?: ImgixParamType | undefined;
+    'fp-x'?: ImgixParamType | undefined;
+    'fp-y'?: ImgixParamType | undefined;
+    'fp-z'?: ImgixParamType | undefined;
 }
 
 interface FormatParams {
-  ch?: ImgixParamType | undefined;
-  chromasub?: ImgixParamType | undefined;
-  colorquant?: ImgixParamType | undefined;
-  cs?: ImgixParamType | undefined;
-  dl?: ImgixParamType | undefined;
-  dpi?: ImgixParamType | undefined;
-  fm?: ImgixParamType | undefined;
-  lossless?: ImgixParamType | undefined;
-  q?: ImgixParamType | undefined;
+    ch?: ImgixParamType | undefined;
+    chromasub?: ImgixParamType | undefined;
+    colorquant?: ImgixParamType | undefined;
+    cs?: ImgixParamType | undefined;
+    dl?: ImgixParamType | undefined;
+    dpi?: ImgixParamType | undefined;
+    fm?: ImgixParamType | undefined;
+    lossless?: ImgixParamType | undefined;
+    q?: ImgixParamType | undefined;
 }
 
 interface MaskImageParams {
-  'corner-radius'?: ImgixParamType | undefined;
-  mask?: ImgixParamType | undefined;
+    'corner-radius'?: ImgixParamType | undefined;
+    mask?: ImgixParamType | undefined;
 }
 
 interface NoiseReductionParams {
-  nr?: ImgixParamType | undefined;
-  nrs?: ImgixParamType | undefined;
+    nr?: ImgixParamType | undefined;
+    nrs?: ImgixParamType | undefined;
 }
 
 interface PDFParams {
-  page?: ImgixParamType | undefined;
+    page?: ImgixParamType | undefined;
 }
 
 interface PixelDensityParams {
-  dpr?: ImgixParamType | undefined;
+    dpr?: ImgixParamType | undefined;
 }
 
 interface RotationParams {
-  flip?: ImgixParamType | undefined;
-  orient?: ImgixParamType | undefined;
-  rot?: ImgixParamType | undefined;
+    flip?: ImgixParamType | undefined;
+    orient?: ImgixParamType | undefined;
+    rot?: ImgixParamType | undefined;
 }
 
 interface SizeParams {
-  ar?: ImgixParamType | undefined;
-  crop?: ImgixParamType | undefined;
-  fit?: ImgixParamType | undefined;
-  h?: ImgixParamType | undefined;
-  'max-h'?: ImgixParamType | undefined;
-  'max-w'?: ImgixParamType | undefined;
-  'min-h'?: ImgixParamType | undefined;
-  'min-w'?: ImgixParamType | undefined;
-  rect?: ImgixParamType | undefined;
-  w?: ImgixParamType | undefined;
+    ar?: ImgixParamType | undefined;
+    crop?: ImgixParamType | undefined;
+    fit?: ImgixParamType | undefined;
+    h?: ImgixParamType | undefined;
+    'max-h'?: ImgixParamType | undefined;
+    'max-w'?: ImgixParamType | undefined;
+    'min-h'?: ImgixParamType | undefined;
+    'min-w'?: ImgixParamType | undefined;
+    rect?: ImgixParamType | undefined;
+    w?: ImgixParamType | undefined;
 }
 
 interface StylizeParams {
-  blur?: ImgixParamType | undefined;
-  'duotone-alpha'?: ImgixParamType | undefined;
-  duotone?: ImgixParamType | undefined;
-  htn?: ImgixParamType | undefined;
-  monochrome?: ImgixParamType | undefined;
-  px?: ImgixParamType | undefined;
-  sepia?: ImgixParamType | undefined;
+    blur?: ImgixParamType | undefined;
+    'duotone-alpha'?: ImgixParamType | undefined;
+    duotone?: ImgixParamType | undefined;
+    htn?: ImgixParamType | undefined;
+    monochrome?: ImgixParamType | undefined;
+    px?: ImgixParamType | undefined;
+    sepia?: ImgixParamType | undefined;
 }
 
 interface TextParams {
-  'txt-align'?: ImgixParamType | undefined;
-  'txt-clip'?: ImgixParamType | undefined;
-  'txt-color'?: ImgixParamType | undefined;
-  'txt-fit'?: ImgixParamType | undefined;
-  'txt-font'?: ImgixParamType | undefined;
-  'txt-lig'?: ImgixParamType | undefined;
-  'txt-line-color'?: ImgixParamType | undefined;
-  'txt-line'?: ImgixParamType | undefined;
-  'txt-pad'?: ImgixParamType | undefined;
-  'txt-shad'?: ImgixParamType | undefined;
-  'txt-size'?: ImgixParamType | undefined;
-  'txt-width'?: ImgixParamType | undefined;
-  txt?: ImgixParamType | undefined;
+    'txt-align'?: ImgixParamType | undefined;
+    'txt-clip'?: ImgixParamType | undefined;
+    'txt-color'?: ImgixParamType | undefined;
+    'txt-fit'?: ImgixParamType | undefined;
+    'txt-font'?: ImgixParamType | undefined;
+    'txt-lig'?: ImgixParamType | undefined;
+    'txt-line-color'?: ImgixParamType | undefined;
+    'txt-line'?: ImgixParamType | undefined;
+    'txt-pad'?: ImgixParamType | undefined;
+    'txt-shad'?: ImgixParamType | undefined;
+    'txt-size'?: ImgixParamType | undefined;
+    'txt-width'?: ImgixParamType | undefined;
+    txt?: ImgixParamType | undefined;
 }
 
 interface TrimParams {
-  'trim-color'?: ImgixParamType | undefined;
-  'trim-md'?: ImgixParamType | undefined;
-  'trim-sd'?: ImgixParamType | undefined;
-  'trim-tol'?: ImgixParamType | undefined;
-  trim?: ImgixParamType | undefined;
+    'trim-color'?: ImgixParamType | undefined;
+    'trim-md'?: ImgixParamType | undefined;
+    'trim-sd'?: ImgixParamType | undefined;
+    'trim-tol'?: ImgixParamType | undefined;
+    trim?: ImgixParamType | undefined;
 }
 
 interface TypesettingEndpointParams {
-  'txt-lead'?: ImgixParamType | undefined;
-  'txt-track'?: ImgixParamType | undefined;
-  '~text'?: ImgixParamType | undefined;
+    'txt-lead'?: ImgixParamType | undefined;
+    'txt-track'?: ImgixParamType | undefined;
+    '~text'?: ImgixParamType | undefined;
 }
 
 interface WatermarkParams {
-  'mark-align'?: ImgixParamType | undefined;
-  'mark-alpha'?: ImgixParamType | undefined;
-  'mark-base'?: ImgixParamType | undefined;
-  'mark-fit'?: ImgixParamType | undefined;
-  'mark-h'?: ImgixParamType | undefined;
-  'mark-pad'?: ImgixParamType | undefined;
-  'mark-scale'?: ImgixParamType | undefined;
-  'mark-w'?: ImgixParamType | undefined;
-  'mark-x'?: ImgixParamType | undefined;
-  'mark-y'?: ImgixParamType | undefined;
-  mark?: ImgixParamType | undefined;
+    'mark-align'?: ImgixParamType | undefined;
+    'mark-alpha'?: ImgixParamType | undefined;
+    'mark-base'?: ImgixParamType | undefined;
+    'mark-fit'?: ImgixParamType | undefined;
+    'mark-h'?: ImgixParamType | undefined;
+    'mark-pad'?: ImgixParamType | undefined;
+    'mark-scale'?: ImgixParamType | undefined;
+    'mark-w'?: ImgixParamType | undefined;
+    'mark-x'?: ImgixParamType | undefined;
+    'mark-y'?: ImgixParamType | undefined;
+    mark?: ImgixParamType | undefined;
 }
 
-type ImigixParams =
-  & AdjustmentParams
-  & AutomaticParams
-  & BlendingParams
-  & BorderAndPaddingParams
-  & ColorPaletteParams
-  & FaceDetectionParams
-  & FillParams
-  & FocalPointCropParams
-  & FormatParams
-  & MaskImageParams
-  & NoiseReductionParams
-  & PDFParams
-  & PixelDensityParams
-  & RotationParams
-  & SizeParams
-  & StylizeParams
-  & TextParams
-  & TrimParams
-  & TypesettingEndpointParams
-  & WatermarkParams
-;
+type ImigixParams = AdjustmentParams &
+    AutomaticParams &
+    BlendingParams &
+    BorderAndPaddingParams &
+    ColorPaletteParams &
+    FaceDetectionParams &
+    FillParams &
+    FocalPointCropParams &
+    FormatParams &
+    MaskImageParams &
+    NoiseReductionParams &
+    PDFParams &
+    PixelDensityParams &
+    RotationParams &
+    SizeParams &
+    StylizeParams &
+    TextParams &
+    TrimParams &
+    TypesettingEndpointParams &
+    WatermarkParams;
 
 interface AttributeConfig {
-  src?: string | undefined;
-  srcSet?: string | undefined;
-  sizes?: string | undefined;
+    src?: string | undefined;
+    srcSet?: string | undefined;
+    sizes?: string | undefined;
 }
 
-type ImgixHTMLAttributes = React.ImgHTMLAttributes<HTMLImageElement> | React.SourceHTMLAttributes<HTMLSourceElement> | Record<string, string>;
+interface SrcSetParams {
+    widths: number[];
+    widthTolerance: number;
+    minWidth: number;
+    maxWidth: number;
+}
 
+type ImgixHTMLAttributes =
+    | React.ImgHTMLAttributes<HTMLImageElement>
+    | React.SourceHTMLAttributes<HTMLSourceElement>
+    | Record<string, string>;
+
 interface CommonProps {
-  className?: string | undefined;
-  onMounted?: ((ref?: React.RefObject<HTMLPictureElement | HTMLImageElement | HTMLSourceElement>) => void) | undefined;
-  htmlAttributes?: ImgixHTMLAttributes | undefined;
-  domain?: string | undefined;
+    className?: string | undefined;
+    onMounted?:
+        | ((ref?: React.RefObject<HTMLPictureElement | HTMLImageElement | HTMLSourceElement>) => void)
+        | undefined;
+    htmlAttributes?: ImgixHTMLAttributes | undefined;
+    domain?: string | undefined;
 }
 
 export interface SharedImigixAndSourceProps extends CommonProps {
-  src: string;
-  disableQualityByDPR?: boolean | undefined;
-  disableSrcSet?: boolean | undefined;
-  disableLibraryParam?: boolean | undefined;
-  imgixParams?: ImigixParams | undefined;
-  sizes?: string | undefined;
-  width?: number | undefined;
-  height?: number | undefined;
-  attributeConfig?: AttributeConfig | undefined;
+    src: string;
+    disableQualityByDPR?: boolean | undefined;
+    disableSrcSet?: boolean | undefined;
+    disableLibraryParam?: boolean | undefined;
+    imgixParams?: ImigixParams | undefined;
+    srcSetOptions?: SrcSetParams | undefined;
+    sizes?: string | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    attributeConfig?: AttributeConfig | undefined;
 }
 
 export interface ImgixProviderProps extends CommonProps {
-  src?: string | undefined;
-  disableQualityByDPR?: boolean | undefined;
-  disableSrcSet?: boolean | undefined;
-  disableLibraryParam?: boolean | undefined;
-  imgixParams?: ImigixParams | undefined;
-  sizes?: string | undefined;
-  width?: number | undefined;
-  height?: number | undefined;
-  attributeConfig?: AttributeConfig | undefined;
+    src?: string | undefined;
+    disableQualityByDPR?: boolean | undefined;
+    disableSrcSet?: boolean | undefined;
+    disableLibraryParam?: boolean | undefined;
+    imgixParams?: ImigixParams | undefined;
+    sizes?: string | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    attributeConfig?: AttributeConfig | undefined;
 }
@@ -251,12 +262,12 @@
 export namespace PublicConfigAPI {
-  function disableWarning(name: Warnings): void;
-  function enableWarning(name: Warnings): void;
+    function disableWarning(name: Warnings): void;
+    function enableWarning(name: Warnings): void;
 }
 
 export interface BackgroundProps {
-  src: string;
-  imgixParams?: ImigixParams | undefined;
-  className?: string | undefined;
-  disableLibraryParam?: boolean | undefined;
-  htmlAttributes?: ImgixHTMLAttributes | undefined;
+    src: string;
+    imgixParams?: ImigixParams | undefined;
+    className?: string | undefined;
+    disableLibraryParam?: boolean | undefined;
+    htmlAttributes?: ImgixHTMLAttributes | undefined;
 }
@@ -263,0 +274,0 @@

react-imgix/package.json

 {
     "name": "@types/react-imgix",
-    "version": "9.2.1",
+    "version": "9.3.0",
     "description": "TypeScript definitions for react-imgix",
@@ -35,4 +35,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-imgix",
     },
-    "typesPublisherContentHash": "57ab26de7db71c9fd344b28304c9e52bc597c09401918cebab38c72f5f781648",
+    "typesPublisherContentHash": "d6599371cb157604c1d3df62c543ce9a00c8963d749ec80d02cf409655f27632",
     "typeScriptVersion": "3.7"
 }

react-imgix/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Tue, 02 Nov 2021 20:01:21 GMT
+ * Last updated: Tue, 16 Nov 2021 01:31:22 GMT
  * Dependencies: [@types/react](https://npmjs.com/package/@types/react)
@@ -14,0 +14,0 @@ * Global values: none

No alert changes

Improved metrics

Total package byte prevSize

11622

increased by4.58%

Lines of code

241

increased by4.33%

No dependency changes