loading...

Handle Slack's Incoming Webhook easily and type-safely in TypeScript

star__hoshi profile image star__hoshi ・1 min read

slackapi/node-slack-sdk is great slack client. However, it does not contain d.ts files. So I made a library with type definition.

typed-slack has type definitions, so you can handle slack-api easily and type-safely.

Code completion is enabled when using VSCode.

vscode\.gif \(898×298\)

Install

npm install typed-slack

Usage

Webhook

import * as Slack from 'typed-slack'

let slack = new Slack.IncomingWebhook('https://hooks.slack.com/services/.......')
slack.send({ text: 'text' }).then(e => {
  console.log('success')
}).catch(e => {
  console.error(e)
})

Use options

More optional parameters are here#typed-slack.d.ts

const options = <Slack.IncomingWebhookOptions>{
  text: '@star__hoshi Hi!',
  channel: 'debug',
  icon_emoji: ':smile:',
  link_names: 1,
  attachments: [
    {
      color: Slack.Color.Danger,
      fields: [
        {
          title: 'Priority',
          value: 'High',
          short: false
        }
      ],
      image_url: 'http://my-website.com/path/to/image.jpg',
      ts: 123456789
    }
  ]
}
await slack.send(options)

starhoshi/typed-slack

Please use typed-slack !

Discussion

markdown guide