Class PushoverService

constructor

• new PushoverService(config: BaseConfig & { dataFile?: string }): PushoverService

  Creates a new PushoverService instance

  Parameters

  • config: BaseConfig & { dataFile?: string }

    Pushover configuration

  Returns PushoverService

clearAllNotifications

• clearAllNotifications(): void

  Clears all notifications from storage

  Returns void

createNotification

• createNotification(
      notification: Omit<
          NotificationData,
          "id"
          | "read"
          | "createdAt"
          | "pushoverSent"
          | "pushoverReceipt",
      >,
  ): Promise<NotificationData>

  Creates new notification with optional Pushover delivery

  Parameters

  • notification: Omit<
        NotificationData,
        "id"
        | "read"
        | "createdAt"
        | "pushoverSent"
        | "pushoverReceipt",
    >

    Notification data

  Returns Promise<NotificationData>

  Created notification with system fields

deleteNotification

• deleteNotification(id: string): boolean

  Removes notification by ID

  Parameters

  • id: string

    Notification ID

  Returns boolean

  Deletion success status

getNotificationById

• getNotificationById(id: string): undefined | NotificationData

  Finds notification by ID

  Parameters

  • id: string

    Notification ID

  Returns undefined | NotificationData

  Found notification or undefined

getNotifications

• getNotifications(recipient: string): NotificationData[]

  Retrieves all notifications for a recipient (sorted by date)

  Parameters

  • recipient: string

    Target recipient identifier

  Returns NotificationData[]

  Filtered notifications array

getSounds

• getSounds(): undefined | SoundMap

  Retrieves available notification sounds

  Returns undefined | SoundMap

  Mapping of sound identifiers to display names

handleCreateNotification

• handleCreateNotification(req: Request, res: Response): void

  Parameters

  • req: Request
  • res: Response

  Returns void

handleDeleteNotification

• handleDeleteNotification(req: Request, res: Response): void

  Parameters

  • req: Request
  • res: Response

  Returns void

handleGetNotification

• handleGetNotification(req: Request, res: Response): void

  Parameters

  • req: Request
  • res: Response

  Returns void

handleGetNotifications

• handleGetNotifications(req: Request, res: Response): void

  Parameters

  • req: Request
  • res: Response

  Returns void

handleUpdateNotificationStatus

• handleUpdateNotificationStatus(req: Request, res: Response): void

  Parameters

  • req: Request
  • res: Response

  Returns void

isEnabled

• isEnabled(): boolean

  Checks if service is enabled

  Returns boolean

  Service status

markNotificationAsRead

• markNotificationAsRead(id: string): undefined | NotificationData

  Updates notification read status

  Parameters

  • id: string

    Notification ID

  Returns undefined | NotificationData

  Updated notification or undefined

send

• send(
      payload: MessagePayload,
      callback?: (err?: Error, body?: string, res?: IncomingMessage) => void,
  ): void

  Sends notification via Pushover API

  Parameters

  • payload: MessagePayload

    Notification content
  • Optionalcallback: (err?: Error, body?: string, res?: IncomingMessage) => void

    Result callback (err, body, res)

  Returns void

sendNotification

• sendNotification(message: Message): Promise<null | string>

  Sends a notification through Pushover API

  Parameters

  • message: Message

    Notification payload

  Returns Promise<null | string>

  Receipt ID or null

ReadonlydataFile