Interface Pages

Interface for retrieving blog pages.

Provides methods for paginated access and individual entry retrieval.

interface Pages {
    byId<R>(options: ByIdPagesOptions<R>): Promise<ByIdResult<"pages", R>>;
    byId(options: ByIdPagesOptionsSummary): Promise<PagesEntryBlogSummary>;
    <R>(options: PagesOptions<R>): Promise<PagesHandler<R>>;
    (options: PagesOptionsSummary): Promise<PagesHandler<"summary">>;
}

Pages<R>(options): Promise<PagesHandler<R>>
Creates a handler for paginated access to blog pages.
Type Parameters
- R extends FeedRoute = FeedRoute
  The route type (summary or full)
Parameters
- options: PagesOptions<R>
  Configuration options for the pages retrieval
Returns Promise<PagesHandler<R>>
- Defined in types/pages.ts:60
Pages(options): Promise<PagesHandler<"summary">>
Creates a handler for paginated access to blog pages using the summary route.
Parameters
- options: PagesOptionsSummary
  Configuration options for the summary pages retrieval
Returns Promise<PagesHandler<"summary">>
- Defined in types/pages.ts:66

Index

Methods

Methods

byId

byId<R>(options): Promise<ByIdResult<"pages", 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: ByIdPagesOptions<R>
  Configuration options including the page ID
Returns Promise<ByIdResult<"pages", R>>
- Defined in types/pages.ts:73
byId(options): Promise<PagesEntryBlogSummary>
Retrieves a specific page by its ID using the summary route.
Parameters
- options: ByIdPagesOptionsSummary
  Configuration options including the page ID
Returns Promise<PagesEntryBlogSummary>
- Defined in types/pages.ts:79