GitHub

ShopifyImage

interface

import { ShopifyImage } from '@daffodil/driver/shopify'

Represents an image resource.

interface ShopifyImage {
  __typename: "Image"
  altText: string
  height: number
  id: string
  originalSrc: Scalars['URL']['output']
  src: Scalars['URL']['output']
  transformedSrc: Scalars['URL']['output']
  url: Scalars['URL']['output']
  width: number
}

Properties

__typename
"Image"
altText
string

A word or phrase to share the nature or contents of an image.

height
number

The original height of the image in pixels. Returns null if the image isn't hosted by Shopify.

id
string

A unique ID for the image.

originalSrc
Scalars['URL']['output']

The location of the original image as a URL.

If there are any existing transformations in the original source URL, they will remain and not be stripped.

src
Scalars['URL']['output']

The location of the image as a URL.

transformedSrc
Scalars['URL']['output']

The location of the transformed image as a URL.

All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. Otherwise any transformations which an image type doesn't support will be ignored.

url
Scalars['URL']['output']

The location of the image as a URL.

If no transform options are specified, then the original image will be preserved including any pre-applied transforms.

All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored.

If you need multiple variations of the same image, then you can use GraphQL aliases.

width
number

The original width of the image in pixels. Returns null if the image isn't hosted by Shopify.