open-index/open-npm huggingface dataset:
npm package: @pvm/mattermost
Description: Api utilities for sending messages to mattermost
Author: Mikhail Shipov
Latest version: 0.56.18

# @pvm/mattermost

A client for  `mattermost` messenger. Client implementing [AbstractMessengerClient](api/classes/pvm_notifications.AbstractMessengerClient.md).

## Required environment variables

`PVM_MATTERMOST_TOKEN` и `PVM_MATTERMOST_URL` - for sending message via REST API

`PVM_MATTERMOST_INCOMING_WEBHOOK` - for sending via [incoming webhooks](https://docs.mattermost.com/developer/webhooks-incoming.html)

## Enabling in project

`.pvm.toml`

```toml
...
[[notifications.clients]]
name = 'mattermost'
pkg = '@pvm/mattermost'
```

After that, depending on [notifications settings](api/interfaces/pvm_core.Config.md#notifications), messages will be sending to `mattermost` messenger
npm package: @pvm/notifications
Description: Cli and api utilities for sending messages
Author: Mikhail Shipov
Latest version: 0.56.18

# @pvm/notifications

Module used to send messages into specified messengers

## [Configuration](../interfaces/pvm_core.Config.md#notifications)

Configuration [defaults](../interfaces/pvm_core.Config.md#notifications) provide values
that will be used as defaults for message when `sendMessage` called.

## Node API

Main api entry point is [Notificator](../classes/pvm_notifications.Notificator) class. It's interface
public methods are appear to be public api.

Example

```typescript
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.

```
npm package: @pvm/slack
Description: Cli and api utilities for sending messages to slack
Author: Andrey Rublev
Latest version: 0.56.18

# @pvm/slack

Provides client for `slack` messenger. Client implementing [AbstractMessengerClient](api/classes/pvm_notifications.AbstractMessengerClient.md).

## Enabling in project

`.pvm.toml`

```toml
...
[[notifications.clients]]
name = 'slack'
pkg = '@pvm/slack'
```

After that, depending on settings [нотификаций](api/interfaces/pvm_core.Config.md#notifications), messages will be sending to `slack` messenger