Interface Comments

Interface for retrieving blog comments.

Provides methods for paginated access and individual entry retrieval.

interface Comments {
    byId<R>(options: ByIdCommentsOptions<R>): Promise<CommentsHandler<R>>;
    byId(options: ByIdCommentsOptionsSummary): Promise<CommentsHandler<"summary">>;
    <R>(options: CommentsOptions<R>): Promise<CommentsHandler<R>>;
    (options: CommentsOptionsSummary): Promise<CommentsHandler<"summary">>;
}

Comments<R>(options): Promise<CommentsHandler<R>>
Creates a handler for paginated access to blog comments.
Type Parameters
- R extends FeedRoute = FeedRoute
  The route type (summary or full)
Parameters
- options: CommentsOptions<R>
  Configuration options for the comments retrieval
Returns Promise<CommentsHandler<R>>
- Defined in types/comments.ts:59
Comments(options): Promise<CommentsHandler<"summary">>
Creates a handler for paginated access to blog comments using the summary route.
Parameters
- options: CommentsOptionsSummary
  Configuration options for the summary comments retrieval
Returns Promise<CommentsHandler<"summary">>
- Defined in types/comments.ts:65

Index

Methods

Methods

byId

byId<R>(options): Promise<CommentsHandler<R>>
Creates a handler for paginated access to a specific entry comments by its ID with route control.
Type Parameters
- R extends FeedRoute = FeedRoute
  The route type (summary or full)
Parameters
- options: ByIdCommentsOptions<R>
  Configuration options including the entry ID
Returns Promise<CommentsHandler<R>>
- Defined in types/comments.ts:72
byId(options): Promise<CommentsHandler<"summary">>
Creates a handler for paginated access to a specific entry comments by its ID using the summary route.
Parameters
- options: ByIdCommentsOptionsSummary
  Configuration options including the entry ID
Returns Promise<CommentsHandler<"summary">>
- Defined in types/comments.ts:78