Add basic reference information #712
Conversation
Codecov Report
@@ Coverage Diff @@
## main #712 +/- ##
=======================================
Coverage 82.32% 82.32%
=======================================
Files 8 8
Lines 758 758
Branches 250 250
=======================================
Hits 624 624
Misses 78 78
Partials 56 56 Continue to review full report at Codecov.
|
mwbrooks
added
docs
|
|
||
| | Method | Description | | ||
| |--------------------------------------------------------------------| | ||
| | `app.event(eventType, fn);` | Listens for Events API events. The `eventType` is a `string` to identify a [specific event](https://api.slack.com/events) to handle (which must be subscribed to in your app's configuration). | |
There was a problem hiding this comment.
Having a link to https://api.slack.com/events is a great idea! To avoid confusion, we may want to mention message.channels is not an event type.
shaydewael
changed the title
shaydewael
force-pushed
the
add-top-level-about
branch
from
c6eb3cb to
738a9fb
Compare
| | :---: | :--- | | ||
| | `signingSecret` | A `string` from your app's configuration (under "Basic Information") which verifies that incoming events are coming from Slack | | ||
| | `endpoints` | A `string` or `object` that specifies the endpoint(s) that the receiver will listen for incoming requests from Slack. For `object`, the `key` is the type of events (ex: `events`), and the value is the endpoint (ex: `/myapp/events`). **By default, all events are sent to the `/slack/events` endpoint** | | ||
| | `processBeforeResponse` | `boolean` that determines whether Events API events should be automatically acknowledged. This is primarily useful when running apps on FaaS to ensure events listeners don't unexpectedly terminate. Defaults to `true`. | |
There was a problem hiding this comment.
I'd love to be able to update the Deploying to AWS Lambda - Prepare the app section to link to the processBeforeResponse documentation. 🙏🏻
| ### Receiver options | ||
| `ExpressReceiver` options can be passed into the app constructor, just like the Bolt app options. They'll be passed to the `ExpressReceiver` instance upon initialization. | ||
|
|
||
| | Option | Description | |
There was a problem hiding this comment.
It would be nice to know which are required or optional options. I noticed that some descriptions start with "Optional,...". Would it be better to just have a column "Required"?
|
|
||
| > Bolt's client is an instance of `WebClient` from the [Node Slack SDK](/node-slack-sdk), so some of that documentation may be helpful as you're developing. | ||
|
|
||
| ## Framework error types |
There was a problem hiding this comment.
❤️ ❤️ ❤️ ❤️ ❤️ This is the kind of documentation that a developer with a production app needs and loves.
mwbrooks
removed
the
draft
Summary
This PR introduces a new reference page that includes details about listeners, initialization options, and error codes.
Live at https://shaydewael.github.io/bolt-js/reference
but you'll have to manually update the header's import of
style.cssyou to use the shaydewael.github.io one if you want to see the styling. Or just trust me, it looks like this:EDIT: Modified some styling updates re: @mwbrooks's suggestion
Requirements (place an
xin each[ ])