fix(gatsby-image): Fix typings for fixed and fluid props (#24767)

Co-authored-by: Matt Kane <[email protected]>
gatsbyjs · Aug 12, 2020 · 08e0aa1 · 08e0aa1 · Erythros · Sep 17, 2020
1 parent e6b6268
commit 08e0aa1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/packages/gatsby-image/index.d.ts b/packages/gatsby-image/index.d.ts
@@ -24,11 +24,15 @@ export interface FluidObject {
   media?: string
 }
 
-interface GatsbyImageProps {
+interface GatsbyImageOptionalProps {
+  /**
+   * @deprecated Use `fixed`
+   */
   resolutions?: FixedObject
+  /**
+   * @deprecated Use `fluid`
+   */
   sizes?: FluidObject
-  fixed?: FixedObject | FixedObject[]
-  fluid?: FluidObject | FluidObject[]
   fadeIn?: boolean
   durationFadeIn?: number
   title?: string
@@ -49,6 +53,16 @@ interface GatsbyImageProps {
   loading?: `auto` | `lazy` | `eager`
   draggable?: boolean
 }
+
+interface GatsbyImageFluidProps extends GatsbyImageOptionalProps {
+  fluid: FluidObject | FluidObject[]
+}
+
+interface GatsbyImageFixedProps extends GatsbyImageOptionalProps {
+  fixed: FixedObject | FixedObject[]
+}
+
+export type GatsbyImageProps = GatsbyImageFluidProps | GatsbyImageFixedProps
 
 export default class GatsbyImage extends React.Component<
   GatsbyImageProps,

diff --git a/packages/gatsby-image/withIEPolyfill/index.d.ts b/packages/gatsby-image/withIEPolyfill/index.d.ts
@@ -2,7 +2,7 @@ import * as React from "react"
 
 import GatsbyImage, { GatsbyImageProps } from "../index"
 
-interface GatsbyImageWithIEPolyfillProps extends GatsbyImageProps {
+type GatsbyImageWithIEPolyfillProps = GatsbyImageProps & {
   objectFit?: `fill` | `contain` | `cover` | `none` | `scale-down`
   objectPosition?: string
 }