@archastro/sdk
    Preparing search index...

    Interface ImageSource

    Resolved metadata for an image, including its delivery URL, dimensions, and optional references to the underlying storage file or media record.

    interface ImageSource {
        file?: string | null;
        height?: number | null;
        media?: string | null;
        mime_type?: string | null;
        refresh_url?: string | null;
        url?: string | null;
        width?: number | null;
    }
    Index

    Properties

    file? height? media? mime_type? refresh_url? url? width?

    Properties

    file?: string | null

    ID of the underlying storage file (fil_...). null when the image is not backed by a platform storage file.

    height?: number | null

    Height of the image in pixels. null if not known.

    media?: string | null

    ID of the associated media record (med_...). null when the image is not linked to a media entity.

    mime_type?: string | null

    MIME type of the image, e.g. "image/png" or "image/jpeg". null if not known.

    refresh_url?: string | null

    Endpoint URL you can call to obtain a fresh signed url when the current one has expired. null if the URL does not require refreshing.

    url?: string | null

    Signed or public URL for downloading the image. May be time-limited; use refresh_url to obtain a new URL when this one expires.

    width?: number | null

    Width of the image in pixels. null if not known.

    Settings

    Member Visibility

    On This Page

    Properties