next/dist/shared/lib/image-config.d.ts

The React Framework

export declare const VALID_LOADERS: readonly ["default", "imgix", "cloudinary", "akamai", "custom"];
export type LoaderValue = (typeof VALID_LOADERS)[number];
export type ImageLoaderProps = {
    src: string;
    width: number;
    quality?: number;
};
export type ImageLoaderPropsWithConfig = ImageLoaderProps & {
    config: Readonly<ImageConfig>;
};
export type LocalPattern = {
    /**
     * Can be literal or wildcard.
     * Single `*` matches a single path segment.
     * Double `**` matches any number of path segments.
     */
    pathname?: string;
    /**
     * Can be literal query string such as `?v=1` or
     * empty string meaning no query string.
     */
    search?: string;
};
export type RemotePattern = {
    /**
     * Must be `http` or `https`.
     */
    protocol?: 'http' | 'https';
    /**
     * Can be literal or wildcard.
     * Single `*` matches a single subdomain.
     * Double `**` matches any number of subdomains.
     */
    hostname: string;
    /**
     * Can be literal port such as `8080` or empty string
     * meaning no port.
     */
    port?: string;
    /**
     * Can be literal or wildcard.
     * Single `*` matches a single path segment.
     * Double `**` matches any number of path segments.
     */
    pathname?: string;
    /**
     * Can be literal query string such as `?v=1` or
     * empty string meaning no query string.
     */
    search?: string;
};
type ImageFormat = 'image/avif' | 'image/webp';
/**
 * Image configurations
 *
 * @see [Image configuration options](https://nextjs.org/docs/api-reference/next/image#configuration-options)
 */
export type ImageConfigComplete = {
    /** @see [Device sizes documentation](https://nextjs.org/docs/api-reference/next/image#device-sizes) */
    deviceSizes: number[];
    /** @see [Image sizing documentation](https://nextjs.org/docs/app/building-your-application/optimizing/images#image-sizing) */
    imageSizes: number[];
    /** @see [Image loaders configuration](https://nextjs.org/docs/api-reference/next/legacy/image#loader) */
    loader: LoaderValue;
    /** @see [Image loader configuration](https://nextjs.org/docs/app/api-reference/components/image#path) */
    path: string;
    /** @see [Image loader configuration](https://nextjs.org/docs/api-reference/next/image#loader-configuration) */
    loaderFile: string;
    /**
     * @deprecated Use `remotePatterns` instead.
     */
    domains: string[];
    /** @see [Disable static image import configuration](https://nextjs.org/docs/api-reference/next/image#disable-static-imports) */
    disableStaticImages: boolean;
    /** @see [Cache behavior](https://nextjs.org/docs/api-reference/next/image#caching-behavior) */
    minimumCacheTTL: number;
    /** @see [Acceptable formats](https://nextjs.org/docs/api-reference/next/image#acceptable-formats) */
    formats: ImageFormat[];
    /** @see [Maximum Disk Cache Size (in bytes)](https://nextjs.org/docs/api-reference/next/image#maximumdiskcachesize) */
    maximumDiskCacheSize: number | undefined;
    /** @see [Maximum Redirects](https://nextjs.org/docs/api-reference/next/image#maximumredirects) */
    maximumRedirects: number;
    /** @see [Maximum Response Body](https://nextjs.org/docs/api-reference/next/image#maximumresponsebody) */
    maximumResponseBody: number;
    /** @see [Dangerously Allow Local IP](https://nextjs.org/docs/api-reference/next/image#dangerously-allow-local-ip) */
    dangerouslyAllowLocalIP: boolean;
    /** @see [Dangerously Allow SVG](https://nextjs.org/docs/api-reference/next/image#dangerously-allow-svg) */
    dangerouslyAllowSVG: boolean;
    /** @see [Content Security Policy](https://nextjs.org/docs/api-reference/next/image#contentsecuritypolicy) */
    contentSecurityPolicy: string;
    /** @see [Content Disposition Type](https://nextjs.org/docs/api-reference/next/image#contentdispositiontype) */
    contentDispositionType: 'inline' | 'attachment';
    /** @see [Remote Patterns](https://nextjs.org/docs/api-reference/next/image#remotepatterns) */
    remotePatterns: Array<URL | RemotePattern>;
    /** @see [Local Patterns](https://nextjs.org/docs/api-reference/next/image#localPatterns) */
    localPatterns: LocalPattern[] | undefined;
    /** @see [Qualities](https://nextjs.org/docs/api-reference/next/image#qualities) */
    qualities: number[] | undefined;
    /** @see [Unoptimized](https://nextjs.org/docs/api-reference/next/image#unoptimized) */
    unoptimized: boolean;
    /**
     * When true, the `cacheHandler` configured in next.config.js will also be used
     * for caching optimized images. When false, images use the default filesystem cache.
     * @see [Image Optimization Caching](https://nextjs.org/docs/app/api-reference/config/next-config-js/cacheHandler#image-optimization-caching)
     */
    customCacheHandler: boolean;
};
export type ImageConfig = Partial<ImageConfigComplete>;
type RequiredImageConfigForRendering = Pick<ImageConfigComplete, 'deviceSizes' | 'imageSizes' | 'loader' | 'path' | 'dangerouslyAllowSVG' | 'unoptimized'>;
export type ImageConfigForRendering = RequiredImageConfigForRendering & Partial<Pick<ImageConfigComplete, 'qualities' | 'domains' | 'remotePatterns' | 'localPatterns'>> & {
    output?: 'standalone' | 'export';
};
export type PreparedImageConfig = RequiredImageConfigForRendering & {
    allSizes: number[];
    qualities: ImageConfigComplete['qualities'];
    domains: ImageConfigComplete['domains'] | undefined;
    remotePatterns: ImageConfigComplete['remotePatterns'] | undefined;
    localPatterns: ImageConfigComplete['localPatterns'];
    output: 'standalone' | 'export' | undefined;
};
/**
 * Prepare owned, sorted image options once for each env/context pair.
 * Changed options require new objects because results are cached by identity.
 */
export declare function prepareImageConfig(envConfig?: ImageConfigForRendering, contextConfig?: ImageConfigComplete): PreparedImageConfig;
export declare const imageConfigDefault: ImageConfigComplete;
export {};