Superutils

Appearance

Type Alias: IpcOptions ​

IpcOptions = object

Defined in: index.ts:223

Properties ​

notifyOnAppStates? ​

optional notifyOnAppStates?: AppStateStatus[]

Defined in: index.ts:230

Choose which AppState the binary service is allowed to create an IPC notification

Default: undefined (notifies on all states excluding "active")

tag ​

tag: string

Defined in: index.ts:249

Tag used to identity and create notifications from binary stdout logs.

This allows the binary to update the persistent notification as well as create new notifcations.

To update persistent notification, "id" must be set to BINARY_NOTIFICATION_ID in the log.

Notes: ​

  • If the tag is set to [notification], everything after it will be parsed as NotificationOptions.
  • If parse fails, it will be ignored.
  • Multiline parsing is not supported. The NotificationOptions must be a single-line valid JSON string.

Example binary log: ​

text
2000-01-01 01:01:01.999 [notification] { "id": 1, "title": "New message!", "text": "Click to open app" }