`IBlogReadingData`

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

IBlogReadingData

Premium reading counters.

app/interfaces/orionplace/blog/IBlogApi.ts

TypeScript

export interface IBlogReadingData {
  // Post ID.
  post: number;
  // Total credited reading seconds for this post and subscription period,
  // capped at the article maximum.
  read_seconds: number;
  // Seconds added by this request. Start always returns zero; heartbeat can
  // also return zero.
  credited_seconds: number;
  // Maximum creditable time: the post’s `read_time_min` multiplied by 60.
  max_read_seconds: number;
  // Remaining seconds before reaching the maximum, never negative.
  remaining_seconds: number;
  // Whether the credited total has reached the maximum.
  complete: boolean;
  // Suggested interval between `blog_reading_heartbeat` requests, in seconds.
  heartbeat_interval_seconds: number;
}