Function feed

Readonlyraw

all

• all<T>(options): Promise<T extends "posts"
      ? PostsBlogSummary
      : T extends "comments"
          ? CommentsBlogSummary
          : T extends "pages"
              ? PagesBlogSummary
              : never>

• Recursively fetches all entries from a summary feed.

  Makes multiple API requests as needed to retrieve the complete dataset.

  Type Parameters

  • T extends FeedType = FeedType

    The feed type (posts, comments, or pages)

  Parameters

  • options: FeedOptionsSummary<T>

    Configuration options for the feed request

  Returns Promise<T extends "posts"
      ? PostsBlogSummary
      : T extends "comments"
          ? CommentsBlogSummary
          : T extends "pages"
              ? PagesBlogSummary
              : never>

  Remarks

  The returned JSON represents the last request's data with accumulated entries

• all<T, R>(options): Promise<FeedResult<T, R, PostsBlogSummary, CommentsBlogSummary, PagesBlogSummary, PostsBlog, CommentsBlog, PostsBlog>>

• Recursively fetches all entries from a full content feed.

  Makes multiple API requests as needed to retrieve the complete dataset.

  Type Parameters

  • T extends FeedType = FeedType

    The feed type (posts, comments, or pages)
  • R extends FeedRoute = FeedRoute

    The feed route (summary or default)

  Parameters

  • options: FeedOptions<T, R>

    Configuration options for the feed request

  Returns Promise<FeedResult<T, R, PostsBlogSummary, CommentsBlogSummary, PagesBlogSummary, PostsBlog, CommentsBlog, PostsBlog>>

  Remarks

  The returned JSON represents the last request's data with accumulated entries

byId

• byId<T, R>(options): Promise<FeedResult<T, R, PostsEntryBlogSummary, CommentsBlogSummary, PagesEntryBlogSummary, PostsEntryBlog, CommentsBlog, PagesEntryBlog>>

• Fetches a single entry by ID with full content.

  Type Parameters

  • T extends FeedType = FeedType

    The feed type (posts, comments, or pages)
  • R extends FeedRoute = FeedRoute

    The feed route (summary or default)

  Parameters

  • options: FeedByIdOptions<T, R>

    Configuration options including the entry ID

  Returns Promise<FeedResult<T, R, PostsEntryBlogSummary, CommentsBlogSummary, PagesEntryBlogSummary, PostsEntryBlog, CommentsBlog, PagesEntryBlog>>

  Since

  1.2

• byId<T>(options): Promise<T extends "posts"
      ? PostsEntryBlogSummary
      : T extends "comments"
          ? CommentsBlogSummary
          : T extends "pages"
              ? PagesEntryBlogSummary
              : never>

• Fetches a single entry by ID with summary content.

  Type Parameters

  • T extends FeedType = FeedType

    The feed type (posts, comments, or pages)

  Parameters

  • options: FeedByIdOptionsSummary<T>

    Configuration options including the entry ID

  Returns Promise<T extends "posts"
      ? PostsEntryBlogSummary
      : T extends "comments"
          ? CommentsBlogSummary
          : T extends "pages"
              ? PagesEntryBlogSummary
              : never>

  Since

  1.2