GitHub
Preparing search index...
The search index is not available
feeddy - v1.2
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
feeddy
types/feeds/entry
BaseEntryBlog
Interface BaseEntryBlog<T>
interface
BaseEntryBlog
<
T
>
{
version
:
string
;
encoding
:
string
;
entry
:
T
;
}
Type Parameters
T
extends
BaseEntry
=
BaseEntry
Hierarchy (
view full
)
BaseEntryBlog
PagesEntryBlog
PagesEntryBlogSummary
PostsEntryBlog
PostsEntryBlogSummary
Index
Properties
version
encoding
entry
Properties
version
version
:
string
encoding
encoding
:
string
The blog encoding.
entry
entry
:
T
The entry retrieved.
On This Page
Properties
version
encoding
entry
GitHub
feeddy -
v1.2
index
search
Utility for building search queries and parameters for blog feed requests.
routes
Helper containing relative sub-routes for the blog feed API.
posts
Handler for paginated access to blog posts.
entries
Generic handler for paginated access to blog entries.
pages
Handler for paginated access to blog pages.
comments
Handler for paginated access to blog comments.
feed
The handler to make mapped requests to the blogger feed API.
build
Url
Builds a request URL for the blog feed API based on provided options.
get
Id
Extracts the numeric ID from a blog entry identifier string or object.
types/feeds/author
Author
Represents an author in the blog.
types/feeds/comments
Base
Comment
Entry
Base interface for a comment entry in its mapped form.
Comment
Entry
Comment entry that includes the full content of the comment.
Comment
Entry
Summary
Comment entry that includes only a summary of the comment.
Comments
Feed
Feed containing a collection of full comment entries.
Comments
Feed
Summary
Feed containing a collection of comment summaries.
Comments
Blog
Blog object containing a feed of full comments.
Comments
Blog
Summary
Blog object containing a feed of comment summaries.
types/feeds/entry
With
Content
With
Summary
Base
Entry
Base
Simple
Feed
Base
Feed
Base
Blog
Base
Entry
Blog
Simple
Text
types/feeds
Feed
Interface defining methods for interacting with mapped Blogger feeds.
Result
Represents the result type for feed requests, mapping feed types and routes to their corresponding blog types.
By
Id
Result
Represents the result type for feed-by-ID requests, mapping feed types and routes to their corresponding blog entry types.
types/feeds/options
Base
Feed
Options
Inner
Feed
Options
Base interface for options that contain feed configuration.
Feed
By
Id
Options
The options for configuring a blog feed request by ID.
Feed
By
Id
Options
Summary
The options for configuring a summary blog feed request by ID.
Feed
Route
The route options of the blog's feed.
Feed
Type
The type options of the blog's feed.
Feed
Options
The options for configuring a blog feed request.
Feed
Options
Summary
The options for configuring a summary blog feed request.
Feed
Result
Determines what result will be obtained according to the route and type of feed.
types/feeds/pages
Page
Entry
Page entry that includes the full content of the page.
Page
Entry
Summary
Page entry that includes only a summary of the page.
Pages
Feed
Feed containing a collection of full page entries.
Pages
Feed
Summary
Feed containing a collection of page summaries.
Pages
Blog
Blog object containing a feed of full pages.
Pages
Blog
Summary
Blog object containing a feed of page summaries.
Pages
Entry
Blog
Blog entry object containing a single full page entry.
Pages
Entry
Blog
Summary
Blog entry object containing a single page entry summary.
types/feeds/posts
Base
Post
Entry
Base interface for a post-entry in its mapped form.
Post
Entry
Post-entry that includes the full content of the post.
Post
Entry
Summary
Post-entry that includes only a summary of the post.
Base
Posts
Feed
Base interface for a feed containing post-entries in its mapped form from the API.
Posts
Feed
Feed containing a collection of full post-entries.
Posts
Feed
Summary
Feed containing a collection of post-summaries.
Posts
Blog
Blog object containing a feed of full posts.
Posts
Blog
Summary
Blog object containing a feed of post summaries.
Posts
Entry
Blog
Blog entry object containing a single full post-entry.
Posts
Entry
Blog
Summary
Blog entry object containing a single post-entry summary.
Post
Thumbnail
Represents the thumbnail of a blog post.
types/feeds/raw
Raw
With
Summary
Raw
With
Content
Raw
Feed
Interface defining methods for interacting with raw Blogger feeds.
Raw
Result
Represents the result type for raw feed requests, mapping feed types and routes to their corresponding blog types.
Raw
By
Id
Result
Represents the result type for raw feed-by-ID requests, mapping feed types and routes to their corresponding blog entry types.
types/feeds/raw/author
Raw
Author
Represents an author in the blog.
Raw
Author
Image
Represents the image of an author in the blog.
types/feeds/raw/comments
Raw
Comment
Reply
Represents a link to the comment being replied to.
Raw
Base
Comment
Entry
Base interface for a comment entry in its raw form from the API.
Raw
Comment
Entry
Raw comment entry that includes the full content of the comment.
Raw
Comment
Entry
Summary
Raw comment entry that includes only a summary of the comment.
Raw
Comments
Feed
Raw feed containing a collection of full comment entries.
Raw
Comments
Feed
Summary
Raw feed containing a collection of comment summaries.
Raw
Comments
Blog
Raw blog object containing a feed of full comments.
Raw
Comments
Blog
Summary
Raw blog object containing a feed of comment summaries.
types/feeds/raw/entry
Raw
Link
Represents a link in the blog.
Raw
Entry
Link
Represents a link of a blog entry.
Raw
Source
Link
Represents a link in the blog.
Raw
Base
Entry
Raw
Base
Simple
Feed
Raw
Base
Feed
Raw
Base
Entry
Blog
Raw
Base
Blog
Raw
With
Content
Raw
With
Summary
Raw
Text
A string on blog's feed.
Raw
Text
Title
A title on blog's feed.
Raw
Text
Content
A content on blog's feed.
Raw
Category
A category on blog's feed.
types/feeds/raw
Raw
Result
Raw
By
Id
Result
Raw
Feed
Raw
With
Summary
Raw
With
Content
types/feeds/raw/pages
Raw
Page
Entry
Raw page entry that includes the full content of the page.
Raw
Page
Entry
Summary
Raw page entry that includes only a summary of the page.
Raw
Pages
Feed
Raw feed containing a collection of full page entries.
Raw
Pages
Feed
Summary
Raw feed containing a collection of page summaries.
Raw
Pages
Blog
Raw blog object containing a feed of full pages.
Raw
Pages
Blog
Summary
Raw blog object containing a feed of page summaries.
Raw
Pages
Entry
Blog
Raw blog entry object containing a single full page entry.
Raw
Pages
Entry
Blog
Summary
Raw blog entry object containing a single page entry summary.
types/feeds/raw/posts
Raw
Post
Category
Represents a category of a blog entry.
Raw
Base
Post
Entry
Base interface for a post-entry in its raw form from the API.
Raw
Post
Entry
Raw post-entry that includes the full content of the post.
Raw
Post
Entry
Summary
Raw post-entry that includes only a summary of the post.
Raw
Base
Posts
Feed
Base interface for a feed containing post-entries in its raw form from the API.
Raw
Posts
Feed
Raw feed containing a collection of full post-entries.
Raw
Posts
Feed
Summary
Raw feed containing a collection of post-summaries.
Raw
Posts
Blog
Raw blog object containing a feed of full posts.
Raw
Posts
Blog
Summary
Raw blog object containing a feed of post summaries.
Raw
Posts
Entry
Blog
Raw blog entry object containing a single full post-entry.
Raw
Posts
Entry
Blog
Summary
Raw blog entry object containing a single post-entry summary.
Raw
Post
Thumbnail
Represents the thumbnail of a blog post.
types/feeds/shared
Routes
Image
Size
Query
Operator
The operator of a query.
Link
Rel
The relationship of a link.
types/feeds/shared
Image
Size
Query
Operator
Link
Rel
Routes
types/feeds/shared/params
Request
Feed
Params
Order
By
The order by options for the feed request.
Alt
The alternative representation type options.
types/posts
With
Categories
Post
With
Categories
Posts
Options
Base interface for options that contain feed configuration.
With
Categories
Posts
Result
With
Categories
Posts
Result
Summary
Posts
Handler
Interface for handling paginated blog posts.
Posts
Interface for retrieving blog posts.
With
Categories
Post
Summary
With
Categories
Posts
Options
Summary
Posts
Feed
Options
The options for configuring a blog feed posts request.
Posts
Feed
Options
Summary
The options for configuring a summary blog posts feed request.
Posts
Options
Options for configuring posts retrieval with route control.
Posts
Options
Summary
Options for configuring posts retrieval using the summary route.
By
Id
Posts
Options
The options for configuring a blog feed posts request by ID.
By
Id
Posts
Options
Summary
The options for configuring a summary blog posts feed request by ID.
types/comments
Comments
Handler
Interface for handling paginated blog comments.
Comments
Interface for retrieving blog comments.
Comments
Feed
Options
The options for configuring a blog feed comments request.
Comments
Feed
Options
Summary
The options for configuring a summary blog comments feed request.
By
Id
Comments
Options
The options for configuring a blog feed comments request by ID.
By
Id
Comments
Options
Summary
The options for configuring a summary blog comments feed request by ID.
Comments
Options
Options for configuring comments retrieval with route control.
Comments
Options
Summary
Options for configuring comments retrieval using the summary route.
types/entries
Entries
Handler
Interface for handling paginated blog entries.
Entries
Interface for retrieving blog entries.
Entries
Result
Represents the result of retrieving entries from a blog feed.
Entries
Handler
Result
The result type for an entries handler, determined by the feed type and route.
Entries
Options
Options for configuring entries retrieval with route control.
Entries
Options
Summary
Options for configuring entries retrieval using the summary route.
Entries
Simple
Options
Basic options for configuring entries retrieval with minimal requirements.
Entries
Handler
Simple
Extra
Function type for add custom properties to the entries handler.
Entries
Handler
Extra
Type for handling additional transformations based on feed type and route.
types/pages
Pages
Handler
Interface for handling paginated blog pages.
Pages
Interface for retrieving blog pages.
Pages
Feed
Options
The options for configuring a blog feed pages request.
Pages
Feed
Options
Summary
The options for configuring a summary blog pages feed request.
Pages
Options
Options for configuring pages retrieval with route control.
Pages
Options
Summary
Options for configuring pages retrieval using the summary route.
By
Id
Pages
Options
The options for configuring a blog feed pages request by ID.
By
Id
Pages
Options
Summary
The options for configuring a summary blog pages feed request by ID.
types/search
Search
Params
Builder
Search
Params
The class for managing search parameters.
Search
Interface for search functionality in the blog API.
Query
String
Builder
Search
Params
Builder
Constructor
Search
Params
Constructor
Query
String
Builder
Constructor
Query
String
Builder
The blog encoding.