@synonymdev/blocktank-util-slack-client

blocktank-util-slack-client

Client to interact with the blocktank-util-slack service.

Usage

Install

npm i @synonymdev/blocktank-util-slack-client

Send message

import { SlackClient } from '@synonymdev/blocktank-util-slack-client';

const client = new SlackClient('myConfiguredChannelName') // See service config for channel names.

await client.info('myTitle', 'myMessage') // Send message.

// Limit the message to be sent only once every 24 hours.
// This will help avoid spam.
await client.error('Couldnt read file', 'errorMessage', {
    key: 'fileReadKey',
    limitFor: {
        years: undefined,
        months: undefined,
        weeks: undefined,
        days: 1,
        hours: undefined,
        minutes: undefined,
        seconds: undefined,
    }
})

Test messages

Execute blocktank-util-slack-cli in the terminal to send test messages. *Install with npm i @synonymdev/blocktank-util-slack-client first.

Versioning

1. Increase version in package.json.
2. Add changes to CHANGELOG.md.
3. Commit changes.
4. Tag new version: git tag v0.1.0.
5. Push tag git push origin v0.1.0.
6. Build: npm run build.
7. Publish to npm: npm publish.