Class MinifluxClient

MinifluxClient provides a TypeScript interface to interact with the Miniflux RSS reader API. It supports both API key and password authentication methods.

Constructors

constructor

new MinifluxClient(config: MinifluxConfig): MinifluxClient
Creates a new MinifluxClient instance.
Parameters
- config: MinifluxConfig
  Configuration object for the client
Returns MinifluxClient
Throws
When required authentication parameters are missing
- Defined in client.ts:32

Methods

createCategory

createCategory(title: string): Promise<Category>
Creates a new category.
Parameters
- title: string
  Title of the category
Returns Promise<Category>
Promise resolving to the created category
- Defined in client.ts:318

createFeed

createFeed(feedUrl: string, categoryId?: number): Promise<Feed>
Creates a new feed.
Parameters
- feedUrl: string
  URL of the feed to create
- OptionalcategoryId: number
  Optional category ID to assign the feed to
Returns Promise<Feed>
Promise resolving to the created feed
- Defined in client.ts:134

createUser

createUser(username: string, password: string, isAdmin: boolean): Promise<User>
Creates a new user (admin only).
Parameters
- username: string
  Username for the new user
- password: string
  Password for the new user
- isAdmin: boolean
  Whether the new user should have admin privileges
Returns Promise<User>
Promise resolving to the created user
- Defined in client.ts:442

deleteCategory

deleteCategory(categoryId: number): Promise<void>
Deletes a category.
Parameters
- categoryId: number
  ID of the category to delete
Returns Promise<void>
- Defined in client.ts:342

deleteFeed

deleteFeed(feedId: number): Promise<void>
Deletes a feed.
Parameters
- feedId: number
  ID of the feed to delete
Returns Promise<void>
- Defined in client.ts:148

deleteUser

deleteUser(userId: number): Promise<void>
Deletes a user (admin only).
Parameters
- userId: number
  ID of the user to delete
Returns Promise<void>
- Defined in client.ts:470

fetchContent

fetchContent(entryId: number): Promise<{ content: string }>
Fetches the original content of an entry.
Parameters
- entryId: number
  ID of the entry
Returns Promise<{ content: string }>
Promise resolving to the entry content
- Defined in client.ts:278

getCategories

getCategories(): Promise<Category[]>
Retrieves all categories.

Returns Promise<Category[]>
Promise resolving to an array of categories
- Defined in client.ts:309

getCategoryEntries

getCategoryEntries(categoryId: number, filter?: Filter): Promise<EntryResultSet>
Retrieves entries for a specific category.
Parameters
- categoryId: number
  ID of the category
- Optionalfilter: Filter
  Optional filter parameters
Returns Promise<EntryResultSet>
Promise resolving to the filtered entries
- Defined in client.ts:360

getCounters

getCounters(): Promise<FeedCounters>
Retrieves read/unread counters for feeds.

Returns Promise<FeedCounters>
Promise resolving to feed counters
- Defined in client.ts:504

getEnclosure

getEnclosure(enclosureId: number): Promise<Enclosure>
Retrieves an enclosure.
Parameters
- enclosureId: number
  ID of the enclosure
Returns Promise<Enclosure>
Promise resolving to the enclosure details
- Defined in client.ts:392

getEntries

getEntries(filter?: Filter): Promise<EntryResultSet>
Retrieves entries based on filter criteria.
Parameters
- Optionalfilter: Filter
  Optional filter parameters
Returns Promise<EntryResultSet>
Promise resolving to the filtered entries
- Defined in client.ts:227

getEntry

getEntry(entryId: number): Promise<Entry>
Retrieves a specific entry.
Parameters
- entryId: number
  ID of the entry to retrieve
Returns Promise<Entry>
Promise resolving to the entry details
- Defined in client.ts:249

getFeed

getFeed(feedId: number): Promise<Feed>
Retrieves a specific feed by ID.
Parameters
- feedId: number
  ID of the feed to retrieve
Returns Promise<Feed>
Promise resolving to the feed details
- Defined in client.ts:124

getFeedEntries

getFeedEntries(feedId: number, filter?: Filter): Promise<EntryResultSet>
Retrieves entries for a specific feed.
Parameters
- feedId: number
  ID of the feed
- Optionalfilter: Filter
  Optional filter parameters
Returns Promise<EntryResultSet>
Promise resolving to the filtered entries
- Defined in client.ts:175

getFeedIcon

getFeedIcon(feedId: number): Promise<FeedIcon>
Retrieves the icon for a feed.
Parameters
- feedId: number
  ID of the feed
Returns Promise<FeedIcon>
Promise resolving to the feed icon data
- Defined in client.ts:165

getFeeds

getFeeds(): Promise<Feed[]>
Retrieves all feeds.

Returns Promise<Feed[]>
Promise resolving to an array of feeds
- Defined in client.ts:115

getMe

getMe(): Promise<User>
Retrieves the current user's information.

Returns Promise<User>
Promise resolving to the user details
- Defined in client.ts:414

getMinifluxEntryUrl

getMinifluxEntryUrl(id: number): Promise<string>
Retrieves the Miniflux URL for an entry.
Parameters
- id: number
  ID of the entry
Returns Promise<string>
Promise resolving to the Miniflux URL
- Defined in client.ts:529

getUser

getUser(userId: number): Promise<User>
Retrieves a specific user.
Parameters
- userId: number
  ID of the user
Returns Promise<User>
Promise resolving to the user details
- Defined in client.ts:431

getUsers

getUsers(): Promise<User[]>
Retrieves all users (admin only).

Returns Promise<User[]>
Promise resolving to an array of users
- Defined in client.ts:422

getVersion

getVersion(): Promise<string>
Retrieves version information about the Miniflux server.

Returns Promise<string>
Promise resolving to version information
- Defined in client.ts:496

healthcheck

healthcheck(): Promise<string>
Checks the health status of the Miniflux server.

Returns Promise<string>
Promise resolving to "OK" if the server is healthy
- Defined in client.ts:488

markCategoryAsRead

markCategoryAsRead(categoryId: number): Promise<void>
Marks all entries in a category as read.
Parameters
- categoryId: number
  ID of the category
Returns Promise<void>
- Defined in client.ts:381

markFeedAsRead

markFeedAsRead(feedId: number): Promise<void>
Marks all entries in a feed as read.
Parameters
- feedId: number
  ID of the feed
Returns Promise<void>
- Defined in client.ts:203

markUserAsRead

markUserAsRead(userId: number): Promise<void>
Marks all entries for a user as read.
Parameters
- userId: number
  ID of the user
Returns Promise<void>
- Defined in client.ts:478

refreshAllFeeds

refreshAllFeeds(): Promise<void>
Refreshes all feeds.

Returns Promise<void>
- Defined in client.ts:195

refreshCategoryFeeds

refreshCategoryFeeds(categoryId: number): Promise<void>
Refreshes all feeds in a category.
Parameters
- categoryId: number
  ID of the category
Returns Promise<void>
- Defined in client.ts:350

refreshFeed

refreshFeed(feedId: number): Promise<void>
Refreshes a specific feed.
Parameters
- feedId: number
  ID of the feed to refresh
Returns Promise<void>
- Defined in client.ts:156

saveEntry

saveEntry(entryId: number): Promise<void>
Saves an entry to third-party services.
Parameters
- entryId: number
  ID of the entry
Returns Promise<void>
- Defined in client.ts:286

searchEntries

searchEntries(query: string, limit?: number): Promise<EntryResultSet>
Search for entries.
Parameters
- query: string
  Search query
- Optionallimit: number
  Optional limit for the number of results
Returns Promise<EntryResultSet>
Promise resolving to the search results
- Defined in client.ts:515

toggleBookmark

toggleBookmark(entryId: number): Promise<void>
Toggles the bookmark status of an entry.
Parameters
- entryId: number
  ID of the entry
Returns Promise<void>
- Defined in client.ts:269

updateCategory

updateCategory(categoryId: number, title: string): Promise<Category>
Updates a category.
Parameters
- categoryId: number
  ID of the category
- title: string
  New title for the category
Returns Promise<Category>
Promise resolving to the updated category
- Defined in client.ts:331

updateEnclosure

updateEnclosure(enclosureId: number, mediaProgression: number): Promise<void>
Updates an enclosure's media progression.
Parameters
- enclosureId: number
  ID of the enclosure
- mediaProgression: number
  New media progression value
Returns Promise<void>
- Defined in client.ts:401

updateEntry

updateEntry(entryId: number, payload: EntryUpdatePayload): Promise<Entry>
Updates an entry's content.
Parameters
- entryId: number
  ID of the entry
- payload: EntryUpdatePayload
  Update payload containing title and/or content
Returns Promise<Entry>
Promise resolving to the updated entry
- Defined in client.ts:296

updateEntryStatus

updateEntryStatus(entryId: number, status: "unread" | "read"): Promise<void>
Updates the status of an entry.
Parameters
- entryId: number
  ID of the entry
- status: "unread" | "read"
  New status ('read' or 'unread')
Returns Promise<void>
- Defined in client.ts:258

updateFeed

updateFeed(feedId: number, changes: Partial<Feed>): Promise<Feed>
Updates a feed.
Parameters
- feedId: number
  ID of the feed to update
- changes: Partial<Feed>
  Partial feed object containing the changes
Returns Promise<Feed>
Promise resolving to the updated feed
- Defined in client.ts:213

updateUser

updateUser(userId: number, changes: Partial<User>): Promise<User>
Updates a user's information.
Parameters
- userId: number
  ID of the user to update
- changes: Partial<User>
  Partial user object containing the changes
Returns Promise<User>
Promise resolving to the updated user
- Defined in client.ts:459