Interface PostsHandler<R>

Interface for handling paginated blog posts.

interface PostsHandler<R> {
    categories: string[];
    total: number;
    page(this: PostsHandler<R>, page: number): Promise<FeedResult<"posts", R, EntriesResult<PostEntrySummary, PostsBlogSummary>, {
        entries: CommentEntrySummary[];
        blog: CommentsBlogSummary;
    }, {
        entries: PageEntrySummary[];
        blog: PagesBlogSummary;
    }, EntriesResult<PostEntry, PostsBlog>, {
        entries: CommentEntry[];
        blog: CommentsBlog;
    }, {
        entries: PageEntry[];
        blog: PagesBlog;
    }>>;
}

Type Parameters

R extends FeedRoute = FeedRoute
The route type (summary or full)

Hierarchy (view full)

EntriesHandler<"posts", R, PostsHandler<R>>
- PostsHandler

Index

Properties

categories total

Methods

Properties

`Readonly`categories

categories: string[]

The categories with which the posts has been tagged.

Since

1.2

`Readonly`total

total: number

The total number of entries available in the blog feed.

Methods

page

page(this, page): Promise<FeedResult<"posts", R, EntriesResult<PostEntrySummary, PostsBlogSummary>, {
    entries: CommentEntrySummary[];
    blog: CommentsBlogSummary;
}, {
    entries: PageEntrySummary[];
    blog: PagesBlogSummary;
}, EntriesResult<PostEntry, PostsBlog>, {
    entries: CommentEntry[];
    blog: CommentsBlog;
}, {
    entries: PageEntry[];
    blog: PagesBlog;
}>>
Retrieves entries from a specific page of the blog feed.
Parameters
- this: PostsHandler<R>
- page: number
  The 1-based page number to retrieve
Returns Promise<FeedResult<"posts", R, EntriesResult<PostEntrySummary, PostsBlogSummary>, {
    entries: CommentEntrySummary[];
    blog: CommentsBlogSummary;
}, {
    entries: PageEntrySummary[];
    blog: PagesBlogSummary;
}, EntriesResult<PostEntry, PostsBlog>, {
    entries: CommentEntry[];
    blog: CommentsBlog;
}, {
    entries: PageEntry[];
    blog: PagesBlog;
}>>
Inherited from EntriesHandler.page
- Defined in types/entries.ts:72