@pvm/notifications

@pvm/notifications

Module used to send messages into specified messengers

Configuration

Configuration defaults provide values that will be used as defaults for message when sendMessage called.

Node API

Main api entry point is Notificator class. It's interface public methods are appear to be public api.

Example

import { Notificator } from '@pvm/notifications'

async function send(channel: string, content: string) {
  const notificator = await Notificator.create()
  notificator.sendMessage({
    channel,  
    content
  })
}

CLI

yarn run v1.22.19
$ /home/runner/work/pvm/pvm/node_modules/.bin/pvm notification --help
pvm notification <command>

Send messages to messenger(s)

Commands:
  pvm notification send  Send message to configured messengers

Options:
  --version  Show version number                                                           [boolean]
  ----help   Show help                                                                     [boolean]
Done in 2.35s.

pvm notification send

yarn run v1.22.19
$ /home/runner/work/pvm/pvm/node_modules/.bin/pvm notification send --help
pvm notification send

Send message to configured messengers

Options:
      --version  Show version number                                                       [boolean]
      ----help   Show help                                                                 [boolean]
  -t, --target   target messenger or list of them. Possible values are: all, first-available and
                 concrete messenger name                                                     [array]
  -f, --file     message json file. Available fields described in doc
                 https://tinkoff.github.io/pvm/docs/api/modules/pvm_types#message
  -c, --channel  channel where to send message
  -m, --message  text for sending. Use "-" for reading from stdin. Default: "-" if there is no
                 message nor text passed.

Examples:
  pvm notification send -m message.json  Send message to messengers according to pvm configuration
Done in 1.27s.