-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
54 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,54 @@ | ||
# Slack Deno Socket Mode | ||
<div align="center"> | ||
<img src="assets/logo.svg" width="400" height="400" alt="Socket icon"> | ||
<h1>Slack Deno Socket Mode</h1> | ||
<p> | ||
<b>Recieve events from Slack's <a href="https://api.slack.com/apis/connections/events-api">Events API</a> over a WebSocket connection. Deno port of <a href="https://www.npmjs.com/package/@slack/socket-mode">@slack/socket-mode</a></b> | ||
</p> | ||
<p> | ||
<img alt="build status" src="https://img.shields.io/github/workflow/status/slack-deno/socket-mode/Deno?label=checks" > | ||
<img alt="language" src="https://img.shields.io/github/languages/top/slack-deno/socket-mode" > | ||
<img alt="code size" src="https://img.shields.io/github/languages/code-size/slack-deno/socket-mode"> | ||
<img alt="issues" src="https://img.shields.io/github/issues/slack-deno/socket-mode" > | ||
<img alt="license" src="https://img.shields.io/github/license/slack-deno/socket-mode"> | ||
<img alt="version" src="https://img.shields.io/github/v/release/slack-deno/socket-mode"> | ||
</p> | ||
<p> | ||
<b><a href="https://deno.land/x/slack_socket_mode">View on deno.land</a></b> | ||
</p> | ||
<br> | ||
<br> | ||
<br> | ||
</div> | ||
|
||
Deno port of @slack/events-api | ||
## Usage | ||
|
||
```ts | ||
import "https://deno.land/x/dotenv@v2.0.0/load.ts" | ||
import { SocketModeClient } from "https://deno.land/x/slack_socket_mode@1.0.0/mod.ts" | ||
|
||
const appToken = Deno.env.get("SLACK_APP_TOKEN") | ||
const socketModeClient = new SocketModeClient({ appToken }) | ||
|
||
// Attach listeners to events by type. See: https://api.slack.com/events/message | ||
socketModeClient.addEventListener("message", ({ detail: { body, ack } }) => { | ||
ack() | ||
console.log(body) | ||
}) | ||
|
||
await socketModeClient.start() | ||
``` | ||
|
||
## API | ||
|
||
- API is similar to the [node @slack/socket-mode](https://www.npmjs.com/package/@slack/socket-mode), where `.addEventListener` is used instead of `.on` ([EventTarget docs](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget)) | ||
- Complete [generated docs](https://doc.deno.land/https/deno.land/x/slack_socket_mode@1.0.0/mod.ts) are also available | ||
|
||
## Supporters | ||
|
||
[![Stargazers repo roster for @slack-deno/socket-mode](https://reporoster.com/stars/slack-deno/socket-mode)](https://github.com/slack-deno/socket-mode/stargazers) | ||
|
||
[![Forkers repo roster for @slack-deno/socket-mode](https://reporoster.com/forks/slack-deno/socket-mode)](https://github.com/slack-deno/socket-mode/network/members) | ||
|
||
## Related | ||
|
||
- [Deno modules](https://github.com/KhushrajRathod/DenoModules) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.