Application Load

IBlogPostPreview

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IBlogPostPreview

Blog publication preview fields consumed by the storefront.

app/interfaces/orionplace/blog/IBlogPostPreview.ts
TypeScript
export interface IBlogPostPreview {
  // Publication ID.
  id: number;
  // Localized title, slug and preview text.
  locale: Record<
    string,
    {
      // Optional value of post_title; it may be omitted.
      post_title?: string;
      // Optional value of post_slug; it may be omitted.
      post_slug?: string;
      // Optional value of post_preview_text; it may be omitted.
      post_preview_text?: string;
    }
  >;
  // Preview images with display order.
  preview_images?: { /* Publication ID. */ id: number; /* Value of image_url. */ image_url: string; /* Value of display_order. */ display_order: number }[];
  // Fallback preview image URLs.
  preview_image_urls?: string[];
  // Estimated reading time in minutes.
  read_time_min?: number;
  // Access type: a named `EBlogAccessType` value in `int` with its localized
  // `text`. The card shows a Subscription label when `int` is not
  // `EBlogAccessType.ACCESS_PUBLIC`.
  access_type?: {
    // Named `EBlogAccessType` value.
    int: EBlogAccessType;
    // Localized access type name.
    text: string;
  };
  // Publication creation time; the card shows its `date`.
  date_created?: IApiDateTime;
}