Using TypeScript

⚠️ This guide is a work-in-progress.

See the sample TypeScript project to see a TypeScript equivalent of the Getting Started app (and a few other basic examples).

This project is written and built using TypeScript, which means many of the APIs have type information metadata 🎉. If you’re using a code editor like VSCode, Atom, or many others that know how to read that metadata, or if you’re using TypeScript in your own project, you’ll benefit from improved documentation as your write code, early detection of errors, easier refactoring, and more.

This page helps describe how to use this package from a project that also uses TypeScript.

Minimum version

The latest major version of @slack/bolt is supported to build against a minimum TypeScript version of v4.1.