Reference / @open-music-sdk/util-artwork / tArtworkSource

Interface: tArtworkSource

Defined in: artwork.ts:4

What is read from an artwork object. Any tArtwork from @open-music-sdk/types fits.

Properties

height?

readonly optional height?: number | null;

Defined in: artwork.ts:17

The tallest the image comes, in pixels. Read as width is.

---

url

readonly url: string;

Defined in: artwork.ts:9

The URL template. {w} and {h} stand for the pixel size. A template that has been through a URL parser on its way to you, with %7Bw%7D for {w}, is the same template, and is filled in.

---

width?

readonly optional width?: number | null;

Defined in: artwork.ts:15

The widest the image comes, in pixels. No image larger than it comes is asked for. This is data, never an error: a value that is no size, such as null, zero or text, is taken as not given. Artwork that gives only one of width and height is held to that one, and artwork that gives neither is taken to be square.