-
Notifications
You must be signed in to change notification settings - Fork 663
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
1 changed file
with
32 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Slack Types | ||
|
||
The `@slack/types` package is intended to be used as a central location for modeling Slack interfaces, types, payloads | ||
and constructs of all kinds. | ||
|
||
## Requirements | ||
|
||
This package supports Node v18 and higher. It's highly recommended to use [the latest LTS version of | ||
node](https://github.com/nodejs/Release#release-schedule), and the documentation is written using syntax and features | ||
from that version. | ||
|
||
## Installation | ||
|
||
```shell | ||
$ npm install @slack/types | ||
``` | ||
|
||
## Usage | ||
|
||
This package exports a many different types and interfaces. It is best to peruse the source code to see what is | ||
available, but a brief list: | ||
|
||
- Block Kit blocks and elements (`./src/block-kit/*`) | ||
- Message attachments (`./src/message-attachments.ts`) | ||
|
||
## Getting Help | ||
|
||
If you get stuck, we're here to help. The following are the best ways to get assistance working through your issue: | ||
|
||
* [Issue Tracker](http://github.com/slackapi/node-slack-sdk/issues) for questions, feature requests, bug reports and | ||
general discussion related to this package. Try searching before you create a new issue. | ||
* [Email us](mailto:[email protected]) in Slack developer support: `[email protected]` |