Notifier

该项目通过Electron为桌面平台提供一致的通知功能. Notifier创建一个本地的HTTP API服务器, 其他本地程序可以通过向服务器发送请求来发出通知.

API

notify

POST /

向Notifier发出通知.

请求的payload必须是以JSON表示的INotification对象或INotification数组:

interface INotification {
  title?: string | null
  message?: string | null
  iconUrl?: string | null
  imageUrl?: string | null
  url?: string | null

  // 其他成员将被Notifier忽略
  [name: string]: JSONValue
}

Example

curl

curl \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{ "message": "Hello World" }' \
  "http://localhost:8080"

JavaScript

await fetch('http://localhost:8080', {
  method: 'POST'
, headers: { 'Content-Type': 'application/json' }
, body: JSON.stringify({ message: 'hello world' })
})

命令行参数

--hidden

带有此参数启动Notifier时, Notifier的主界面不会显示.

在需要将Notifier设置为开机启动项时, 该参数可能很有用.

开发

# 在第一个终端里运行
yarn dev

# 在第二个终端里运行
yarn start

打包

yarn clean
yarn build
yarn package

架构

Main

职责:

• 建立HTTP服务器.

App Renderer

职责:

• 提供持久化的通知历史记录.
• 提供"设置"界面.

Notification Renderer

职责:

• 显示通知.