https://github.com/starhoshi/typed-slack

Type-safe slack client for TypeScript.
https://github.com/starhoshi/typed-slack

javascript npm slack typescript

Last synced: about 1 month ago
JSON representation

Type-safe slack client for TypeScript.

• Host: GitHub
• URL: https://github.com/starhoshi/typed-slack
• Owner: starhoshi
• Created: 2018-02-15T12:14:56.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-19T02:03:01.000Z (about 6 years ago)
• Last Synced: 2024-11-10T07:40:44.307Z (about 2 months ago)
• Topics: javascript, npm, slack, typescript
• Language: TypeScript
• Homepage: https://starhoshi.github.io/typed-slack
• Size: 1.62 MB
• Stars: 15
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    



# typed-slack [![npm version](https://badge.fury.io/js/typed-slack.svg)](https://badge.fury.io/js/typed-slack) [![Build Status](https://travis-ci.org/starhoshi/typed-slack.svg?branch=master)](https://travis-ci.org/starhoshi/typed-slack) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c7a8f750afbd40019c5c4f859dd64d19)](https://www.codacy.com/app/kensuke1751/typed-slack?utm_source=github.com&utm_medium=referral&utm_content=starhoshi/typed-slack&utm_campaign=Badge_Grade) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

Typed-slack is a type-safe slack client for TypeScript.

[slackapi/node\-slack\-sdk](https://github.com/slackapi/node-slack-sdk) is great slack client. However, it does not contain d.ts files. 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\)](https://raw.githubusercontent.com/starhoshi/typed-slack/master/assets/vscode.gif)

## TODO

* [x] Incoming Webhook

* [ ] Web API

* [ ] RTM API

* [ ] Events API

* [ ] Interactive Messages

## Install

```

npm install typed-slack

```

## Usage

### Webhook

```ts

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)

})

```

#### Options

More optional parameters are [here#typed\-slack\.d\.ts](https://github.com/starhoshi/typed-slack/blob/master/out/typed-slack.d.ts)

```ts

const options = {

  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)

```