Typescript example in strict mode?

[gterras]

Description

Hi,

Is there an example out there on how to properly use Bolt with strict Typescript ?

The README says

The easiest way to understand what's in a payload is to simply log it, or otherwise use TypeScript.

but the anchor link it refers to does not exist.

I know this example https://github.com/seratch/slack-app-examples/tree/master/reacjilator-bolt-typescript but it misses a full integration.

I'm trying to do something like this but I'm really not sure it is the proper way :

import * as SlackTypes from '@slack/bolt/dist/types'
interface SlackReq {
	body: SlackTypes.ReceiverEvent['body']
	action: SlackTypes.BlockElementAction & SlackTypes.StaticSelectAction
}
app.action({}, async ({ack, body, action}: SlackReq) => {
	ack()
	...
})

Thanks!

What type of issue is this? (place an x in one of the [ ])

• bug
• enhancement (feature request)
• question
• documentation related
• testing related
• discussion

Requirements (place an x in each of the [ ])

• I've read and understood the Contributing guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.
• I've searched for any related issues and avoided creating a duplicate issue.

---

[seratch]

@gterras Hello, thanks for mentioning an example I created before 😄

When you use TypeScript, you don't need to do anything further. You can go with common TypeScript project settings. Then, just adding @slack/bolt as a dependency works for you.

Probably, you're looking for ways to have much clearer types for arguments of handlers. Try having more constraints introduced by #349 for it. It helps yo make the type more specific. If you want to determine the types much more specifically (say, you want BlockStaticSelectAction rather than generic BlockAction), you can freely cast the type in your code upon certain assumptions.

Also, I guess you're already aware of this but Bolt and its underlying node-slack-sdk don't provide type definitions for API method (e.g., chat.postMessage) responses yet. If you need types for those, please define your own ones or copy my personal experiments.