Interface UseNotificationsReturn

The return object of the useNotifications hook, providing notification data and utility methods.

Hierarchy

  • UseNotificationsReturn

Properties

currentPage: number

The current page index for paginated notifications.

Function to fetch additional notifications based on pagination parameters.

fetched: boolean

Boolean indicating whether notifications have been successfully fetched from the server.

Function to mark all notifications as read.

notifications: ExtendedNotificationType[]

The list of notifications currently fetched and not marked as deleted.

Function to refetch the notifications from the server.

toNotify: ExtendedNotificationType[]

The list of new notifications fetched during polling (if polling is enabled).

Generated using TypeDoc