next/dist/lib/metadata/types/twitter-types.d.ts

The React Framework

import type { AbsoluteTemplateString, TemplateString } from './metadata-types';
export type Twitter = TwitterSummary | TwitterSummaryLargeImage | TwitterPlayer | TwitterApp | TwitterMetadata;
type TwitterMetadata = {
    site?: string | undefined;
    siteId?: string | undefined;
    creator?: string | undefined;
    creatorId?: string | undefined;
    description?: string | undefined;
    title?: string | TemplateString | undefined;
    images?: TwitterImage | Array<TwitterImage> | undefined;
};
type TwitterSummary = TwitterMetadata & {
    card: 'summary';
};
type TwitterSummaryLargeImage = TwitterMetadata & {
    card: 'summary_large_image';
};
type TwitterPlayer = TwitterMetadata & {
    card: 'player';
    players: TwitterPlayerDescriptor | Array<TwitterPlayerDescriptor>;
};
type TwitterApp = TwitterMetadata & {
    card: 'app';
    app: TwitterAppDescriptor;
};
export type TwitterAppDescriptor = {
    id: {
        iphone?: string | number | undefined;
        ipad?: string | number | undefined;
        googleplay?: string | undefined;
    };
    url?: {
        iphone?: string | URL | undefined;
        ipad?: string | URL | undefined;
        googleplay?: string | URL | undefined;
    } | undefined;
    name?: string | undefined;
};
type TwitterImage = string | TwitterImageDescriptor | URL;
type TwitterImageDescriptor = {
    url: string | URL;
    alt?: string | undefined;
    secureUrl?: string | URL | undefined;
    type?: string | undefined;
    width?: string | number | undefined;
    height?: string | number | undefined;
};
type TwitterPlayerDescriptor = {
    playerUrl: string | URL;
    streamUrl: string | URL;
    width: number;
    height: number;
};
type ResolvedTwitterImage = {
    url: string | URL;
    alt?: string | undefined;
    secureUrl?: string | URL | undefined;
    type?: string | undefined;
    width?: string | number | undefined;
    height?: string | number | undefined;
};
type ResolvedTwitterSummary = {
    site: string | null;
    siteId: string | null;
    creator: string | null;
    creatorId: string | null;
    description: string | null;
    title: AbsoluteTemplateString;
    images?: Array<ResolvedTwitterImage> | undefined;
};
type ResolvedTwitterPlayer = ResolvedTwitterSummary & {
    players: Array<TwitterPlayerDescriptor>;
};
type ResolvedTwitterApp = ResolvedTwitterSummary & {
    app: TwitterAppDescriptor;
};
export type ResolvedTwitterMetadata = ({
    card: 'summary';
} & ResolvedTwitterSummary) | ({
    card: 'summary_large_image';
} & ResolvedTwitterSummary) | ({
    card: 'player';
} & ResolvedTwitterPlayer) | ({
    card: 'app';
} & ResolvedTwitterApp);
export {};