Interface Posts

Interface for retrieving blog posts.

Provides methods for paginated access and individual entry retrieval.

interface Posts {
    createsThumbnail(source: BasePostEntry, size: number | ImageSize<number>, ratio?: string | number): string;
    withCategories(options: WithCategoriesPostsOptionsSummary): Promise<WithCategoriesPostsResultSummary>;
    withCategories(options: WithCategoriesPostsOptions<PostsFeedOptions<FeedRoute>>): Promise<WithCategoriesPostsResult>;
    byId<R>(options: ByIdPostsOptions<R>): Promise<ByIdResult<"posts", R>>;
    byId(options: ByIdPostsOptionsSummary): Promise<PostsEntryBlogSummary>;
    (options: PostsOptionsSummary): Promise<PostsHandler<"summary">>;
    <R>(options: PostsOptions<R>): Promise<PostsHandler<R>>;
}

Posts(options): Promise<PostsHandler<"summary">>
Creates a handler for paginated access to blog posts using the summary route.
Parameters
- options: PostsOptionsSummary
  Configuration options for the summary posts retrieval
Returns Promise<PostsHandler<"summary">>
- Defined in types/posts.ts:117
Posts<R>(options): Promise<PostsHandler<R>>
Creates a handler for paginated access to blog posts.
Type Parameters
- R extends FeedRoute = FeedRoute
  The route type (summary or full)
Parameters
- options: PostsOptions<R>
  Configuration options for the posts retrieval
Returns Promise<PostsHandler<R>>
- Defined in types/posts.ts:123

Index

Methods

createsThumbnail withCategories byId

Methods

createsThumbnail

createsThumbnail(source, size, ratio?): string
Creates the thumbnail url of a post.
Parameters
- source: BasePostEntry
  The post source.
- size: number | ImageSize<number>
  The size of the thumbnail.
- Optionalratio: string | number
  The ratio of the thumbnail.
Returns string
The thumbnail url.
- Defined in types/posts.ts:132

withCategories

withCategories(options): Promise<WithCategoriesPostsResultSummary>
Retrieves the posts from the summary with the given categories.

All posts are retrieved, but it is sliced by the value of the max-results parameter.
Parameters
- options: WithCategoriesPostsOptionsSummary
  The request options.
Returns Promise<WithCategoriesPostsResultSummary>
- Defined in types/posts.ts:140
withCategories(options): Promise<WithCategoriesPostsResult>
Retrieves the posts from the default route with the given categories.

All posts are retrieved, but it is sliced by the value of the max-results parameter.
Parameters
- options: WithCategoriesPostsOptions<PostsFeedOptions<FeedRoute>>
  The request options.
Returns Promise<WithCategoriesPostsResult>
- Defined in types/posts.ts:148

byId

byId<R>(options): Promise<ByIdResult<"posts", R>>
Retrieves a specific page by its ID with route control.
Type Parameters
- R extends FeedRoute = FeedRoute
  The route type (summary or full)
Parameters
- options: ByIdPostsOptions<R>
  Configuration options including the page ID
Returns Promise<ByIdResult<"posts", R>>
- Defined in types/posts.ts:155
byId(options): Promise<PostsEntryBlogSummary>
Retrieves a specific page by its ID using the summary route.
Parameters
- options: ByIdPostsOptionsSummary
  Configuration options including the page ID
Returns Promise<PostsEntryBlogSummary>
- Defined in types/posts.ts:161