From e2e40b654e387a7018f6322845c3c3e77e1526ee Mon Sep 17 00:00:00 2001 From: Haley Elmendorf Date: Thu, 27 Aug 2026 09:36:22 -0500 Subject: [PATCH 1/7] docs: add TypeDoc-generated API reference Set up TypeDoc + typedoc-plugin-markdown to generate a Markdown API reference into docs/english/reference, mirroring node-slack-sdk. - Add typedoc/typedoc-plugin-markdown dev deps and a "docs" script; regenerate docs as part of the "version" script. - Add typedoc.json using node-slack-sdk's config, plus excludeExternals (avoids inlining the entire @slack/web-api and @slack/types surface) and excludeScopesInPaths (drops the @slack/ scope from output paths). - Rename the curated reference.md to interface-reference.md so the generated docs can own the "reference" slug; repoint anchor links. - Wire an autogenerated "Reference" category into _sidebar.json. - Add a "Build docs" CI step (Node 24.x only) to verify generation. Co-Authored-By: Claude --- .github/workflows/ci-build.yml | 3 + docs/english/_sidebar.json | 12 +- docs/english/concepts/listener-middleware.md | 2 +- docs/english/concepts/receiver.md | 2 +- .../concepts/using-the-assistant-class.md | 6 +- .../{reference.md => interface-reference.md} | 2 +- docs/english/migration/migration-v4.md | 2 +- .../functions/bufferIncomingMessage.md | 19 + .../functions/buildContentResponse.md | 23 + .../functions/buildNoBodyResponse.md | 23 + .../functions/buildSSLCheckResponse.md | 19 + .../functions/buildUrlVerificationResponse.md | 23 + .../defaultAsyncDispatchErrorHandler.md | 19 + .../functions/defaultDispatchErrorHandler.md | 19 + .../defaultProcessEventErrorHandler.md | 19 + .../defaultUnhandledRequestHandler.md | 19 + .../extractRetryNumFromHTTPRequest.md | 19 + .../extractRetryReasonFromHTTPRequest.md | 19 + .../functions/getHeader.md | 23 + .../functions/isBufferedIncomingMessage.md | 19 + .../functions/parseAndVerifyHTTPRequest.md | 31 + .../functions/parseHTTPRequestBody.md | 19 + .../namespaces/HTTPModuleFunctions/index.md | 28 + .../ReceiverDispatchErrorHandlerArgs.md | 45 + .../ReceiverProcessEventErrorHandlerArgs.md | 55 + .../ReceiverUnhandledRequestHandlerArgs.md | 35 + .../interfaces/RequestVerificationOptions.md | 49 + docs/english/reference/classes/App.md | 884 ++++++++++++ .../classes/AppInitializationError.md | 81 ++ docs/english/reference/classes/Assistant.md | 39 + .../classes/AssistantInitializationError.md | 81 ++ .../classes/AssistantMissingPropertyError.md | 81 ++ .../reference/classes/AuthorizationError.md | 71 + .../reference/classes/AwsLambdaReceiver.md | 131 ++ .../classes/ContextMissingPropertyError.md | 71 + .../CustomFunctionCompleteFailError.md | 81 ++ .../CustomFunctionCompleteSuccessError.md | 81 ++ .../CustomFunctionInitializationError.md | 81 ++ .../classes/CustomRouteInitializationError.md | 81 ++ .../reference/classes/ExpressReceiver.md | 219 +++ .../english/reference/classes/HTTPReceiver.md | 199 +++ .../HTTPReceiverDeferredRequestError.md | 96 ++ .../reference/classes/HTTPResponseAck.md | 71 + .../classes/InvalidCustomPropertyError.md | 81 ++ docs/english/reference/classes/MemoryStore.md | 92 ++ .../classes/MultipleListenerError.md | 67 + .../classes/ReceiverAuthenticityError.md | 81 ++ .../classes/ReceiverInconsistentStateError.md | 81 ++ .../classes/ReceiverMultipleAckError.md | 47 + .../english/reference/classes/RespondError.md | 67 + .../reference/classes/SocketModeReceiver.md | 111 ++ .../english/reference/classes/UnknownError.md | 67 + .../reference/enumerations/ErrorCode.md | 178 +++ .../reference/functions/asCodedError.md | 19 + .../functions/buildReceiverRoutes.md | 19 + .../defaultProcessEventErrorHandler.md | 19 + .../reference/functions/isCodedError.md | 19 + .../reference/functions/isFulfilled.md | 27 + .../english/reference/functions/isRejected.md | 27 + .../isSlackEventMiddlewareArgsOptions.md | 26 + .../functions/isValidSlackRequest.md | 22 + .../reference/functions/matchCommandName.md | 21 + .../reference/functions/matchConstraints.md | 60 + .../reference/functions/matchEventType.md | 19 + .../reference/functions/matchMessage.md | 19 + docs/english/reference/functions/subtype.md | 21 + .../reference/functions/verifySlackRequest.md | 22 + docs/english/reference/index.md | 233 +++ .../reference/interfaces/ActionConstraints.md | 53 + .../reference/interfaces/AllMiddlewareArgs.md | 51 + .../reference/interfaces/AppOptions.md | 311 ++++ .../reference/interfaces/AssistantConfig.md | 53 + .../reference/interfaces/AuthorizeResult.md | 83 ++ .../interfaces/AuthorizeSourceData.md | 63 + .../interfaces/AwsLambdaReceiverOptions.md | 141 ++ .../reference/interfaces/BaseSlackEvent.md | 21 + .../interfaces/BasicElementAction.md | 79 ++ .../interfaces/BasicOptionsPayload.md | 31 + .../reference/interfaces/BlockAction.md | 360 +++++ .../reference/interfaces/BlockOptions.md | 15 + .../reference/interfaces/BlockSuggestion.md | 196 +++ .../interfaces/BufferedIncomingMessage.md | 19 + .../reference/interfaces/ButtonAction.md | 107 ++ .../reference/interfaces/ButtonClick.md | 37 + .../interfaces/ChannelsSelectAction.md | 107 ++ .../reference/interfaces/CheckboxesAction.md | 97 ++ .../reference/interfaces/CodedError.md | 71 + docs/english/reference/interfaces/Context.md | 181 +++ .../reference/interfaces/ConversationStore.md | 65 + .../interfaces/ConversationsSelectAction.md | 107 ++ .../reference/interfaces/CustomRoute.md | 49 + .../reference/interfaces/DatepickerAction.md | 107 ++ .../interfaces/DialogOptionGroups.md | 21 + .../reference/interfaces/DialogOptions.md | 27 + .../interfaces/DialogSubmitAction.md | 184 +++ .../reference/interfaces/DialogSuggestion.md | 176 +++ .../reference/interfaces/DialogValidation.md | 30 + .../reference/interfaces/EnvelopedEvent.md | 145 ++ .../interfaces/ExpressReceiverOptions.md | 249 ++++ .../interfaces/ExternalSelectAction.md | 117 ++ .../interfaces/FeedbackButtonsAction.md | 87 ++ .../reference/interfaces/GlobalShortcut.md | 136 ++ .../interfaces/HTTPReceiverOptions.md | 245 ++++ .../reference/interfaces/IconButtonAction.md | 97 ++ .../interfaces/InteractiveMessage.md | 230 +++ .../InteractiveMessageSuggestion.md | 196 +++ .../reference/interfaces/MenuSelect.md | 43 + .../reference/interfaces/MessageOptions.md | 15 + .../reference/interfaces/MessageShortcut.md | 224 +++ .../interfaces/MultiChannelsSelectAction.md | 107 ++ .../MultiConversationsSelectAction.md | 107 ++ .../interfaces/MultiExternalSelectAction.md | 117 ++ .../interfaces/MultiStaticSelectAction.md | 119 ++ .../interfaces/MultiUsersSelectAction.md | 107 ++ .../reference/interfaces/OptionGroups.md | 21 + .../interfaces/OptionsConstraints.md | 53 + .../reference/interfaces/OverflowAction.md | 99 ++ .../interfaces/PlainTextInputAction.md | 77 + .../interfaces/RadioButtonsAction.md | 97 ++ docs/english/reference/interfaces/Receiver.md | 65 + .../reference/interfaces/ReceiverEvent.md | 55 + .../reference/interfaces/ReceiverRoutes.md | 11 + .../reference/interfaces/ResponseAck.md | 19 + .../interfaces/RichTextInputAction.md | 77 + .../interfaces/ShortcutConstraints.md | 31 + .../interfaces/SlackCommandMiddlewareArgs.md | 67 + .../interfaces/SlackOptionsMiddlewareArgs.md | 53 + .../interfaces/SlackViewMiddlewareArgs.md | 63 + .../reference/interfaces/SlashCommand.md | 169 +++ .../interfaces/SocketModeReceiverOptions.md | 205 +++ ...odeReceiverProcessEventErrorHandlerArgs.md | 35 + .../interfaces/StaticSelectAction.md | 119 ++ .../reference/interfaces/TimepickerAction.md | 107 ++ .../reference/interfaces/UploadedFile.md | 1245 +++++++++++++++++ .../reference/interfaces/UsersSelectAction.md | 107 ++ .../interfaces/ViewClearResponseAction.md | 15 + .../reference/interfaces/ViewClosedAction.md | 136 ++ .../reference/interfaces/ViewConstraints.md | 25 + .../interfaces/ViewErrorsResponseAction.md | 31 + .../reference/interfaces/ViewOutput.md | 279 ++++ .../interfaces/ViewPushResponseAction.md | 25 + .../reference/interfaces/ViewResponseUrl.md | 45 + .../interfaces/ViewStateSelectedOption.md | 25 + .../reference/interfaces/ViewStateValue.md | 155 ++ .../reference/interfaces/ViewSubmitAction.md | 146 ++ .../interfaces/ViewUpdateResponseAction.md | 25 + docs/english/reference/type-aliases/AckFn.md | 25 + .../type-aliases/AnyMiddlewareArgs.md | 15 + ...AssistantThreadContextChangedMiddleware.md | 9 + .../AssistantThreadStartedMiddleware.md | 11 + .../AssistantUserMessageMiddleware.md | 9 + .../reference/type-aliases/Authorize.md | 31 + .../type-aliases/BlockButtonAction.md | 9 + .../type-aliases/BlockChannelsSelectAction.md | 9 + .../type-aliases/BlockCheckboxesAction.md | 9 + .../BlockConversationsSelectAction.md | 9 + .../type-aliases/BlockDatepickerAction.md | 9 + .../type-aliases/BlockElementAction.md | 33 + .../type-aliases/BlockExternalSelectAction.md | 9 + .../BlockFeedbackButtonsAction.md | 9 + .../type-aliases/BlockIconButtonAction.md | 9 + .../type-aliases/BlockOverflowAction.md | 9 + .../type-aliases/BlockPlainTextInputAction.md | 9 + .../type-aliases/BlockRadioButtonsAction.md | 9 + .../type-aliases/BlockStaticSelectAction.md | 9 + .../type-aliases/BlockTimepickerAction.md | 9 + .../type-aliases/BlockUsersSelectAction.md | 9 + .../reference/type-aliases/EventFromType.md | 20 + .../type-aliases/EventTypePattern.md | 9 + .../reference/type-aliases/FunctionInputs.md | 9 + .../type-aliases/InteractiveAction.md | 14 + .../type-aliases/InteractiveButtonClick.md | 9 + .../type-aliases/InteractiveMenuSelect.md | 9 + .../type-aliases/KnownEventFromType.md | 17 + .../KnownOptionsPayloadFromType.md | 17 + .../reference/type-aliases/Middleware.md | 29 + docs/english/reference/type-aliases/NextFn.md | 13 + .../type-aliases/OptionsPayloadFromType.md | 15 + .../reference/type-aliases/OptionsSource.md | 11 + .../type-aliases/RespondArguments.md | 43 + .../reference/type-aliases/RespondFn.md | 19 + .../reference/type-aliases/SayArguments.md | 17 + docs/english/reference/type-aliases/SayFn.md | 19 + .../type-aliases/SayStreamArguments.md | 9 + .../reference/type-aliases/SayStreamFn.md | 19 + .../type-aliases/SetStatusArguments.md | 9 + .../reference/type-aliases/SetStatusFn.md | 19 + .../reference/type-aliases/SlackAction.md | 25 + .../type-aliases/SlackActionMiddlewareArgs.md | 72 + .../type-aliases/SlackEventMiddlewareArgs.md | 45 + .../SlackEventMiddlewareArgsOptions.md | 19 + .../reference/type-aliases/SlackOptions.md | 12 + .../reference/type-aliases/SlackShortcut.md | 13 + .../SlackShortcutMiddlewareArgs.md | 51 + .../reference/type-aliases/SlackViewAction.md | 13 + .../reference/type-aliases/StringIndexed.md | 11 + .../type-aliases/ViewResponseAction.md | 13 + docs/english/reference/type-aliases/XOR.md | 21 + .../reference/variables/autoAcknowledge.md | 11 + .../reference/variables/contextBuiltinKeys.md | 9 + .../reference/variables/directMention.md | 11 + .../english/reference/variables/ignoreSelf.md | 11 + .../reference/variables/onlyActions.md | 11 + .../reference/variables/onlyCommands.md | 11 + .../english/reference/variables/onlyEvents.md | 11 + .../reference/variables/onlyOptions.md | 11 + .../reference/variables/onlyShortcuts.md | 11 + .../reference/variables/onlyViewActions.md | 11 + package-lock.json | 266 ++++ package.json | 5 +- typedoc.json | 27 + 211 files changed, 14489 insertions(+), 9 deletions(-) rename docs/english/{reference.md => interface-reference.md} (99%) create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md create mode 100644 docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md create mode 100644 docs/english/reference/classes/App.md create mode 100644 docs/english/reference/classes/AppInitializationError.md create mode 100644 docs/english/reference/classes/Assistant.md create mode 100644 docs/english/reference/classes/AssistantInitializationError.md create mode 100644 docs/english/reference/classes/AssistantMissingPropertyError.md create mode 100644 docs/english/reference/classes/AuthorizationError.md create mode 100644 docs/english/reference/classes/AwsLambdaReceiver.md create mode 100644 docs/english/reference/classes/ContextMissingPropertyError.md create mode 100644 docs/english/reference/classes/CustomFunctionCompleteFailError.md create mode 100644 docs/english/reference/classes/CustomFunctionCompleteSuccessError.md create mode 100644 docs/english/reference/classes/CustomFunctionInitializationError.md create mode 100644 docs/english/reference/classes/CustomRouteInitializationError.md create mode 100644 docs/english/reference/classes/ExpressReceiver.md create mode 100644 docs/english/reference/classes/HTTPReceiver.md create mode 100644 docs/english/reference/classes/HTTPReceiverDeferredRequestError.md create mode 100644 docs/english/reference/classes/HTTPResponseAck.md create mode 100644 docs/english/reference/classes/InvalidCustomPropertyError.md create mode 100644 docs/english/reference/classes/MemoryStore.md create mode 100644 docs/english/reference/classes/MultipleListenerError.md create mode 100644 docs/english/reference/classes/ReceiverAuthenticityError.md create mode 100644 docs/english/reference/classes/ReceiverInconsistentStateError.md create mode 100644 docs/english/reference/classes/ReceiverMultipleAckError.md create mode 100644 docs/english/reference/classes/RespondError.md create mode 100644 docs/english/reference/classes/SocketModeReceiver.md create mode 100644 docs/english/reference/classes/UnknownError.md create mode 100644 docs/english/reference/enumerations/ErrorCode.md create mode 100644 docs/english/reference/functions/asCodedError.md create mode 100644 docs/english/reference/functions/buildReceiverRoutes.md create mode 100644 docs/english/reference/functions/defaultProcessEventErrorHandler.md create mode 100644 docs/english/reference/functions/isCodedError.md create mode 100644 docs/english/reference/functions/isFulfilled.md create mode 100644 docs/english/reference/functions/isRejected.md create mode 100644 docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md create mode 100644 docs/english/reference/functions/isValidSlackRequest.md create mode 100644 docs/english/reference/functions/matchCommandName.md create mode 100644 docs/english/reference/functions/matchConstraints.md create mode 100644 docs/english/reference/functions/matchEventType.md create mode 100644 docs/english/reference/functions/matchMessage.md create mode 100644 docs/english/reference/functions/subtype.md create mode 100644 docs/english/reference/functions/verifySlackRequest.md create mode 100644 docs/english/reference/index.md create mode 100644 docs/english/reference/interfaces/ActionConstraints.md create mode 100644 docs/english/reference/interfaces/AllMiddlewareArgs.md create mode 100644 docs/english/reference/interfaces/AppOptions.md create mode 100644 docs/english/reference/interfaces/AssistantConfig.md create mode 100644 docs/english/reference/interfaces/AuthorizeResult.md create mode 100644 docs/english/reference/interfaces/AuthorizeSourceData.md create mode 100644 docs/english/reference/interfaces/AwsLambdaReceiverOptions.md create mode 100644 docs/english/reference/interfaces/BaseSlackEvent.md create mode 100644 docs/english/reference/interfaces/BasicElementAction.md create mode 100644 docs/english/reference/interfaces/BasicOptionsPayload.md create mode 100644 docs/english/reference/interfaces/BlockAction.md create mode 100644 docs/english/reference/interfaces/BlockOptions.md create mode 100644 docs/english/reference/interfaces/BlockSuggestion.md create mode 100644 docs/english/reference/interfaces/BufferedIncomingMessage.md create mode 100644 docs/english/reference/interfaces/ButtonAction.md create mode 100644 docs/english/reference/interfaces/ButtonClick.md create mode 100644 docs/english/reference/interfaces/ChannelsSelectAction.md create mode 100644 docs/english/reference/interfaces/CheckboxesAction.md create mode 100644 docs/english/reference/interfaces/CodedError.md create mode 100644 docs/english/reference/interfaces/Context.md create mode 100644 docs/english/reference/interfaces/ConversationStore.md create mode 100644 docs/english/reference/interfaces/ConversationsSelectAction.md create mode 100644 docs/english/reference/interfaces/CustomRoute.md create mode 100644 docs/english/reference/interfaces/DatepickerAction.md create mode 100644 docs/english/reference/interfaces/DialogOptionGroups.md create mode 100644 docs/english/reference/interfaces/DialogOptions.md create mode 100644 docs/english/reference/interfaces/DialogSubmitAction.md create mode 100644 docs/english/reference/interfaces/DialogSuggestion.md create mode 100644 docs/english/reference/interfaces/DialogValidation.md create mode 100644 docs/english/reference/interfaces/EnvelopedEvent.md create mode 100644 docs/english/reference/interfaces/ExpressReceiverOptions.md create mode 100644 docs/english/reference/interfaces/ExternalSelectAction.md create mode 100644 docs/english/reference/interfaces/FeedbackButtonsAction.md create mode 100644 docs/english/reference/interfaces/GlobalShortcut.md create mode 100644 docs/english/reference/interfaces/HTTPReceiverOptions.md create mode 100644 docs/english/reference/interfaces/IconButtonAction.md create mode 100644 docs/english/reference/interfaces/InteractiveMessage.md create mode 100644 docs/english/reference/interfaces/InteractiveMessageSuggestion.md create mode 100644 docs/english/reference/interfaces/MenuSelect.md create mode 100644 docs/english/reference/interfaces/MessageOptions.md create mode 100644 docs/english/reference/interfaces/MessageShortcut.md create mode 100644 docs/english/reference/interfaces/MultiChannelsSelectAction.md create mode 100644 docs/english/reference/interfaces/MultiConversationsSelectAction.md create mode 100644 docs/english/reference/interfaces/MultiExternalSelectAction.md create mode 100644 docs/english/reference/interfaces/MultiStaticSelectAction.md create mode 100644 docs/english/reference/interfaces/MultiUsersSelectAction.md create mode 100644 docs/english/reference/interfaces/OptionGroups.md create mode 100644 docs/english/reference/interfaces/OptionsConstraints.md create mode 100644 docs/english/reference/interfaces/OverflowAction.md create mode 100644 docs/english/reference/interfaces/PlainTextInputAction.md create mode 100644 docs/english/reference/interfaces/RadioButtonsAction.md create mode 100644 docs/english/reference/interfaces/Receiver.md create mode 100644 docs/english/reference/interfaces/ReceiverEvent.md create mode 100644 docs/english/reference/interfaces/ReceiverRoutes.md create mode 100644 docs/english/reference/interfaces/ResponseAck.md create mode 100644 docs/english/reference/interfaces/RichTextInputAction.md create mode 100644 docs/english/reference/interfaces/ShortcutConstraints.md create mode 100644 docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md create mode 100644 docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md create mode 100644 docs/english/reference/interfaces/SlackViewMiddlewareArgs.md create mode 100644 docs/english/reference/interfaces/SlashCommand.md create mode 100644 docs/english/reference/interfaces/SocketModeReceiverOptions.md create mode 100644 docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md create mode 100644 docs/english/reference/interfaces/StaticSelectAction.md create mode 100644 docs/english/reference/interfaces/TimepickerAction.md create mode 100644 docs/english/reference/interfaces/UploadedFile.md create mode 100644 docs/english/reference/interfaces/UsersSelectAction.md create mode 100644 docs/english/reference/interfaces/ViewClearResponseAction.md create mode 100644 docs/english/reference/interfaces/ViewClosedAction.md create mode 100644 docs/english/reference/interfaces/ViewConstraints.md create mode 100644 docs/english/reference/interfaces/ViewErrorsResponseAction.md create mode 100644 docs/english/reference/interfaces/ViewOutput.md create mode 100644 docs/english/reference/interfaces/ViewPushResponseAction.md create mode 100644 docs/english/reference/interfaces/ViewResponseUrl.md create mode 100644 docs/english/reference/interfaces/ViewStateSelectedOption.md create mode 100644 docs/english/reference/interfaces/ViewStateValue.md create mode 100644 docs/english/reference/interfaces/ViewSubmitAction.md create mode 100644 docs/english/reference/interfaces/ViewUpdateResponseAction.md create mode 100644 docs/english/reference/type-aliases/AckFn.md create mode 100644 docs/english/reference/type-aliases/AnyMiddlewareArgs.md create mode 100644 docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md create mode 100644 docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md create mode 100644 docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md create mode 100644 docs/english/reference/type-aliases/Authorize.md create mode 100644 docs/english/reference/type-aliases/BlockButtonAction.md create mode 100644 docs/english/reference/type-aliases/BlockChannelsSelectAction.md create mode 100644 docs/english/reference/type-aliases/BlockCheckboxesAction.md create mode 100644 docs/english/reference/type-aliases/BlockConversationsSelectAction.md create mode 100644 docs/english/reference/type-aliases/BlockDatepickerAction.md create mode 100644 docs/english/reference/type-aliases/BlockElementAction.md create mode 100644 docs/english/reference/type-aliases/BlockExternalSelectAction.md create mode 100644 docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md create mode 100644 docs/english/reference/type-aliases/BlockIconButtonAction.md create mode 100644 docs/english/reference/type-aliases/BlockOverflowAction.md create mode 100644 docs/english/reference/type-aliases/BlockPlainTextInputAction.md create mode 100644 docs/english/reference/type-aliases/BlockRadioButtonsAction.md create mode 100644 docs/english/reference/type-aliases/BlockStaticSelectAction.md create mode 100644 docs/english/reference/type-aliases/BlockTimepickerAction.md create mode 100644 docs/english/reference/type-aliases/BlockUsersSelectAction.md create mode 100644 docs/english/reference/type-aliases/EventFromType.md create mode 100644 docs/english/reference/type-aliases/EventTypePattern.md create mode 100644 docs/english/reference/type-aliases/FunctionInputs.md create mode 100644 docs/english/reference/type-aliases/InteractiveAction.md create mode 100644 docs/english/reference/type-aliases/InteractiveButtonClick.md create mode 100644 docs/english/reference/type-aliases/InteractiveMenuSelect.md create mode 100644 docs/english/reference/type-aliases/KnownEventFromType.md create mode 100644 docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md create mode 100644 docs/english/reference/type-aliases/Middleware.md create mode 100644 docs/english/reference/type-aliases/NextFn.md create mode 100644 docs/english/reference/type-aliases/OptionsPayloadFromType.md create mode 100644 docs/english/reference/type-aliases/OptionsSource.md create mode 100644 docs/english/reference/type-aliases/RespondArguments.md create mode 100644 docs/english/reference/type-aliases/RespondFn.md create mode 100644 docs/english/reference/type-aliases/SayArguments.md create mode 100644 docs/english/reference/type-aliases/SayFn.md create mode 100644 docs/english/reference/type-aliases/SayStreamArguments.md create mode 100644 docs/english/reference/type-aliases/SayStreamFn.md create mode 100644 docs/english/reference/type-aliases/SetStatusArguments.md create mode 100644 docs/english/reference/type-aliases/SetStatusFn.md create mode 100644 docs/english/reference/type-aliases/SlackAction.md create mode 100644 docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md create mode 100644 docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md create mode 100644 docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md create mode 100644 docs/english/reference/type-aliases/SlackOptions.md create mode 100644 docs/english/reference/type-aliases/SlackShortcut.md create mode 100644 docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md create mode 100644 docs/english/reference/type-aliases/SlackViewAction.md create mode 100644 docs/english/reference/type-aliases/StringIndexed.md create mode 100644 docs/english/reference/type-aliases/ViewResponseAction.md create mode 100644 docs/english/reference/type-aliases/XOR.md create mode 100644 docs/english/reference/variables/autoAcknowledge.md create mode 100644 docs/english/reference/variables/contextBuiltinKeys.md create mode 100644 docs/english/reference/variables/directMention.md create mode 100644 docs/english/reference/variables/ignoreSelf.md create mode 100644 docs/english/reference/variables/onlyActions.md create mode 100644 docs/english/reference/variables/onlyCommands.md create mode 100644 docs/english/reference/variables/onlyEvents.md create mode 100644 docs/english/reference/variables/onlyOptions.md create mode 100644 docs/english/reference/variables/onlyShortcuts.md create mode 100644 docs/english/reference/variables/onlyViewActions.md create mode 100644 typedoc.json diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml index 135440ee0..6c5ba8f9c 100644 --- a/.github/workflows/ci-build.yml +++ b/.github/workflows/ci-build.yml @@ -35,6 +35,9 @@ jobs: node-version: ${{ matrix.node-version }} - run: npm ci --verbose - run: npm test + - name: Build docs + if: matrix.node-version == '24.x' + run: npm run docs - name: Upload coverage to Codecov if: matrix.node-version == '24.x' uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0 diff --git a/docs/english/_sidebar.json b/docs/english/_sidebar.json index 15aac6473..009b95c22 100644 --- a/docs/english/_sidebar.json +++ b/docs/english/_sidebar.json @@ -112,7 +112,17 @@ "type": "html", "value": "
" }, - "tools/bolt-js/reference", + "tools/bolt-js/interface-reference", + { + "type": "category", + "label": "Reference", + "items": [ + { + "type": "autogenerated", + "dirName": "tools/bolt-js/reference" + } + ] + }, { "type": "html", "value": "
" diff --git a/docs/english/concepts/listener-middleware.md b/docs/english/concepts/listener-middleware.md index 2fcae7102..ea4967db2 100644 --- a/docs/english/concepts/listener-middleware.md +++ b/docs/english/concepts/listener-middleware.md @@ -2,7 +2,7 @@ Listener middleware is used for logic across many listener functions (but usually not all of them). They are added as arguments before the listener function in one of the built-in methods. You can add any number of listener middleware before the listener function. -There’s a collection of [built-in listener middleware](/tools/bolt-js/reference#built-in-listener-middleware-functions) that you can use like `directMention` which filters out any message that doesn’t directly @-mention your bot at the start of a message. +There’s a collection of [built-in listener middleware](/tools/bolt-js/interface-reference#built-in-listener-middleware-functions) that you can use like `directMention` which filters out any message that doesn’t directly @-mention your bot at the start of a message. But of course, you can write your own middleware for more custom functionality. While writing your own middleware, your function must call `await next()` to pass control to the next middleware, or `throw` to pass an error back up the previously-executed middleware chain. diff --git a/docs/english/concepts/receiver.md b/docs/english/concepts/receiver.md index c42968da3..04606dfa4 100644 --- a/docs/english/concepts/receiver.md +++ b/docs/english/concepts/receiver.md @@ -21,7 +21,7 @@ For a more in-depth look at a receiver, [read the source code for the built-in ` ## Customizing built-in receivers -The built-in `HTTPReceiver`, `ExpressReceiver`, `AwsLambdaReceiver` and `SocketModeReceiver` accept several configuration options. For a full list of options, see the [Receiver options reference](/tools/bolt-js/reference#receiver-options). +The built-in `HTTPReceiver`, `ExpressReceiver`, `AwsLambdaReceiver` and `SocketModeReceiver` accept several configuration options. For a full list of options, see the [Receiver options reference](/tools/bolt-js/interface-reference#receiver-options). ### Extracting custom properties diff --git a/docs/english/concepts/using-the-assistant-class.md b/docs/english/concepts/using-the-assistant-class.md index 7220945aa..0ae7dd232 100644 --- a/docs/english/concepts/using-the-assistant-class.md +++ b/docs/english/concepts/using-the-assistant-class.md @@ -4,7 +4,7 @@ If you don't have a paid workspace for development, you can join the [Developer Program](https://api.slack.com/developer-program) and provision a sandbox with access to all Slack features for free. ::: -The [`Assistant`](/tools/bolt-js/reference#the-assistantconfig-configuration-object) class can be used to handle the incoming events expected from a user interacting with an app in Slack that has the **Agents** feature enabled. +The [`Assistant`](/tools/bolt-js/interface-reference#the-assistantconfig-configuration-object) class can be used to handle the incoming events expected from a user interacting with an app in Slack that has the **Agents** feature enabled. :::warning[The `Assistant` class targets the assistant messaging experience] The `Assistant` class handles the [assistant messaging experience](/ai/developing-agents) (`assistant_view`), in which agent conversations happen in separate Chat and History tabs. Apps going forward use the agent messaging experience (`agent_view`) by default, where conversations happen in the Messages tab and you handle events such as [`app_home_opened`](/reference/events/app_home_opened) and [`message.im`](/reference/events/message.im) directly. Refer to [Adding agent features](/tools/bolt-js/concepts/adding-agent-features) and the [agent messaging experience changelog entry](/changelog/2026/06/30/agent-messages-tab) for the default experience and migration guidance. @@ -57,7 +57,7 @@ While the `assistant_thread_started` and `assistant_thread_context_changed` even If you do provide your own `threadContextStore` property, it must feature `get` and `save` methods. -:::tip[Be sure to give the [reference docs](/tools/bolt-js/reference#agents--assistants) a look!] +:::tip[Be sure to give the [reference docs](/tools/bolt-js/interface-reference#agents--assistants) a look!] ::: ### Configuring your app to support the `Assistant` class @@ -168,7 +168,7 @@ When the user messages your app, the [`message.im`](/reference/events/message.im Messages sent to the app do not contain a [subtype](/reference/events/message/#subtypes) and must be deduced based on their shape and any provided [message metadata](/messaging/message-metadata/). -There are three [utilities](/tools/bolt-js/reference#the-assistantconfig-configuration-object) that are particularly useful in curating the user experience: +There are three [utilities](/tools/bolt-js/interface-reference#the-assistantconfig-configuration-object) that are particularly useful in curating the user experience: * `say` * `setTitle` * `setStatus` diff --git a/docs/english/reference.md b/docs/english/interface-reference.md similarity index 99% rename from docs/english/reference.md rename to docs/english/interface-reference.md index 390dea6f9..dbcf88a1b 100644 --- a/docs/english/reference.md +++ b/docs/english/interface-reference.md @@ -1,5 +1,5 @@ --- -sidebar_label: Reference +sidebar_label: Interface and configuration reference --- # Bolt for JavaScript interface and configuration reference diff --git a/docs/english/migration/migration-v4.md b/docs/english/migration/migration-v4.md index 660657b1a..91adfc407 100644 --- a/docs/english/migration/migration-v4.md +++ b/docs/english/migration/migration-v4.md @@ -90,7 +90,7 @@ import { defaultProcessEventHandler } from '@slack/bolt'; ## 🏭 Built-in middleware changes {#built-in-middleware-changes} -Two [built-in middlewares](/tools/bolt-js/reference#built-in-middleware-functions), `ignoreSelf` and `directMention`, previously needed to be invoked as a function in order to _return_ a middleware. These two built-in middlewares were not parameterized in the sense that they should just be used directly; as a result, you no longer should invoke them and instead pass them directly. +Two [built-in middlewares](/tools/bolt-js/interface-reference#built-in-middleware-functions), `ignoreSelf` and `directMention`, previously needed to be invoked as a function in order to _return_ a middleware. These two built-in middlewares were not parameterized in the sense that they should just be used directly; as a result, you no longer should invoke them and instead pass them directly. As an example, previously you may have leveraged `directMention` like this: diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md new file mode 100644 index 000000000..9af8edb83 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / bufferIncomingMessage + +# Function: bufferIncomingMessage() + +```ts +function bufferIncomingMessage(req): Promise; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:117](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L117) + +## Parameters + +### req + +`IncomingMessage` + +## Returns + +`Promise`\<[`BufferedIncomingMessage`](../../../../interfaces/BufferedIncomingMessage.md)\> diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md new file mode 100644 index 000000000..91496ef38 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md @@ -0,0 +1,23 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildContentResponse + +# Function: buildContentResponse() + +```ts +function buildContentResponse(res, body): void; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:147](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L147) + +## Parameters + +### res + +`ServerResponse` + +### body + +`any` + +## Returns + +`void` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md new file mode 100644 index 000000000..d04c0570e --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md @@ -0,0 +1,23 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildNoBodyResponse + +# Function: buildNoBodyResponse() + +```ts +function buildNoBodyResponse(res, status): void; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:130](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L130) + +## Parameters + +### res + +`ServerResponse` + +### status + +`number` + +## Returns + +`void` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md new file mode 100644 index 000000000..88520ea8d --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildSSLCheckResponse + +# Function: buildSSLCheckResponse() + +```ts +function buildSSLCheckResponse(res): void; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:141](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L141) + +## Parameters + +### res + +`ServerResponse` + +## Returns + +`void` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md new file mode 100644 index 000000000..ed09e6c7c --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md @@ -0,0 +1,23 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildUrlVerificationResponse + +# Function: buildUrlVerificationResponse() + +```ts +function buildUrlVerificationResponse(res, body): void; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:136](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L136) + +## Parameters + +### res + +`ServerResponse` + +### body + +`any` + +## Returns + +`void` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md new file mode 100644 index 000000000..41e8c3f71 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultAsyncDispatchErrorHandler + +# Function: defaultAsyncDispatchErrorHandler() + +```ts +function defaultAsyncDispatchErrorHandler(args): Promise; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:181](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L181) + +## Parameters + +### args + +[`ReceiverDispatchErrorHandlerArgs`](../interfaces/ReceiverDispatchErrorHandlerArgs.md) + +## Returns + +`Promise`\<`void`\> diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md new file mode 100644 index 000000000..08d27148e --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultDispatchErrorHandler + +# Function: defaultDispatchErrorHandler() + +```ts +function defaultDispatchErrorHandler(args): void; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:167](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L167) + +## Parameters + +### args + +[`ReceiverDispatchErrorHandlerArgs`](../interfaces/ReceiverDispatchErrorHandlerArgs.md) + +## Returns + +`void` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md new file mode 100644 index 000000000..74fb71b52 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultProcessEventErrorHandler + +# Function: defaultProcessEventErrorHandler() + +```ts +function defaultProcessEventErrorHandler(args): Promise; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:187](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L187) + +## Parameters + +### args + +[`ReceiverProcessEventErrorHandlerArgs`](../interfaces/ReceiverProcessEventErrorHandlerArgs.md) + +## Returns + +`Promise`\<`boolean`\> diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md new file mode 100644 index 000000000..f69790e59 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultUnhandledRequestHandler + +# Function: defaultUnhandledRequestHandler() + +```ts +function defaultUnhandledRequestHandler(args): void; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:213](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L213) + +## Parameters + +### args + +[`ReceiverUnhandledRequestHandlerArgs`](../interfaces/ReceiverUnhandledRequestHandlerArgs.md) + +## Returns + +`void` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md new file mode 100644 index 000000000..d46919aaf --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / extractRetryNumFromHTTPRequest + +# Function: extractRetryNumFromHTTPRequest() + +```ts +function extractRetryNumFromHTTPRequest(req): number | undefined; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L11) + +## Parameters + +### req + +`IncomingMessage` + +## Returns + +`number` \| `undefined` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md new file mode 100644 index 000000000..8130c030f --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / extractRetryReasonFromHTTPRequest + +# Function: extractRetryReasonFromHTTPRequest() + +```ts +function extractRetryReasonFromHTTPRequest(req): string | undefined; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L24) + +## Parameters + +### req + +`IncomingMessage` + +## Returns + +`string` \| `undefined` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md new file mode 100644 index 000000000..6bfb659e2 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md @@ -0,0 +1,23 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / getHeader + +# Function: getHeader() + +```ts +function getHeader(req, header): string; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:107](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L107) + +## Parameters + +### req + +`IncomingMessage` + +### header + +`string` + +## Returns + +`string` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md new file mode 100644 index 000000000..8557d64b3 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / isBufferedIncomingMessage + +# Function: isBufferedIncomingMessage() + +```ts +function isBufferedIncomingMessage(req): req is BufferedIncomingMessage; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:102](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L102) + +## Parameters + +### req + +`IncomingMessage` + +## Returns + +`req is BufferedIncomingMessage` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md new file mode 100644 index 000000000..613bbb8f3 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md @@ -0,0 +1,31 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / parseAndVerifyHTTPRequest + +# Function: parseAndVerifyHTTPRequest() + +```ts +function parseAndVerifyHTTPRequest( + options, + req, + _res? +): Promise; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:55](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L55) + +## Parameters + +### options + +[`RequestVerificationOptions`](../interfaces/RequestVerificationOptions.md) + +### req + +`IncomingMessage` + +### \_res? + +`ServerResponse`\<`IncomingMessage`\> + +## Returns + +`Promise`\<[`BufferedIncomingMessage`](../../../../interfaces/BufferedIncomingMessage.md)\> diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md new file mode 100644 index 000000000..858f0f2c2 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md @@ -0,0 +1,19 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / parseHTTPRequestBody + +# Function: parseHTTPRequestBody() + +```ts +function parseHTTPRequestBody(req): any; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L41) + +## Parameters + +### req + +[`BufferedIncomingMessage`](../../../../interfaces/BufferedIncomingMessage.md) + +## Returns + +`any` diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md new file mode 100644 index 000000000..620f3c767 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md @@ -0,0 +1,28 @@ +[@slack/bolt](../../../index.md) / HTTPModuleFunctions + +# HTTPModuleFunctions + +## Interfaces + +- [ReceiverDispatchErrorHandlerArgs](interfaces/ReceiverDispatchErrorHandlerArgs.md) +- [ReceiverProcessEventErrorHandlerArgs](interfaces/ReceiverProcessEventErrorHandlerArgs.md) +- [ReceiverUnhandledRequestHandlerArgs](interfaces/ReceiverUnhandledRequestHandlerArgs.md) +- [RequestVerificationOptions](interfaces/RequestVerificationOptions.md) + +## Functions + +- [bufferIncomingMessage](functions/bufferIncomingMessage.md) +- [buildContentResponse](functions/buildContentResponse.md) +- [buildNoBodyResponse](functions/buildNoBodyResponse.md) +- [buildSSLCheckResponse](functions/buildSSLCheckResponse.md) +- [buildUrlVerificationResponse](functions/buildUrlVerificationResponse.md) +- [defaultAsyncDispatchErrorHandler](functions/defaultAsyncDispatchErrorHandler.md) +- [defaultDispatchErrorHandler](functions/defaultDispatchErrorHandler.md) +- [defaultProcessEventErrorHandler](functions/defaultProcessEventErrorHandler.md) +- [defaultUnhandledRequestHandler](functions/defaultUnhandledRequestHandler.md) +- [extractRetryNumFromHTTPRequest](functions/extractRetryNumFromHTTPRequest.md) +- [extractRetryReasonFromHTTPRequest](functions/extractRetryReasonFromHTTPRequest.md) +- [getHeader](functions/getHeader.md) +- [isBufferedIncomingMessage](functions/isBufferedIncomingMessage.md) +- [parseAndVerifyHTTPRequest](functions/parseAndVerifyHTTPRequest.md) +- [parseHTTPRequestBody](functions/parseHTTPRequestBody.md) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md new file mode 100644 index 000000000..9ffba7196 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md @@ -0,0 +1,45 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverDispatchErrorHandlerArgs + +# Interface: ReceiverDispatchErrorHandlerArgs + +Defined in: [src/receivers/HTTPModuleFunctions.ts:236](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L236) + +## Properties + +### error + +```ts +error: CodedError | Error; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:237](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L237) + +*** + +### logger + +```ts +logger: Logger; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:238](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L238) + +*** + +### request + +```ts +request: IncomingMessage; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:239](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L239) + +*** + +### response + +```ts +response: ServerResponse; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:240](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L240) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md new file mode 100644 index 000000000..d71f21c24 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md @@ -0,0 +1,55 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverProcessEventErrorHandlerArgs + +# Interface: ReceiverProcessEventErrorHandlerArgs + +Defined in: [src/receivers/HTTPModuleFunctions.ts:245](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L245) + +## Properties + +### error + +```ts +error: CodedError | Error; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:246](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L246) + +*** + +### logger + +```ts +logger: Logger; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:247](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L247) + +*** + +### request + +```ts +request: IncomingMessage; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:248](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L248) + +*** + +### response + +```ts +response: ServerResponse; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:249](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L249) + +*** + +### storedResponse + +```ts +storedResponse: any; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:251](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L251) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md new file mode 100644 index 000000000..6a1ea7796 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md @@ -0,0 +1,35 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverUnhandledRequestHandlerArgs + +# Interface: ReceiverUnhandledRequestHandlerArgs + +Defined in: [src/receivers/HTTPModuleFunctions.ts:257](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L257) + +## Properties + +### logger + +```ts +logger: Logger; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:258](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L258) + +*** + +### request + +```ts +request: IncomingMessage; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:259](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L259) + +*** + +### response + +```ts +response: ServerResponse; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:260](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L260) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md new file mode 100644 index 000000000..e55389d79 --- /dev/null +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md @@ -0,0 +1,49 @@ +[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / RequestVerificationOptions + +# Interface: RequestVerificationOptions + +Defined in: [src/receivers/HTTPModuleFunctions.ts:228](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L228) + +## Properties + +### enabled? + +```ts +optional enabled?: boolean; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:229](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L229) + +*** + +### logger? + +```ts +optional logger?: Logger; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:232](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L232) + +*** + +### nowMilliseconds? + +```ts +optional nowMilliseconds?: () => number; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:231](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L231) + +#### Returns + +`number` + +*** + +### signingSecret + +```ts +signingSecret: string; +``` + +Defined in: [src/receivers/HTTPModuleFunctions.ts:230](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L230) diff --git a/docs/english/reference/classes/App.md b/docs/english/reference/classes/App.md new file mode 100644 index 000000000..0e21bfb85 --- /dev/null +++ b/docs/english/reference/classes/App.md @@ -0,0 +1,884 @@ +[@slack/bolt](../index.md) / App + +# Class: App\ + +Defined in: [src/App.ts:233](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L233) + +A Slack App + +## Type Parameters + +### AppCustomContext + +`AppCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Constructors + +### Constructor + +```ts +new App(__namedParameters?): App; +``` + +Defined in: [src/App.ts:289](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L289) + +#### Parameters + +##### \_\_namedParameters? + +[`AppOptions`](../interfaces/AppOptions.md) = `{}` + +#### Returns + +`App`\<`AppCustomContext`\> + +## Properties + +### client + +```ts +client: WebClient; +``` + +Defined in: [src/App.ts:235](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L235) + +Slack Web API client + +*** + +### logger + +```ts +logger: Logger; +``` + +Defined in: [src/App.ts:246](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L246) + +Logger + +## Accessors + +### webClientOptions + +#### Get Signature + +```ts +get webClientOptions(): WebClientOptions; +``` + +Defined in: [src/App.ts:493](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L493) + +##### Returns + +`WebClientOptions` + +## Methods + +### action() + +#### Call Signature + +```ts +action(actionId, ...listeners): void; +``` + +Defined in: [src/App.ts:735](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L735) + +##### Type Parameters + +###### Action + +`Action` *extends* [`SlackAction`](../type-aliases/SlackAction.md) = [`SlackAction`](../type-aliases/SlackAction.md) + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### actionId + +`string` \| `RegExp` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackActionMiddlewareArgs`](../type-aliases/SlackActionMiddlewareArgs.md)\<`Action`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +#### Call Signature + +```ts +action(constraints, ...listeners): void; +``` + +Defined in: [src/App.ts:742](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L742) + +##### Type Parameters + +###### Action + +`Action` *extends* [`SlackAction`](../type-aliases/SlackAction.md) = [`SlackAction`](../type-aliases/SlackAction.md) + +###### Constraints + +`Constraints` *extends* [`ActionConstraints`](../interfaces/ActionConstraints.md)\<`Action`\> = [`ActionConstraints`](../interfaces/ActionConstraints.md)\<`Action`\> + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### constraints + +`Constraints` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackActionMiddlewareArgs`](../type-aliases/SlackActionMiddlewareArgs.md)\<`Extract`\<`Action`, \{ + `type`: `Constraints`\[`"type"`\]; +\}\>\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +*** + +### assistant() + +```ts +assistant(assistant): this; +``` + +Defined in: [src/App.ts:514](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L514) + +Register Assistant middleware + +#### Parameters + +##### assistant + +[`Assistant`](Assistant.md) + +global assistant middleware function + +#### Returns + +`this` + +*** + +### command() + +```ts +command(commandName, ...listeners): void; +``` + +Defined in: [src/App.ts:788](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L788) + +#### Type Parameters + +##### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +#### Parameters + +##### commandName + +`string` \| `RegExp` + +##### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackCommandMiddlewareArgs`](../interfaces/SlackCommandMiddlewareArgs.md), `AppCustomContext` & `MiddlewareCustomContext`\>[] + +#### Returns + +`void` + +*** + +### error() + +#### Call Signature + +```ts +error(errorHandler): void; +``` + +Defined in: [src/App.ts:884](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L884) + +##### Parameters + +###### errorHandler + +`ErrorHandler` + +##### Returns + +`void` + +#### Call Signature + +```ts +error(errorHandler): void; +``` + +Defined in: [src/App.ts:885](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L885) + +##### Parameters + +###### errorHandler + +`ExtendedErrorHandler` + +##### Returns + +`void` + +*** + +### event() + +#### Call Signature + +```ts +event(eventName, ...listeners): void; +``` + +Defined in: [src/App.ts:577](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L577) + +##### Type Parameters + +###### EventType + +`EventType` *extends* `string` = `string` + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### eventName + +`EventType` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackEventMiddlewareArgs`](../type-aliases/SlackEventMiddlewareArgs.md)\<`EventType`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +#### Call Signature + +```ts +event(eventName, ...listeners): void; +``` + +Defined in: [src/App.ts:581](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L581) + +##### Type Parameters + +###### EventType + +`EventType` *extends* `RegExp` = `RegExp` + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### eventName + +`EventType` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackEventMiddlewareArgs`](../type-aliases/SlackEventMiddlewareArgs.md)\<`string`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +*** + +### function() + +#### Call Signature + +```ts +function( + callbackId, + options?, + ...listeners +): this; +``` + +Defined in: [src/App.ts:528](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L528) + +Register a listener for a custom function's execution. + +##### Parameters + +###### callbackId + +`string` + +Unique callback ID of the custom function. + +###### options? + +[`SlackEventMiddlewareArgsOptions`](../type-aliases/SlackEventMiddlewareArgsOptions.md) + +Configurations for the listener. + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<`SlackCustomFunctionMiddlewareArgs`\>[] + +Middleware handlers to call. + +##### Returns + +`this` + +##### See + + - [https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/](https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/) + - [https://docs.slack.dev/workflows/creating-custom-steps-dynamic-options](https://docs.slack.dev/workflows/creating-custom-steps-dynamic-options) + +#### Call Signature + +```ts +function(callbackId, ...listeners): this; +``` + +Defined in: [src/App.ts:533](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L533) + +Register a listener for a custom function's execution. + +##### Parameters + +###### callbackId + +`string` + +Unique callback ID of the custom function. + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<`SlackCustomFunctionMiddlewareArgs`\>[] + +Middleware handlers to call. + +##### Returns + +`this` + +##### See + + - [https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/](https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/) + - [https://docs.slack.dev/workflows/creating-custom-steps-dynamic-options](https://docs.slack.dev/workflows/creating-custom-steps-dynamic-options) + +*** + +### init() + +```ts +init(): Promise; +``` + +Defined in: [src/App.ts:458](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L458) + +#### Returns + +`Promise`\<`void`\> + +*** + +### message() + +#### Call Signature + +```ts +message(...listeners): void; +``` + +Defined in: [src/App.ts:618](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L618) + +##### Type Parameters + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### listeners + +...`MessageEventMiddleware`\<`AppCustomContext` & `MiddlewareCustomContext`\>[] + +Middlewares that process and react to a message event + +##### Returns + +`void` + +#### Call Signature + +```ts +message(pattern, ...listeners): void; +``` + +Defined in: [src/App.ts:627](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L627) + +##### Type Parameters + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### pattern + +`string` \| `RegExp` + +Used for filtering out messages that don't match. +Strings match via String.prototype.includes. + +###### listeners + +...`MessageEventMiddleware`\<`AppCustomContext` & `MiddlewareCustomContext`\>[] + +Middlewares that process and react to the message events that matched the provided patterns. + +##### Returns + +`void` + +#### Call Signature + +```ts +message( + filter, + pattern, + ...listeners +): void; +``` + +Defined in: [src/App.ts:639](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L639) + +##### Type Parameters + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### filter + +`MessageEventMiddleware`\<`AppCustomContext` & `MiddlewareCustomContext`\> + +Middleware that can filter out messages. Generally this is done by returning before +calling [AllMiddlewareArgs.next](../interfaces/AllMiddlewareArgs.md#next) if there is no match. See [directMention](../variables/directMention.md) for an example. + +###### pattern + +`string` \| `RegExp` + +Used for filtering out messages that don't match the pattern. Strings match +via String.prototype.includes. + +###### listeners + +...`MessageEventMiddleware`\<`AppCustomContext` & `MiddlewareCustomContext`\>[] + +Middlewares that process and react to the message events that matched the provided pattern. + +##### Returns + +`void` + +#### Call Signature + +```ts +message(filter, ...listeners): void; +``` + +Defined in: [src/App.ts:650](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L650) + +##### Type Parameters + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### filter + +`MessageEventMiddleware` + +Middleware that can filter out messages. Generally this is done by returning before calling +[AllMiddlewareArgs.next](../interfaces/AllMiddlewareArgs.md#next) if there is no match. See [directMention](../variables/directMention.md) for an example. + +###### listeners + +...`MessageEventMiddleware`\<`AppCustomContext` & `MiddlewareCustomContext`\>[] + +Middlewares that process and react to the message events that matched the provided patterns. + +##### Returns + +`void` + +#### Call Signature + +```ts +message(...patternsOrMiddleware): void; +``` + +Defined in: [src/App.ts:660](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L660) + +This allows for further control of the filtering and response logic. Patterns and middlewares are processed in +the order provided. If any patterns do not match, or a middleware does not call [AllMiddlewareArgs.next](../interfaces/AllMiddlewareArgs.md#next), +all remaining patterns and middlewares will be skipped. + +##### Type Parameters + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### patternsOrMiddleware + +...( + \| `string` + \| `RegExp` + \| `MessageEventMiddleware`\<`AppCustomContext` & `MiddlewareCustomContext`\>)[] + +A mix of patterns and/or middlewares. + +##### Returns + +`void` + +*** + +### options() + +#### Call Signature + +```ts +options(actionId, ...listeners): void; +``` + +Defined in: [src/App.ts:801](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L801) + +##### Type Parameters + +###### Source + +`Source` *extends* `"interactive_message"` \| `"block_suggestion"` \| `"dialog_suggestion"` = `"block_suggestion"` + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### actionId + +`string` \| `RegExp` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackOptionsMiddlewareArgs`](../interfaces/SlackOptionsMiddlewareArgs.md)\<`Source`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +#### Call Signature + +```ts +options(constraints, ...listeners): void; +``` + +Defined in: [src/App.ts:809](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L809) + +##### Type Parameters + +###### Source + +`Source` *extends* `"interactive_message"` \| `"block_suggestion"` \| `"dialog_suggestion"` = `"interactive_message"` \| `"block_suggestion"` \| `"dialog_suggestion"` + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### constraints + +[`OptionsConstraints`](../interfaces/OptionsConstraints.md) + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackOptionsMiddlewareArgs`](../interfaces/SlackOptionsMiddlewareArgs.md)\<`Source`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +*** + +### processEvent() + +```ts +processEvent(event): Promise; +``` + +Defined in: [src/App.ts:894](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L894) + +Handles events from the receiver + +#### Parameters + +##### event + +[`ReceiverEvent`](../interfaces/ReceiverEvent.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### shortcut() + +#### Call Signature + +```ts +shortcut(callbackId, ...listeners): void; +``` + +Defined in: [src/App.ts:682](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L682) + +##### Type Parameters + +###### Shortcut + +`Shortcut` *extends* [`SlackShortcut`](../type-aliases/SlackShortcut.md) = [`SlackShortcut`](../type-aliases/SlackShortcut.md) + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### callbackId + +`string` \| `RegExp` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackShortcutMiddlewareArgs`](../type-aliases/SlackShortcutMiddlewareArgs.md)\<`Shortcut`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +#### Call Signature + +```ts +shortcut(constraints, ...listeners): void; +``` + +Defined in: [src/App.ts:689](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L689) + +##### Type Parameters + +###### Shortcut + +`Shortcut` *extends* [`SlackShortcut`](../type-aliases/SlackShortcut.md) = [`SlackShortcut`](../type-aliases/SlackShortcut.md) + +###### Constraints + +`Constraints` *extends* [`ShortcutConstraints`](../interfaces/ShortcutConstraints.md)\<`Shortcut`\> = [`ShortcutConstraints`](../interfaces/ShortcutConstraints.md)\<`Shortcut`\> + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### constraints + +`Constraints` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackShortcutMiddlewareArgs`](../type-aliases/SlackShortcutMiddlewareArgs.md)\<`Extract`\<`Shortcut`, \{ + `type`: `Constraints`\[`"type"`\]; +\}\>\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +*** + +### start() + +```ts +start(...args): Promise>; +``` + +Defined in: [src/App.ts:559](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L559) + +Convenience method to call start on the receiver + +TODO: should replace HTTPReceiver in type definition with a generic that is constrained to Receiver + +#### Parameters + +##### args + +\[`string` \| `number` \| `ListenOptions`, `ServerOptions`\] \| \[\] + +receiver-specific start arguments + +#### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +*** + +### stop() + +```ts +stop(...args): Promise; +``` + +Defined in: [src/App.ts:572](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L572) + +#### Parameters + +##### args + +...`any`[] + +#### Returns + +`Promise`\<`unknown`\> + +*** + +### use() + +```ts +use(m): this; +``` + +Defined in: [src/App.ts:502](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L502) + +Register a new middleware, processed in the order registered. + +#### Type Parameters + +##### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +#### Parameters + +##### m + +[`Middleware`](../type-aliases/Middleware.md)\<[`AnyMiddlewareArgs`](../type-aliases/AnyMiddlewareArgs.md), `AppCustomContext` & `MiddlewareCustomContext`\> + +global middleware function + +#### Returns + +`this` + +*** + +### view() + +#### Call Signature + +```ts +view(callbackId, ...listeners): void; +``` + +Defined in: [src/App.ts:834](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L834) + +##### Type Parameters + +###### ViewActionType + +`ViewActionType` *extends* [`SlackViewAction`](../type-aliases/SlackViewAction.md) = [`SlackViewAction`](../type-aliases/SlackViewAction.md) + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### callbackId + +`string` \| `RegExp` + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackViewMiddlewareArgs`](../interfaces/SlackViewMiddlewareArgs.md)\<`ViewActionType`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` + +#### Call Signature + +```ts +view(constraints, ...listeners): void; +``` + +Defined in: [src/App.ts:841](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L841) + +##### Type Parameters + +###### ViewActionType + +`ViewActionType` *extends* [`SlackViewAction`](../type-aliases/SlackViewAction.md) = [`SlackViewAction`](../type-aliases/SlackViewAction.md) + +###### MiddlewareCustomContext + +`MiddlewareCustomContext` *extends* [`StringIndexed`](../type-aliases/StringIndexed.md) = [`StringIndexed`](../type-aliases/StringIndexed.md) + +##### Parameters + +###### constraints + +[`ViewConstraints`](../interfaces/ViewConstraints.md) + +###### listeners + +...[`Middleware`](../type-aliases/Middleware.md)\<[`SlackViewMiddlewareArgs`](../interfaces/SlackViewMiddlewareArgs.md)\<`ViewActionType`\>, `AppCustomContext` & `MiddlewareCustomContext`\>[] + +##### Returns + +`void` diff --git a/docs/english/reference/classes/AppInitializationError.md b/docs/english/reference/classes/AppInitializationError.md new file mode 100644 index 000000000..a796ef050 --- /dev/null +++ b/docs/english/reference/classes/AppInitializationError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / AppInitializationError + +# Class: AppInitializationError + +Defined in: [src/errors.ts:72](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L72) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new AppInitializationError(message?): AppInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`AppInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new AppInitializationError(message?, options?): AppInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`AppInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.AppInitializationError; +``` + +Defined in: [src/errors.ts:73](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L73) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/Assistant.md b/docs/english/reference/classes/Assistant.md new file mode 100644 index 000000000..9ecf58865 --- /dev/null +++ b/docs/english/reference/classes/Assistant.md @@ -0,0 +1,39 @@ +[@slack/bolt](../index.md) / Assistant + +# Class: Assistant + +Defined in: [src/Assistant.ts:99](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L99) + +## Constructors + +### Constructor + +```ts +new Assistant(config): Assistant; +``` + +Defined in: [src/Assistant.ts:111](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L111) + +#### Parameters + +##### config + +[`AssistantConfig`](../interfaces/AssistantConfig.md) + +#### Returns + +`Assistant` + +## Methods + +### getMiddleware() + +```ts +getMiddleware(): Middleware; +``` + +Defined in: [src/Assistant.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L131) + +#### Returns + +[`Middleware`](../type-aliases/Middleware.md)\<[`AnyMiddlewareArgs`](../type-aliases/AnyMiddlewareArgs.md)\> diff --git a/docs/english/reference/classes/AssistantInitializationError.md b/docs/english/reference/classes/AssistantInitializationError.md new file mode 100644 index 000000000..28cc6eeac --- /dev/null +++ b/docs/english/reference/classes/AssistantInitializationError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / AssistantInitializationError + +# Class: AssistantInitializationError + +Defined in: [src/errors.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L76) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new AssistantInitializationError(message?): AssistantInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`AssistantInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new AssistantInitializationError(message?, options?): AssistantInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`AssistantInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.AssistantInitializationError; +``` + +Defined in: [src/errors.ts:77](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L77) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/AssistantMissingPropertyError.md b/docs/english/reference/classes/AssistantMissingPropertyError.md new file mode 100644 index 000000000..f9a71c183 --- /dev/null +++ b/docs/english/reference/classes/AssistantMissingPropertyError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / AssistantMissingPropertyError + +# Class: AssistantMissingPropertyError + +Defined in: [src/errors.ts:80](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L80) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new AssistantMissingPropertyError(message?): AssistantMissingPropertyError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`AssistantMissingPropertyError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new AssistantMissingPropertyError(message?, options?): AssistantMissingPropertyError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`AssistantMissingPropertyError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.AssistantMissingPropertyError; +``` + +Defined in: [src/errors.ts:81](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L81) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/AuthorizationError.md b/docs/english/reference/classes/AuthorizationError.md new file mode 100644 index 000000000..c11cb57cf --- /dev/null +++ b/docs/english/reference/classes/AuthorizationError.md @@ -0,0 +1,71 @@ +[@slack/bolt](../index.md) / AuthorizationError + +# Class: AuthorizationError + +Defined in: [src/errors.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L84) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new AuthorizationError(message, original): AuthorizationError; +``` + +Defined in: [src/errors.ts:89](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L89) + +#### Parameters + +##### message + +`string` + +##### original + +`Error` + +#### Returns + +`AuthorizationError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.AuthorizationError; +``` + +Defined in: [src/errors.ts:85](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L85) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +*** + +### original + +```ts +original: Error; +``` + +Defined in: [src/errors.ts:87](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L87) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`original`](../interfaces/CodedError.md#original) diff --git a/docs/english/reference/classes/AwsLambdaReceiver.md b/docs/english/reference/classes/AwsLambdaReceiver.md new file mode 100644 index 000000000..d6bc0dd1a --- /dev/null +++ b/docs/english/reference/classes/AwsLambdaReceiver.md @@ -0,0 +1,131 @@ +[@slack/bolt](../index.md) / AwsLambdaReceiver + +# Class: AwsLambdaReceiver + +Defined in: [src/receivers/AwsLambdaReceiver.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L131) + +## Implements + +- [`Receiver`](../interfaces/Receiver.md) + +## Constructors + +### Constructor + +```ts +new AwsLambdaReceiver(__namedParameters): AwsLambdaReceiver; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:150](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L150) + +#### Parameters + +##### \_\_namedParameters + +[`AwsLambdaReceiverOptions`](../interfaces/AwsLambdaReceiverOptions.md) + +#### Returns + +`AwsLambdaReceiver` + +## Accessors + +### logger + +#### Get Signature + +```ts +get logger(): Logger; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:138](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L138) + +##### Returns + +`Logger` + +## Methods + +### init() + +```ts +init(app): void; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:179](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L179) + +#### Parameters + +##### app + +[`App`](App.md) + +#### Returns + +`void` + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`init`](../interfaces/Receiver.md#init) + +*** + +### start() + +```ts +start(..._args): Promise; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:184](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L184) + +#### Parameters + +##### \_args + +...`any`[] + +#### Returns + +`Promise`\<`AwsHandler`\> + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`start`](../interfaces/Receiver.md#start) + +*** + +### stop() + +```ts +stop(..._args): Promise; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:196](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L196) + +#### Parameters + +##### \_args + +...`any`[] + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`stop`](../interfaces/Receiver.md#stop) + +*** + +### toHandler() + +```ts +toHandler(): AwsHandler; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:202](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L202) + +#### Returns + +`AwsHandler` diff --git a/docs/english/reference/classes/ContextMissingPropertyError.md b/docs/english/reference/classes/ContextMissingPropertyError.md new file mode 100644 index 000000000..be849fcc0 --- /dev/null +++ b/docs/english/reference/classes/ContextMissingPropertyError.md @@ -0,0 +1,71 @@ +[@slack/bolt](../index.md) / ContextMissingPropertyError + +# Class: ContextMissingPropertyError + +Defined in: [src/errors.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L96) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new ContextMissingPropertyError(missingProperty, message): ContextMissingPropertyError; +``` + +Defined in: [src/errors.ts:101](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L101) + +#### Parameters + +##### missingProperty + +`string` + +##### message + +`string` + +#### Returns + +`ContextMissingPropertyError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.ContextMissingPropertyError; +``` + +Defined in: [src/errors.ts:97](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L97) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +*** + +### missingProperty + +```ts +missingProperty: string; +``` + +Defined in: [src/errors.ts:99](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L99) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`missingProperty`](../interfaces/CodedError.md#missingproperty) diff --git a/docs/english/reference/classes/CustomFunctionCompleteFailError.md b/docs/english/reference/classes/CustomFunctionCompleteFailError.md new file mode 100644 index 000000000..2ba8cf435 --- /dev/null +++ b/docs/english/reference/classes/CustomFunctionCompleteFailError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / CustomFunctionCompleteFailError + +# Class: CustomFunctionCompleteFailError + +Defined in: [src/errors.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L177) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new CustomFunctionCompleteFailError(message?): CustomFunctionCompleteFailError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`CustomFunctionCompleteFailError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new CustomFunctionCompleteFailError(message?, options?): CustomFunctionCompleteFailError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`CustomFunctionCompleteFailError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.CustomFunctionCompleteFailError; +``` + +Defined in: [src/errors.ts:178](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L178) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md new file mode 100644 index 000000000..1e06b1ebb --- /dev/null +++ b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / CustomFunctionCompleteSuccessError + +# Class: CustomFunctionCompleteSuccessError + +Defined in: [src/errors.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L173) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new CustomFunctionCompleteSuccessError(message?): CustomFunctionCompleteSuccessError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`CustomFunctionCompleteSuccessError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new CustomFunctionCompleteSuccessError(message?, options?): CustomFunctionCompleteSuccessError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`CustomFunctionCompleteSuccessError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.CustomFunctionCompleteSuccessError; +``` + +Defined in: [src/errors.ts:174](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L174) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/CustomFunctionInitializationError.md b/docs/english/reference/classes/CustomFunctionInitializationError.md new file mode 100644 index 000000000..f35901e9c --- /dev/null +++ b/docs/english/reference/classes/CustomFunctionInitializationError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / CustomFunctionInitializationError + +# Class: CustomFunctionInitializationError + +Defined in: [src/errors.ts:169](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L169) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new CustomFunctionInitializationError(message?): CustomFunctionInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`CustomFunctionInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new CustomFunctionInitializationError(message?, options?): CustomFunctionInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`CustomFunctionInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.CustomFunctionInitializationError; +``` + +Defined in: [src/errors.ts:170](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L170) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/CustomRouteInitializationError.md b/docs/english/reference/classes/CustomRouteInitializationError.md new file mode 100644 index 000000000..fae8b67c2 --- /dev/null +++ b/docs/english/reference/classes/CustomRouteInitializationError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / CustomRouteInitializationError + +# Class: CustomRouteInitializationError + +Defined in: [src/errors.ts:111](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L111) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new CustomRouteInitializationError(message?): CustomRouteInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`CustomRouteInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new CustomRouteInitializationError(message?, options?): CustomRouteInitializationError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`CustomRouteInitializationError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.CustomRouteInitializationError; +``` + +Defined in: [src/errors.ts:112](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L112) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/ExpressReceiver.md b/docs/english/reference/classes/ExpressReceiver.md new file mode 100644 index 000000000..db464fda2 --- /dev/null +++ b/docs/english/reference/classes/ExpressReceiver.md @@ -0,0 +1,219 @@ +[@slack/bolt](../index.md) / ExpressReceiver + +# Class: ExpressReceiver + +Defined in: [src/receivers/ExpressReceiver.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L145) + +Receives HTTP requests with Events, Slash Commands, and Actions + +## Implements + +- [`Receiver`](../interfaces/Receiver.md) + +## Constructors + +### Constructor + +```ts +new ExpressReceiver(__namedParameters): ExpressReceiver; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:175](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L175) + +#### Parameters + +##### \_\_namedParameters + +[`ExpressReceiverOptions`](../interfaces/ExpressReceiverOptions.md) + +#### Returns + +`ExpressReceiver` + +## Properties + +### app + +```ts +app: Application; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:147](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L147) + +*** + +### installer + +```ts +installer: InstallProvider | undefined = undefined; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:161](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L161) + +*** + +### installerOptions? + +```ts +optional installerOptions?: InstallerOptions; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:163](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L163) + +*** + +### router + +```ts +router: IRouter; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:159](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L159) + +## Methods + +### init() + +```ts +init(bolt): void; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:357](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L357) + +#### Parameters + +##### bolt + +[`App`](App.md) + +#### Returns + +`void` + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`init`](../interfaces/Receiver.md#init) + +*** + +### requestHandler() + +```ts +requestHandler(req, res): Promise; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:317](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L317) + +#### Parameters + +##### req + +`Request` + +##### res + +`Response` + +#### Returns + +`Promise`\<`void`\> + +*** + +### start() + +#### Call Signature + +```ts +start(port): Promise>; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:362](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L362) + +##### Parameters + +###### port + +`number` + +##### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +##### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`start`](../interfaces/Receiver.md#start) + +#### Call Signature + +```ts +start(portOrListenOptions, serverOptions?): Promise>; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:363](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L363) + +##### Parameters + +###### portOrListenOptions + +`number` \| `ListenOptions` + +###### serverOptions? + +`ServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\> + +##### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +##### Implementation of + +```ts +Receiver.start +``` + +#### Call Signature + +```ts +start(portOrListenOptions, httpsServerOptions?): Promise>; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:364](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L364) + +##### Parameters + +###### portOrListenOptions + +`number` \| `ListenOptions` + +###### httpsServerOptions? + +`ServerOptions` + +##### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +##### Implementation of + +```ts +Receiver.start +``` + +*** + +### stop() + +```ts +stop(): Promise; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:428](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L428) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`stop`](../interfaces/Receiver.md#stop) diff --git a/docs/english/reference/classes/HTTPReceiver.md b/docs/english/reference/classes/HTTPReceiver.md new file mode 100644 index 000000000..d9fafa850 --- /dev/null +++ b/docs/english/reference/classes/HTTPReceiver.md @@ -0,0 +1,199 @@ +[@slack/bolt](../index.md) / HTTPReceiver + +# Class: HTTPReceiver + +Defined in: [src/receivers/HTTPReceiver.ts:128](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L128) + +Receives HTTP requests with Events, Slash Commands, and Actions + +## Implements + +- [`Receiver`](../interfaces/Receiver.md) + +## Constructors + +### Constructor + +```ts +new HTTPReceiver(__namedParameters): HTTPReceiver; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L173) + +#### Parameters + +##### \_\_namedParameters + +[`HTTPReceiverOptions`](../interfaces/HTTPReceiverOptions.md) + +#### Returns + +`HTTPReceiver` + +## Properties + +### installer? + +```ts +optional installer?: InstallProvider; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:147](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L147) + +*** + +### requestListener + +```ts +requestListener: RequestListener; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:143](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L143) + +## Methods + +### init() + +```ts +init(app): void; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:264](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L264) + +#### Parameters + +##### app + +[`App`](App.md) + +#### Returns + +`void` + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`init`](../interfaces/Receiver.md#init) + +*** + +### start() + +#### Call Signature + +```ts +start(port): Promise>; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:268](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L268) + +##### Parameters + +###### port + +`number` + +##### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +##### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`start`](../interfaces/Receiver.md#start) + +#### Call Signature + +```ts +start(port): Promise>; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:269](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L269) + +##### Parameters + +###### port + +`string` + +##### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +##### Implementation of + +```ts +Receiver.start +``` + +#### Call Signature + +```ts +start(portOrListenOptions, serverOptions?): Promise>; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:270](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L270) + +##### Parameters + +###### portOrListenOptions + +`string` \| `number` \| `ListenOptions` + +###### serverOptions? + +`ServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\> + +##### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +##### Implementation of + +```ts +Receiver.start +``` + +#### Call Signature + +```ts +start(portOrListenOptions, httpsServerOptions?): Promise>; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:271](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L271) + +##### Parameters + +###### portOrListenOptions + +`string` \| `number` \| `ListenOptions` + +###### httpsServerOptions? + +`ServerOptions` + +##### Returns + +`Promise`\<`Server`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`\>\> + +##### Implementation of + +```ts +Receiver.start +``` + +*** + +### stop() + +```ts +stop(): Promise; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:359](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L359) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`stop`](../interfaces/Receiver.md#stop) diff --git a/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md new file mode 100644 index 000000000..f56cfce23 --- /dev/null +++ b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md @@ -0,0 +1,96 @@ +[@slack/bolt](../index.md) / HTTPReceiverDeferredRequestError + +# Class: HTTPReceiverDeferredRequestError + +Defined in: [src/errors.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L131) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new HTTPReceiverDeferredRequestError( + message, + req, + res +): HTTPReceiverDeferredRequestError; +``` + +Defined in: [src/errors.ts:138](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L138) + +#### Parameters + +##### message + +`string` + +##### req + + \| `IncomingMessage` + \| [`BufferedIncomingMessage`](../interfaces/BufferedIncomingMessage.md) + +##### res + +`ServerResponse` + +#### Returns + +`HTTPReceiverDeferredRequestError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.HTTPReceiverDeferredRequestError; +``` + +Defined in: [src/errors.ts:132](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L132) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +*** + +### req + +```ts +req: + | IncomingMessage + | BufferedIncomingMessage; +``` + +Defined in: [src/errors.ts:134](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L134) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`req`](../interfaces/CodedError.md#req) + +*** + +### res + +```ts +res: ServerResponse; +``` + +Defined in: [src/errors.ts:136](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L136) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`res`](../interfaces/CodedError.md#res) diff --git a/docs/english/reference/classes/HTTPResponseAck.md b/docs/english/reference/classes/HTTPResponseAck.md new file mode 100644 index 000000000..9c707ffa0 --- /dev/null +++ b/docs/english/reference/classes/HTTPResponseAck.md @@ -0,0 +1,71 @@ +[@slack/bolt](../index.md) / HTTPResponseAck + +# Class: HTTPResponseAck + +Defined in: [src/receivers/HTTPResponseAck.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPResponseAck.ts#L21) + +## Implements + +- [`ResponseAck`](../interfaces/ResponseAck.md) + +## Constructors + +### Constructor + +```ts +new HTTPResponseAck(args): HTTPResponseAck; +``` + +Defined in: [src/receivers/HTTPResponseAck.ts:45](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPResponseAck.ts#L45) + +#### Parameters + +##### args + +`AckArgs` + +#### Returns + +`HTTPResponseAck` + +## Properties + +### storedResponse + +```ts +storedResponse: any; +``` + +Defined in: [src/receivers/HTTPResponseAck.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPResponseAck.ts#L43) + +## Methods + +### ack() + +```ts +ack(): void; +``` + +Defined in: [src/receivers/HTTPResponseAck.ts:119](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPResponseAck.ts#L119) + +#### Returns + +`void` + +*** + +### bind() + +```ts +bind(): AckFn; +``` + +Defined in: [src/receivers/HTTPResponseAck.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPResponseAck.ts#L96) + +#### Returns + +[`AckFn`](../type-aliases/AckFn.md)\<`any`\> + +#### Implementation of + +[`ResponseAck`](../interfaces/ResponseAck.md).[`bind`](../interfaces/ResponseAck.md#bind) diff --git a/docs/english/reference/classes/InvalidCustomPropertyError.md b/docs/english/reference/classes/InvalidCustomPropertyError.md new file mode 100644 index 000000000..963cb05e4 --- /dev/null +++ b/docs/english/reference/classes/InvalidCustomPropertyError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / InvalidCustomPropertyError + +# Class: InvalidCustomPropertyError + +Defined in: [src/errors.ts:107](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L107) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new InvalidCustomPropertyError(message?): InvalidCustomPropertyError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`InvalidCustomPropertyError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new InvalidCustomPropertyError(message?, options?): InvalidCustomPropertyError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`InvalidCustomPropertyError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.InvalidCustomPropertyError; +``` + +Defined in: [src/errors.ts:108](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L108) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/MemoryStore.md b/docs/english/reference/classes/MemoryStore.md new file mode 100644 index 000000000..386401252 --- /dev/null +++ b/docs/english/reference/classes/MemoryStore.md @@ -0,0 +1,92 @@ +[@slack/bolt](../index.md) / MemoryStore + +# Class: MemoryStore\ + +Defined in: [src/conversation-store.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L21) + +Default implementation of ConversationStore, which stores data in memory. + +This should not be used in situations where there is more than once instance of the app running because state will +not be shared amongst the processes. + +## Type Parameters + +### ConversationState + +`ConversationState` = `any` + +## Implements + +- [`ConversationStore`](../interfaces/ConversationStore.md)\<`ConversationState`\> + +## Constructors + +### Constructor + +```ts +new MemoryStore(): MemoryStore; +``` + +#### Returns + +`MemoryStore`\<`ConversationState`\> + +## Methods + +### get() + +```ts +get(conversationId): Promise; +``` + +Defined in: [src/conversation-store.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L31) + +#### Parameters + +##### conversationId + +`string` + +#### Returns + +`Promise`\<`ConversationState`\> + +#### Implementation of + +[`ConversationStore`](../interfaces/ConversationStore.md).[`get`](../interfaces/ConversationStore.md#get) + +*** + +### set() + +```ts +set( + conversationId, + value, + expiresAt? +): Promise; +``` + +Defined in: [src/conversation-store.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L24) + +#### Parameters + +##### conversationId + +`string` + +##### value + +`ConversationState` + +##### expiresAt? + +`number` + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`ConversationStore`](../interfaces/ConversationStore.md).[`set`](../interfaces/ConversationStore.md#set) diff --git a/docs/english/reference/classes/MultipleListenerError.md b/docs/english/reference/classes/MultipleListenerError.md new file mode 100644 index 000000000..5fa6ca1d3 --- /dev/null +++ b/docs/english/reference/classes/MultipleListenerError.md @@ -0,0 +1,67 @@ +[@slack/bolt](../index.md) / MultipleListenerError + +# Class: MultipleListenerError + +Defined in: [src/errors.ts:156](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L156) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new MultipleListenerError(originals): MultipleListenerError; +``` + +Defined in: [src/errors.ts:161](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L161) + +#### Parameters + +##### originals + +`Error`[] + +#### Returns + +`MultipleListenerError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.MultipleListenerError; +``` + +Defined in: [src/errors.ts:157](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L157) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +*** + +### originals + +```ts +originals: Error[]; +``` + +Defined in: [src/errors.ts:159](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L159) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`originals`](../interfaces/CodedError.md#originals) diff --git a/docs/english/reference/classes/ReceiverAuthenticityError.md b/docs/english/reference/classes/ReceiverAuthenticityError.md new file mode 100644 index 000000000..23b38c4a3 --- /dev/null +++ b/docs/english/reference/classes/ReceiverAuthenticityError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / ReceiverAuthenticityError + +# Class: ReceiverAuthenticityError + +Defined in: [src/errors.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L123) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new ReceiverAuthenticityError(message?): ReceiverAuthenticityError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`ReceiverAuthenticityError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new ReceiverAuthenticityError(message?, options?): ReceiverAuthenticityError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`ReceiverAuthenticityError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.ReceiverAuthenticityError; +``` + +Defined in: [src/errors.ts:124](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L124) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/ReceiverInconsistentStateError.md b/docs/english/reference/classes/ReceiverInconsistentStateError.md new file mode 100644 index 000000000..785c7088b --- /dev/null +++ b/docs/english/reference/classes/ReceiverInconsistentStateError.md @@ -0,0 +1,81 @@ +[@slack/bolt](../index.md) / ReceiverInconsistentStateError + +# Class: ReceiverInconsistentStateError + +Defined in: [src/errors.ts:127](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L127) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new ReceiverInconsistentStateError(message?): ReceiverInconsistentStateError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +#### Returns + +`ReceiverInconsistentStateError` + +#### Inherited from + +```ts +Error.constructor +``` + +### Constructor + +```ts +new ReceiverInconsistentStateError(message?, options?): ReceiverInconsistentStateError; +``` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1081 + +#### Parameters + +##### message? + +`string` + +##### options? + +`ErrorOptions` + +#### Returns + +`ReceiverInconsistentStateError` + +#### Inherited from + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.ReceiverInconsistentStateError; +``` + +Defined in: [src/errors.ts:128](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L128) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/ReceiverMultipleAckError.md b/docs/english/reference/classes/ReceiverMultipleAckError.md new file mode 100644 index 000000000..9416f38dd --- /dev/null +++ b/docs/english/reference/classes/ReceiverMultipleAckError.md @@ -0,0 +1,47 @@ +[@slack/bolt](../index.md) / ReceiverMultipleAckError + +# Class: ReceiverMultipleAckError + +Defined in: [src/errors.ts:115](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L115) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new ReceiverMultipleAckError(): ReceiverMultipleAckError; +``` + +Defined in: [src/errors.ts:118](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L118) + +#### Returns + +`ReceiverMultipleAckError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.ReceiverMultipleAckError; +``` + +Defined in: [src/errors.ts:116](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L116) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) diff --git a/docs/english/reference/classes/RespondError.md b/docs/english/reference/classes/RespondError.md new file mode 100644 index 000000000..a812d99de --- /dev/null +++ b/docs/english/reference/classes/RespondError.md @@ -0,0 +1,67 @@ +[@slack/bolt](../index.md) / RespondError + +# Class: RespondError + +Defined in: [src/errors.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L145) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new RespondError(message, statusCode): RespondError; +``` + +Defined in: [src/errors.ts:150](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L150) + +#### Parameters + +##### message + +`string` + +##### statusCode + +`number` + +#### Returns + +`RespondError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.RespondError; +``` + +Defined in: [src/errors.ts:146](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L146) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +*** + +### statusCode + +```ts +statusCode: number; +``` + +Defined in: [src/errors.ts:148](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L148) diff --git a/docs/english/reference/classes/SocketModeReceiver.md b/docs/english/reference/classes/SocketModeReceiver.md new file mode 100644 index 000000000..603d25e6d --- /dev/null +++ b/docs/english/reference/classes/SocketModeReceiver.md @@ -0,0 +1,111 @@ +[@slack/bolt](../index.md) / SocketModeReceiver + +# Class: SocketModeReceiver + +Defined in: [src/receivers/SocketModeReceiver.ts:83](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L83) + +Receives Events, Slash Commands, and Actions of a web socket connection + +## Implements + +- [`Receiver`](../interfaces/Receiver.md) + +## Constructors + +### Constructor + +```ts +new SocketModeReceiver(__namedParameters): SocketModeReceiver; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:101](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L101) + +#### Parameters + +##### \_\_namedParameters + +[`SocketModeReceiverOptions`](../interfaces/SocketModeReceiverOptions.md) + +#### Returns + +`SocketModeReceiver` + +## Properties + +### client + +```ts +client: SocketModeClient; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:85](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L85) + +*** + +### installer + +```ts +installer: InstallProvider | undefined = undefined; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:91](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L91) + +## Methods + +### init() + +```ts +init(app): void; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:268](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L268) + +#### Parameters + +##### app + +[`App`](App.md) + +#### Returns + +`void` + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`init`](../interfaces/Receiver.md#init) + +*** + +### start() + +```ts +start(): Promise; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:272](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L272) + +#### Returns + +`Promise`\<`AppsConnectionsOpenResponse`\> + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`start`](../interfaces/Receiver.md#start) + +*** + +### stop() + +```ts +stop(): Promise; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:281](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L281) + +#### Returns + +`Promise`\<`void`\> + +#### Implementation of + +[`Receiver`](../interfaces/Receiver.md).[`stop`](../interfaces/Receiver.md#stop) diff --git a/docs/english/reference/classes/UnknownError.md b/docs/english/reference/classes/UnknownError.md new file mode 100644 index 000000000..ea3017df9 --- /dev/null +++ b/docs/english/reference/classes/UnknownError.md @@ -0,0 +1,67 @@ +[@slack/bolt](../index.md) / UnknownError + +# Class: UnknownError + +Defined in: [src/errors.ts:52](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L52) + +## Extends + +- `Error` + +## Implements + +- [`CodedError`](../interfaces/CodedError.md) + +## Constructors + +### Constructor + +```ts +new UnknownError(original): UnknownError; +``` + +Defined in: [src/errors.ts:57](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L57) + +#### Parameters + +##### original + +`Error` + +#### Returns + +`UnknownError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### code + +```ts +code: ErrorCode = ErrorCode.UnknownError; +``` + +Defined in: [src/errors.ts:53](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L53) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`code`](../interfaces/CodedError.md#code) + +*** + +### original + +```ts +original: Error; +``` + +Defined in: [src/errors.ts:55](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L55) + +#### Implementation of + +[`CodedError`](../interfaces/CodedError.md).[`original`](../interfaces/CodedError.md#original) diff --git a/docs/english/reference/enumerations/ErrorCode.md b/docs/english/reference/enumerations/ErrorCode.md new file mode 100644 index 000000000..f54da7149 --- /dev/null +++ b/docs/english/reference/enumerations/ErrorCode.md @@ -0,0 +1,178 @@ +[@slack/bolt](../index.md) / ErrorCode + +# Enumeration: ErrorCode + +Defined in: [src/errors.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L18) + +## Enumeration Members + +### AppInitializationError + +```ts +AppInitializationError: "slack_bolt_app_initialization_error"; +``` + +Defined in: [src/errors.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L19) + +*** + +### AssistantInitializationError + +```ts +AssistantInitializationError: "slack_bolt_assistant_initialization_error"; +``` + +Defined in: [src/errors.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L21) + +*** + +### AssistantMissingPropertyError + +```ts +AssistantMissingPropertyError: "slack_bolt_assistant_missing_property_error"; +``` + +Defined in: [src/errors.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L22) + +*** + +### AuthorizationError + +```ts +AuthorizationError: "slack_bolt_authorization_error"; +``` + +Defined in: [src/errors.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L24) + +*** + +### ContextMissingPropertyError + +```ts +ContextMissingPropertyError: "slack_bolt_context_missing_property_error"; +``` + +Defined in: [src/errors.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L26) + +*** + +### CustomFunctionCompleteFailError + +```ts +CustomFunctionCompleteFailError: "slack_bolt_custom_function_complete_fail_error"; +``` + +Defined in: [src/errors.ts:49](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L49) + +*** + +### CustomFunctionCompleteSuccessError + +```ts +CustomFunctionCompleteSuccessError: "slack_bolt_custom_function_complete_success_error"; +``` + +Defined in: [src/errors.ts:48](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L48) + +*** + +### CustomFunctionInitializationError + +```ts +CustomFunctionInitializationError: "slack_bolt_custom_function_initialization_error"; +``` + +Defined in: [src/errors.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L47) + +*** + +### CustomRouteInitializationError + +```ts +CustomRouteInitializationError: "slack_bolt_custom_route_initialization_error"; +``` + +Defined in: [src/errors.ts:29](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L29) + +*** + +### HTTPReceiverDeferredRequestError + +```ts +HTTPReceiverDeferredRequestError: "slack_bolt_http_receiver_deferred_request_error"; +``` + +Defined in: [src/errors.ts:37](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L37) + +*** + +### InvalidCustomPropertyError + +```ts +InvalidCustomPropertyError: "slack_bolt_context_invalid_custom_property_error"; +``` + +Defined in: [src/errors.ts:27](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L27) + +*** + +### MultipleListenerError + +```ts +MultipleListenerError: "slack_bolt_multiple_listener_error"; +``` + +Defined in: [src/errors.ts:35](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L35) + +*** + +### ReceiverAuthenticityError + +```ts +ReceiverAuthenticityError: "slack_bolt_receiver_authenticity_error"; +``` + +Defined in: [src/errors.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L32) + +*** + +### ReceiverInconsistentStateError + +```ts +ReceiverInconsistentStateError: "slack_bolt_receiver_inconsistent_state_error"; +``` + +Defined in: [src/errors.ts:33](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L33) + +*** + +### ReceiverMultipleAckError + +```ts +ReceiverMultipleAckError: "slack_bolt_receiver_ack_multiple_error"; +``` + +Defined in: [src/errors.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L31) + +*** + +### RespondError + +```ts +RespondError: "slack_bolt_respond_error"; +``` + +Defined in: [src/errors.ts:39](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L39) + +*** + +### UnknownError + +```ts +UnknownError: "slack_bolt_unknown_error"; +``` + +Defined in: [src/errors.ts:45](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L45) + +This value is used to assign to errors that occur inside the framework but do not have a code, to keep interfaces +in terms of CodedError. diff --git a/docs/english/reference/functions/asCodedError.md b/docs/english/reference/functions/asCodedError.md new file mode 100644 index 000000000..a2092b6da --- /dev/null +++ b/docs/english/reference/functions/asCodedError.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / asCodedError + +# Function: asCodedError() + +```ts +function asCodedError(error): CodedError; +``` + +Defined in: [src/errors.ts:64](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L64) + +## Parameters + +### error + +[`CodedError`](../interfaces/CodedError.md) \| `Error` + +## Returns + +[`CodedError`](../interfaces/CodedError.md) diff --git a/docs/english/reference/functions/buildReceiverRoutes.md b/docs/english/reference/functions/buildReceiverRoutes.md new file mode 100644 index 000000000..d1ab604f4 --- /dev/null +++ b/docs/english/reference/functions/buildReceiverRoutes.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / buildReceiverRoutes + +# Function: buildReceiverRoutes() + +```ts +function buildReceiverRoutes(customRoutes): ReceiverRoutes; +``` + +Defined in: [src/receivers/custom-routes.ts:17](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L17) + +## Parameters + +### customRoutes + +[`CustomRoute`](../interfaces/CustomRoute.md)[] + +## Returns + +[`ReceiverRoutes`](../interfaces/ReceiverRoutes.md) diff --git a/docs/english/reference/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/functions/defaultProcessEventErrorHandler.md new file mode 100644 index 000000000..7c74f95a0 --- /dev/null +++ b/docs/english/reference/functions/defaultProcessEventErrorHandler.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / defaultProcessEventErrorHandler + +# Function: defaultProcessEventErrorHandler() + +```ts +function defaultProcessEventErrorHandler(args): Promise; +``` + +Defined in: [src/receivers/SocketModeFunctions.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeFunctions.ts#L5) + +## Parameters + +### args + +[`SocketModeReceiverProcessEventErrorHandlerArgs`](../interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md) + +## Returns + +`Promise`\<`boolean`\> diff --git a/docs/english/reference/functions/isCodedError.md b/docs/english/reference/functions/isCodedError.md new file mode 100644 index 000000000..b082a9bb8 --- /dev/null +++ b/docs/english/reference/functions/isCodedError.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / isCodedError + +# Function: isCodedError() + +```ts +function isCodedError(err): err is CodedError; +``` + +Defined in: [src/errors.ts:14](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L14) + +## Parameters + +### err + +`any` + +## Returns + +`err is CodedError` diff --git a/docs/english/reference/functions/isFulfilled.md b/docs/english/reference/functions/isFulfilled.md new file mode 100644 index 000000000..17fb0364e --- /dev/null +++ b/docs/english/reference/functions/isFulfilled.md @@ -0,0 +1,27 @@ +[@slack/bolt](../index.md) / isFulfilled + +# Function: isFulfilled() + +```ts +function isFulfilled(p): p is PromiseFulfilledResult; +``` + +Defined in: [src/types/utilities.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L18) + +Type predicate for use with `Promise.allSettled` for filtering for resolved results. + +## Type Parameters + +### T + +`T` + +## Parameters + +### p + +`PromiseSettledResult`\<`T`\> + +## Returns + +`p is PromiseFulfilledResult` diff --git a/docs/english/reference/functions/isRejected.md b/docs/english/reference/functions/isRejected.md new file mode 100644 index 000000000..a1ef1b2dd --- /dev/null +++ b/docs/english/reference/functions/isRejected.md @@ -0,0 +1,27 @@ +[@slack/bolt](../index.md) / isRejected + +# Function: isRejected() + +```ts +function isRejected(p): p is PromiseRejectedResult; +``` + +Defined in: [src/types/utilities.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L20) + +Type predicate for use with `Promise.allSettled` for filtering for rejected results. + +## Type Parameters + +### T + +`T` + +## Parameters + +### p + +`PromiseSettledResult`\<`T`\> + +## Returns + +`p is PromiseRejectedResult` diff --git a/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md new file mode 100644 index 000000000..b9b048c12 --- /dev/null +++ b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md @@ -0,0 +1,26 @@ +[@slack/bolt](../index.md) / isSlackEventMiddlewareArgsOptions + +# Function: isSlackEventMiddlewareArgsOptions() + +```ts +function isSlackEventMiddlewareArgsOptions(optionOrListener): optionOrListener is SlackEventMiddlewareArgsOptions; +``` + +Defined in: [src/middleware/builtin.ts:67](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L67) + +## Type Parameters + +### EventType + +`EventType` *extends* `string` = `string` + +## Parameters + +### optionOrListener + + \| [`SlackEventMiddlewareArgsOptions`](../type-aliases/SlackEventMiddlewareArgsOptions.md) + \| [`Middleware`](../type-aliases/Middleware.md)\<[`SlackEventMiddlewareArgs`](../type-aliases/SlackEventMiddlewareArgs.md)\<`EventType`\>\> + +## Returns + +`optionOrListener is SlackEventMiddlewareArgsOptions` diff --git a/docs/english/reference/functions/isValidSlackRequest.md b/docs/english/reference/functions/isValidSlackRequest.md new file mode 100644 index 000000000..9db2b7f49 --- /dev/null +++ b/docs/english/reference/functions/isValidSlackRequest.md @@ -0,0 +1,22 @@ +[@slack/bolt](../index.md) / isValidSlackRequest + +# Function: isValidSlackRequest() + +```ts +function isValidSlackRequest(options): boolean; +``` + +Defined in: [src/receivers/verify-request.ts:75](https://github.com/slackapi/bolt-js/blob/main/src/receivers/verify-request.ts#L75) + +Verifies the signature of an incoming request from Slack. +If the request is invalid, this method returns false. + +## Parameters + +### options + +`SlackRequestVerificationOptions` + +## Returns + +`boolean` diff --git a/docs/english/reference/functions/matchCommandName.md b/docs/english/reference/functions/matchCommandName.md new file mode 100644 index 000000000..56f36d9cf --- /dev/null +++ b/docs/english/reference/functions/matchCommandName.md @@ -0,0 +1,21 @@ +[@slack/bolt](../index.md) / matchCommandName + +# Function: matchCommandName() + +```ts +function matchCommandName(pattern): Middleware; +``` + +Defined in: [src/middleware/builtin.ts:262](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L262) + +Middleware that filters out any command that doesn't match the pattern + +## Parameters + +### pattern + +`string` \| `RegExp` + +## Returns + +[`Middleware`](../type-aliases/Middleware.md)\<[`SlackCommandMiddlewareArgs`](../interfaces/SlackCommandMiddlewareArgs.md)\> diff --git a/docs/english/reference/functions/matchConstraints.md b/docs/english/reference/functions/matchConstraints.md new file mode 100644 index 000000000..40ce4a416 --- /dev/null +++ b/docs/english/reference/functions/matchConstraints.md @@ -0,0 +1,60 @@ +[@slack/bolt](../index.md) / matchConstraints + +# Function: matchConstraints() + +```ts +function matchConstraints(constraints): Middleware< + | { + ack: | AckFn + | AckFn + | AckFn; + action: | DialogSubmitAction + | BlockElementAction + | InteractiveAction; + body: SlackAction; + complete?: FunctionCompleteFn; + fail?: FunctionFailFn; + inputs?: FunctionInputs; + payload: | DialogSubmitAction + | BlockElementAction + | InteractiveAction; + respond: RespondFn; +} + | SlackOptionsMiddlewareArgs<"interactive_message" | "block_suggestion" | "dialog_suggestion"> +| SlackViewMiddlewareArgs>; +``` + +Defined in: [src/middleware/builtin.ts:142](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L142) + +Middleware that checks for matches given constraints + +## Parameters + +### constraints + + \| [`ActionConstraints`](../interfaces/ActionConstraints.md)\<[`SlackAction`](../type-aliases/SlackAction.md)\> + \| [`ViewConstraints`](../interfaces/ViewConstraints.md) + \| [`ShortcutConstraints`](../interfaces/ShortcutConstraints.md)\<[`SlackShortcut`](../type-aliases/SlackShortcut.md)\> + \| [`OptionsConstraints`](../interfaces/OptionsConstraints.md)\<[`SlackOptions`](../type-aliases/SlackOptions.md)\> + +## Returns + +[`Middleware`](../type-aliases/Middleware.md)\< + \| \{ + `ack`: \| [`AckFn`](../type-aliases/AckFn.md)\<`void`\> + \| [`AckFn`](../type-aliases/AckFn.md)\<`string` \| [`SayArguments`](../type-aliases/SayArguments.md)\> + \| [`AckFn`](../type-aliases/AckFn.md)\<[`DialogValidation`](../interfaces/DialogValidation.md)\>; + `action`: \| [`DialogSubmitAction`](../interfaces/DialogSubmitAction.md) + \| [`BlockElementAction`](../type-aliases/BlockElementAction.md) + \| [`InteractiveAction`](../type-aliases/InteractiveAction.md); + `body`: [`SlackAction`](../type-aliases/SlackAction.md); + `complete?`: `FunctionCompleteFn`; + `fail?`: `FunctionFailFn`; + `inputs?`: [`FunctionInputs`](../type-aliases/FunctionInputs.md); + `payload`: \| [`DialogSubmitAction`](../interfaces/DialogSubmitAction.md) + \| [`BlockElementAction`](../type-aliases/BlockElementAction.md) + \| [`InteractiveAction`](../type-aliases/InteractiveAction.md); + `respond`: [`RespondFn`](../type-aliases/RespondFn.md); +\} + \| [`SlackOptionsMiddlewareArgs`](../interfaces/SlackOptionsMiddlewareArgs.md)\<`"interactive_message"` \| `"block_suggestion"` \| `"dialog_suggestion"`\> + \| [`SlackViewMiddlewareArgs`](../interfaces/SlackViewMiddlewareArgs.md)\<[`SlackViewAction`](../type-aliases/SlackViewAction.md)\>\> diff --git a/docs/english/reference/functions/matchEventType.md b/docs/english/reference/functions/matchEventType.md new file mode 100644 index 000000000..3414905f5 --- /dev/null +++ b/docs/english/reference/functions/matchEventType.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / matchEventType + +# Function: matchEventType() + +```ts +function matchEventType(pattern): Middleware; +``` + +Defined in: [src/middleware/builtin.ts:283](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L283) + +## Parameters + +### pattern + +[`EventTypePattern`](../type-aliases/EventTypePattern.md) + +## Returns + +[`Middleware`](../type-aliases/Middleware.md)\<[`SlackEventMiddlewareArgs`](../type-aliases/SlackEventMiddlewareArgs.md)\> diff --git a/docs/english/reference/functions/matchMessage.md b/docs/english/reference/functions/matchMessage.md new file mode 100644 index 000000000..8c959445c --- /dev/null +++ b/docs/english/reference/functions/matchMessage.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / matchMessage + +# Function: matchMessage() + +```ts +function matchMessage(pattern): Middleware>; +``` + +Defined in: [src/middleware/builtin.ts:230](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L230) + +## Parameters + +### pattern + +`string` \| `RegExp` + +## Returns + +[`Middleware`](../type-aliases/Middleware.md)\<[`SlackEventMiddlewareArgs`](../type-aliases/SlackEventMiddlewareArgs.md)\<`"message"` \| `"app_mention"`\>\> diff --git a/docs/english/reference/functions/subtype.md b/docs/english/reference/functions/subtype.md new file mode 100644 index 000000000..964b2c40f --- /dev/null +++ b/docs/english/reference/functions/subtype.md @@ -0,0 +1,21 @@ +[@slack/bolt](../index.md) / subtype + +# Function: subtype() + +```ts +function subtype(subtype1): Middleware>; +``` + +Defined in: [src/middleware/builtin.ts:346](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L346) + +Filters out any message events whose subtype does not match the provided subtype. + +## Parameters + +### subtype1 + +`string` + +## Returns + +[`Middleware`](../type-aliases/Middleware.md)\<[`SlackEventMiddlewareArgs`](../type-aliases/SlackEventMiddlewareArgs.md)\<`"message"`\>\> diff --git a/docs/english/reference/functions/verifySlackRequest.md b/docs/english/reference/functions/verifySlackRequest.md new file mode 100644 index 000000000..d2f8c172f --- /dev/null +++ b/docs/english/reference/functions/verifySlackRequest.md @@ -0,0 +1,22 @@ +[@slack/bolt](../index.md) / verifySlackRequest + +# Function: verifySlackRequest() + +```ts +function verifySlackRequest(options): void; +``` + +Defined in: [src/receivers/verify-request.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/receivers/verify-request.ts#L26) + +Verifies the signature of an incoming request from Slack. +If the request is invalid, this method throws an exception with the error details. + +## Parameters + +### options + +`SlackRequestVerificationOptions` + +## Returns + +`void` diff --git a/docs/english/reference/index.md b/docs/english/reference/index.md new file mode 100644 index 000000000..5a293b146 --- /dev/null +++ b/docs/english/reference/index.md @@ -0,0 +1,233 @@ +# @slack/bolt v5.0.0 + +## Namespaces + +- [HTTPModuleFunctions](bolt/namespaces/HTTPModuleFunctions/index.md) + +## Enumerations + +- [ErrorCode](enumerations/ErrorCode.md) + +## Classes + +- [App](classes/App.md) +- [AppInitializationError](classes/AppInitializationError.md) +- [Assistant](classes/Assistant.md) +- [AssistantInitializationError](classes/AssistantInitializationError.md) +- [AssistantMissingPropertyError](classes/AssistantMissingPropertyError.md) +- [AuthorizationError](classes/AuthorizationError.md) +- [AwsLambdaReceiver](classes/AwsLambdaReceiver.md) +- [ContextMissingPropertyError](classes/ContextMissingPropertyError.md) +- [CustomFunctionCompleteFailError](classes/CustomFunctionCompleteFailError.md) +- [CustomFunctionCompleteSuccessError](classes/CustomFunctionCompleteSuccessError.md) +- [CustomFunctionInitializationError](classes/CustomFunctionInitializationError.md) +- [CustomRouteInitializationError](classes/CustomRouteInitializationError.md) +- [ExpressReceiver](classes/ExpressReceiver.md) +- [HTTPReceiver](classes/HTTPReceiver.md) +- [HTTPReceiverDeferredRequestError](classes/HTTPReceiverDeferredRequestError.md) +- [HTTPResponseAck](classes/HTTPResponseAck.md) +- [InvalidCustomPropertyError](classes/InvalidCustomPropertyError.md) +- [MemoryStore](classes/MemoryStore.md) +- [MultipleListenerError](classes/MultipleListenerError.md) +- [ReceiverAuthenticityError](classes/ReceiverAuthenticityError.md) +- [ReceiverInconsistentStateError](classes/ReceiverInconsistentStateError.md) +- [ReceiverMultipleAckError](classes/ReceiverMultipleAckError.md) +- [RespondError](classes/RespondError.md) +- [SocketModeReceiver](classes/SocketModeReceiver.md) +- [UnknownError](classes/UnknownError.md) + +## Interfaces + +- [ActionConstraints](interfaces/ActionConstraints.md) +- [AllMiddlewareArgs](interfaces/AllMiddlewareArgs.md) +- [AppOptions](interfaces/AppOptions.md) +- [AssistantConfig](interfaces/AssistantConfig.md) +- [AuthorizeResult](interfaces/AuthorizeResult.md) +- [AuthorizeSourceData](interfaces/AuthorizeSourceData.md) +- [AwsLambdaReceiverOptions](interfaces/AwsLambdaReceiverOptions.md) +- [BaseSlackEvent](interfaces/BaseSlackEvent.md) +- [BasicElementAction](interfaces/BasicElementAction.md) +- [BasicOptionsPayload](interfaces/BasicOptionsPayload.md) +- [BlockAction](interfaces/BlockAction.md) +- [BlockOptions](interfaces/BlockOptions.md) +- [BlockSuggestion](interfaces/BlockSuggestion.md) +- [BufferedIncomingMessage](interfaces/BufferedIncomingMessage.md) +- [ButtonAction](interfaces/ButtonAction.md) +- [ButtonClick](interfaces/ButtonClick.md) +- [ChannelsSelectAction](interfaces/ChannelsSelectAction.md) +- [CheckboxesAction](interfaces/CheckboxesAction.md) +- [CodedError](interfaces/CodedError.md) +- [Context](interfaces/Context.md) +- [ConversationsSelectAction](interfaces/ConversationsSelectAction.md) +- [ConversationStore](interfaces/ConversationStore.md) +- [CustomRoute](interfaces/CustomRoute.md) +- [DatepickerAction](interfaces/DatepickerAction.md) +- [DialogOptionGroups](interfaces/DialogOptionGroups.md) +- [DialogOptions](interfaces/DialogOptions.md) +- [DialogSubmitAction](interfaces/DialogSubmitAction.md) +- [DialogSuggestion](interfaces/DialogSuggestion.md) +- [DialogValidation](interfaces/DialogValidation.md) +- [EnvelopedEvent](interfaces/EnvelopedEvent.md) +- [ExpressReceiverOptions](interfaces/ExpressReceiverOptions.md) +- [ExternalSelectAction](interfaces/ExternalSelectAction.md) +- [FeedbackButtonsAction](interfaces/FeedbackButtonsAction.md) +- [GlobalShortcut](interfaces/GlobalShortcut.md) +- [HTTPReceiverOptions](interfaces/HTTPReceiverOptions.md) +- [IconButtonAction](interfaces/IconButtonAction.md) +- [InteractiveMessage](interfaces/InteractiveMessage.md) +- [InteractiveMessageSuggestion](interfaces/InteractiveMessageSuggestion.md) +- [MenuSelect](interfaces/MenuSelect.md) +- [MessageOptions](interfaces/MessageOptions.md) +- [MessageShortcut](interfaces/MessageShortcut.md) +- [MultiChannelsSelectAction](interfaces/MultiChannelsSelectAction.md) +- [MultiConversationsSelectAction](interfaces/MultiConversationsSelectAction.md) +- [MultiExternalSelectAction](interfaces/MultiExternalSelectAction.md) +- [MultiStaticSelectAction](interfaces/MultiStaticSelectAction.md) +- [MultiUsersSelectAction](interfaces/MultiUsersSelectAction.md) +- [OptionGroups](interfaces/OptionGroups.md) +- [OptionsConstraints](interfaces/OptionsConstraints.md) +- [OverflowAction](interfaces/OverflowAction.md) +- [PlainTextInputAction](interfaces/PlainTextInputAction.md) +- [RadioButtonsAction](interfaces/RadioButtonsAction.md) +- [Receiver](interfaces/Receiver.md) +- [ReceiverEvent](interfaces/ReceiverEvent.md) +- [ReceiverRoutes](interfaces/ReceiverRoutes.md) +- [ResponseAck](interfaces/ResponseAck.md) +- [RichTextInputAction](interfaces/RichTextInputAction.md) +- [ShortcutConstraints](interfaces/ShortcutConstraints.md) +- [SlackCommandMiddlewareArgs](interfaces/SlackCommandMiddlewareArgs.md) +- [SlackOptionsMiddlewareArgs](interfaces/SlackOptionsMiddlewareArgs.md) +- [SlackViewMiddlewareArgs](interfaces/SlackViewMiddlewareArgs.md) +- [SlashCommand](interfaces/SlashCommand.md) +- [SocketModeReceiverOptions](interfaces/SocketModeReceiverOptions.md) +- [SocketModeReceiverProcessEventErrorHandlerArgs](interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md) +- [StaticSelectAction](interfaces/StaticSelectAction.md) +- [TimepickerAction](interfaces/TimepickerAction.md) +- [UploadedFile](interfaces/UploadedFile.md) +- [UsersSelectAction](interfaces/UsersSelectAction.md) +- [ViewClearResponseAction](interfaces/ViewClearResponseAction.md) +- [ViewClosedAction](interfaces/ViewClosedAction.md) +- [ViewConstraints](interfaces/ViewConstraints.md) +- [ViewErrorsResponseAction](interfaces/ViewErrorsResponseAction.md) +- [ViewOutput](interfaces/ViewOutput.md) +- [ViewPushResponseAction](interfaces/ViewPushResponseAction.md) +- [ViewResponseUrl](interfaces/ViewResponseUrl.md) +- [ViewStateSelectedOption](interfaces/ViewStateSelectedOption.md) +- [ViewStateValue](interfaces/ViewStateValue.md) +- [ViewSubmitAction](interfaces/ViewSubmitAction.md) +- [ViewUpdateResponseAction](interfaces/ViewUpdateResponseAction.md) + +## Type Aliases + +- [AckFn](type-aliases/AckFn.md) +- [AnyMiddlewareArgs](type-aliases/AnyMiddlewareArgs.md) +- [AssistantThreadContextChangedMiddleware](type-aliases/AssistantThreadContextChangedMiddleware.md) +- [AssistantThreadStartedMiddleware](type-aliases/AssistantThreadStartedMiddleware.md) +- [AssistantUserMessageMiddleware](type-aliases/AssistantUserMessageMiddleware.md) +- [Authorize](type-aliases/Authorize.md) +- [BlockButtonAction](type-aliases/BlockButtonAction.md) +- [BlockChannelsSelectAction](type-aliases/BlockChannelsSelectAction.md) +- [BlockCheckboxesAction](type-aliases/BlockCheckboxesAction.md) +- [BlockConversationsSelectAction](type-aliases/BlockConversationsSelectAction.md) +- [BlockDatepickerAction](type-aliases/BlockDatepickerAction.md) +- [BlockElementAction](type-aliases/BlockElementAction.md) +- [BlockExternalSelectAction](type-aliases/BlockExternalSelectAction.md) +- [BlockFeedbackButtonsAction](type-aliases/BlockFeedbackButtonsAction.md) +- [BlockIconButtonAction](type-aliases/BlockIconButtonAction.md) +- [BlockOverflowAction](type-aliases/BlockOverflowAction.md) +- [BlockPlainTextInputAction](type-aliases/BlockPlainTextInputAction.md) +- [BlockRadioButtonsAction](type-aliases/BlockRadioButtonsAction.md) +- [BlockStaticSelectAction](type-aliases/BlockStaticSelectAction.md) +- [BlockTimepickerAction](type-aliases/BlockTimepickerAction.md) +- [BlockUsersSelectAction](type-aliases/BlockUsersSelectAction.md) +- [EventFromType](type-aliases/EventFromType.md) +- [EventTypePattern](type-aliases/EventTypePattern.md) +- [FunctionInputs](type-aliases/FunctionInputs.md) +- [InteractiveAction](type-aliases/InteractiveAction.md) +- [InteractiveButtonClick](type-aliases/InteractiveButtonClick.md) +- [InteractiveMenuSelect](type-aliases/InteractiveMenuSelect.md) +- [KnownEventFromType](type-aliases/KnownEventFromType.md) +- [KnownOptionsPayloadFromType](type-aliases/KnownOptionsPayloadFromType.md) +- [Middleware](type-aliases/Middleware.md) +- [NextFn](type-aliases/NextFn.md) +- [OptionsPayloadFromType](type-aliases/OptionsPayloadFromType.md) +- [OptionsSource](type-aliases/OptionsSource.md) +- [RespondArguments](type-aliases/RespondArguments.md) +- [RespondFn](type-aliases/RespondFn.md) +- [SayArguments](type-aliases/SayArguments.md) +- [SayFn](type-aliases/SayFn.md) +- [SayStreamArguments](type-aliases/SayStreamArguments.md) +- [SayStreamFn](type-aliases/SayStreamFn.md) +- [SetStatusArguments](type-aliases/SetStatusArguments.md) +- [SetStatusFn](type-aliases/SetStatusFn.md) +- [SlackAction](type-aliases/SlackAction.md) +- [SlackActionMiddlewareArgs](type-aliases/SlackActionMiddlewareArgs.md) +- [SlackEventMiddlewareArgs](type-aliases/SlackEventMiddlewareArgs.md) +- [SlackEventMiddlewareArgsOptions](type-aliases/SlackEventMiddlewareArgsOptions.md) +- [SlackOptions](type-aliases/SlackOptions.md) +- [SlackShortcut](type-aliases/SlackShortcut.md) +- [SlackShortcutMiddlewareArgs](type-aliases/SlackShortcutMiddlewareArgs.md) +- [SlackViewAction](type-aliases/SlackViewAction.md) +- [StringIndexed](type-aliases/StringIndexed.md) +- [ViewResponseAction](type-aliases/ViewResponseAction.md) +- [XOR](type-aliases/XOR.md) + +## Variables + +- [autoAcknowledge](variables/autoAcknowledge.md) +- [contextBuiltinKeys](variables/contextBuiltinKeys.md) +- [directMention](variables/directMention.md) +- [ignoreSelf](variables/ignoreSelf.md) +- [onlyActions](variables/onlyActions.md) +- [onlyCommands](variables/onlyCommands.md) +- [onlyEvents](variables/onlyEvents.md) +- [onlyOptions](variables/onlyOptions.md) +- [onlyShortcuts](variables/onlyShortcuts.md) +- [onlyViewActions](variables/onlyViewActions.md) + +## Functions + +- [asCodedError](functions/asCodedError.md) +- [buildReceiverRoutes](functions/buildReceiverRoutes.md) +- [defaultProcessEventErrorHandler](functions/defaultProcessEventErrorHandler.md) +- [isCodedError](functions/isCodedError.md) +- [isFulfilled](functions/isFulfilled.md) +- [isRejected](functions/isRejected.md) +- [isSlackEventMiddlewareArgsOptions](functions/isSlackEventMiddlewareArgsOptions.md) +- [isValidSlackRequest](functions/isValidSlackRequest.md) +- [matchCommandName](functions/matchCommandName.md) +- [matchConstraints](functions/matchConstraints.md) +- [matchEventType](functions/matchEventType.md) +- [matchMessage](functions/matchMessage.md) +- [subtype](functions/subtype.md) +- [verifySlackRequest](functions/verifySlackRequest.md) + +## References + +### default + +Renames and re-exports [App](classes/App.md) + +*** + +### ReceiverDispatchErrorHandlerArgs + +Re-exports [ReceiverDispatchErrorHandlerArgs](bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md) + +*** + +### ReceiverProcessEventErrorHandlerArgs + +Re-exports [ReceiverProcessEventErrorHandlerArgs](bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md) + +*** + +### ReceiverUnhandledRequestHandlerArgs + +Re-exports [ReceiverUnhandledRequestHandlerArgs](bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md) + +*** + +### RequestVerificationOptions + +Re-exports [RequestVerificationOptions](bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md) diff --git a/docs/english/reference/interfaces/ActionConstraints.md b/docs/english/reference/interfaces/ActionConstraints.md new file mode 100644 index 000000000..517b560f4 --- /dev/null +++ b/docs/english/reference/interfaces/ActionConstraints.md @@ -0,0 +1,53 @@ +[@slack/bolt](../index.md) / ActionConstraints + +# Interface: ActionConstraints\ + +Defined in: [src/types/actions/index.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L28) + +## Type Parameters + +### A + +`A` *extends* [`SlackAction`](../type-aliases/SlackAction.md) = [`SlackAction`](../type-aliases/SlackAction.md) + +## Properties + +### action\_id? + +```ts +optional action_id?: A extends BlockAction ? string | RegExp : never; +``` + +Defined in: [src/types/actions/index.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L31) + +*** + +### block\_id? + +```ts +optional block_id?: A extends BlockAction ? string | RegExp : never; +``` + +Defined in: [src/types/actions/index.ts:30](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L30) + +*** + +### callback\_id? + +```ts +optional callback_id?: Extract extends any ? string | RegExp : never; +``` + +Defined in: [src/types/actions/index.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L34) + +*** + +### type? + +```ts +optional type?: A["type"]; +``` + +Defined in: [src/types/actions/index.ts:29](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L29) diff --git a/docs/english/reference/interfaces/AllMiddlewareArgs.md b/docs/english/reference/interfaces/AllMiddlewareArgs.md new file mode 100644 index 000000000..183d7719e --- /dev/null +++ b/docs/english/reference/interfaces/AllMiddlewareArgs.md @@ -0,0 +1,51 @@ +[@slack/bolt](../index.md) / AllMiddlewareArgs + +# Interface: AllMiddlewareArgs\ + +Defined in: [src/types/middleware.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L20) + +## Type Parameters + +### CustomContext + +`CustomContext` = [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Properties + +### client + +```ts +client: WebClient; +``` + +Defined in: [src/types/middleware.ts:23](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L23) + +*** + +### context + +```ts +context: Context & CustomContext; +``` + +Defined in: [src/types/middleware.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L21) + +*** + +### logger + +```ts +logger: Logger; +``` + +Defined in: [src/types/middleware.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L22) + +*** + +### next + +```ts +next: NextFn; +``` + +Defined in: [src/types/middleware.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L24) diff --git a/docs/english/reference/interfaces/AppOptions.md b/docs/english/reference/interfaces/AppOptions.md new file mode 100644 index 000000000..afe01723a --- /dev/null +++ b/docs/english/reference/interfaces/AppOptions.md @@ -0,0 +1,311 @@ +[@slack/bolt](../index.md) / AppOptions + +# Interface: AppOptions + +Defined in: [src/App.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L122) + +App initialization options + +## Properties + +### appToken? + +```ts +optional appToken?: string; +``` + +Defined in: [src/App.ts:138](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L138) + +*** + +### attachFunctionToken? + +```ts +optional attachFunctionToken?: boolean; +``` + +Defined in: [src/App.ts:157](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L157) + +*** + +### authorize? + +```ts +optional authorize?: Authorize; +``` + +Defined in: [src/App.ts:141](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L141) + +*** + +### botId? + +```ts +optional botId?: string; +``` + +Defined in: [src/App.ts:139](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L139) + +*** + +### botUserId? + +```ts +optional botUserId?: string; +``` + +Defined in: [src/App.ts:140](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L140) + +*** + +### clientId? + +```ts +optional clientId?: string; +``` + +Defined in: [src/App.ts:129](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L129) + +*** + +### clientOptions? + +```ts +optional clientOptions?: WebClientOptions; +``` + +Defined in: [src/App.ts:151](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L151) + +Configurations for the web client used to send Slack API method requests. + +See [https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/WebClientOptions/](https://docs.slack.dev/tools/node-slack-sdk/reference/web-api/interfaces/WebClientOptions/) for more information. + +*** + +### clientSecret? + +```ts +optional clientSecret?: string; +``` + +Defined in: [src/App.ts:130](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L130) + +*** + +### convoStore? + +```ts +optional convoStore?: false | ConversationStore; +``` + +Defined in: [src/App.ts:136](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L136) + +*** + +### customRoutes? + +```ts +optional customRoutes?: CustomRoute[]; +``` + +Defined in: [src/App.ts:126](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L126) + +*** + +### deferInitialization? + +```ts +optional deferInitialization?: boolean; +``` + +Defined in: [src/App.ts:155](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L155) + +*** + +### developerMode? + +```ts +optional developerMode?: boolean; +``` + +Defined in: [src/App.ts:153](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L153) + +*** + +### endpoints? + +```ts +optional endpoints?: string | string[]; +``` + +Defined in: [src/App.ts:124](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L124) + +*** + +### extendedErrorHandler? + +```ts +optional extendedErrorHandler?: boolean; +``` + +Defined in: [src/App.ts:156](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L156) + +*** + +### ignoreSelf? + +```ts +optional ignoreSelf?: boolean; +``` + +Defined in: [src/App.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L145) + +*** + +### installationStore? + +```ts +optional installationStore?: InstallationStore; +``` + +Defined in: [src/App.ts:133](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L133) + +*** + +### installerOptions? + +```ts +optional installerOptions?: HTTPReceiverInstallerOptions; +``` + +Defined in: [src/App.ts:135](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L135) + +*** + +### logger? + +```ts +optional logger?: Logger; +``` + +Defined in: [src/App.ts:143](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L143) + +*** + +### logLevel? + +```ts +optional logLevel?: LogLevel; +``` + +Defined in: [src/App.ts:144](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L144) + +*** + +### port? + +```ts +optional port?: number; +``` + +Defined in: [src/App.ts:125](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L125) + +*** + +### processBeforeResponse? + +```ts +optional processBeforeResponse?: boolean; +``` + +Defined in: [src/App.ts:127](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L127) + +*** + +### receiver? + +```ts +optional receiver?: Receiver; +``` + +Defined in: [src/App.ts:142](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L142) + +*** + +### redirectUri? + +```ts +optional redirectUri?: string; +``` + +Defined in: [src/App.ts:132](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L132) + +*** + +### scopes? + +```ts +optional scopes?: string | string[]; +``` + +Defined in: [src/App.ts:134](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L134) + +*** + +### signatureVerification? + +```ts +optional signatureVerification?: boolean; +``` + +Defined in: [src/App.ts:128](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L128) + +*** + +### signingSecret? + +```ts +optional signingSecret?: string; +``` + +Defined in: [src/App.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L123) + +*** + +### socketMode? + +```ts +optional socketMode?: boolean; +``` + +Defined in: [src/App.ts:152](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L152) + +*** + +### stateSecret? + +```ts +optional stateSecret?: string; +``` + +Defined in: [src/App.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L131) + +*** + +### token? + +```ts +optional token?: string; +``` + +Defined in: [src/App.ts:137](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L137) + +*** + +### tokenVerificationEnabled? + +```ts +optional tokenVerificationEnabled?: boolean; +``` + +Defined in: [src/App.ts:154](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L154) diff --git a/docs/english/reference/interfaces/AssistantConfig.md b/docs/english/reference/interfaces/AssistantConfig.md new file mode 100644 index 000000000..030610269 --- /dev/null +++ b/docs/english/reference/interfaces/AssistantConfig.md @@ -0,0 +1,53 @@ +[@slack/bolt](../index.md) / AssistantConfig + +# Interface: AssistantConfig + +Defined in: [src/Assistant.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L21) + +Configuration object used to instantiate the Assistant + +## Properties + +### threadContextChanged? + +```ts +optional threadContextChanged?: + | AssistantThreadContextChangedMiddleware + | AssistantThreadContextChangedMiddleware[]; +``` + +Defined in: [src/Assistant.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L24) + +*** + +### threadContextStore? + +```ts +optional threadContextStore?: AssistantThreadContextStore; +``` + +Defined in: [src/Assistant.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L22) + +*** + +### threadStarted + +```ts +threadStarted: + | AssistantThreadStartedMiddleware + | AssistantThreadStartedMiddleware[]; +``` + +Defined in: [src/Assistant.ts:23](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L23) + +*** + +### userMessage + +```ts +userMessage: + | AssistantUserMessageMiddleware + | AssistantUserMessageMiddleware[]; +``` + +Defined in: [src/Assistant.ts:25](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L25) diff --git a/docs/english/reference/interfaces/AuthorizeResult.md b/docs/english/reference/interfaces/AuthorizeResult.md new file mode 100644 index 000000000..4bd768ba3 --- /dev/null +++ b/docs/english/reference/interfaces/AuthorizeResult.md @@ -0,0 +1,83 @@ +[@slack/bolt](../index.md) / AuthorizeResult + +# Interface: AuthorizeResult + +Defined in: [src/App.ts:178](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L178) + +Authorization function outputs - data that will be available as part of event processing + +## Indexable + +```ts +[key: string]: any +``` + +## Properties + +### botId? + +```ts +optional botId?: string; +``` + +Defined in: [src/App.ts:182](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L182) + +*** + +### botToken? + +```ts +optional botToken?: string; +``` + +Defined in: [src/App.ts:180](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L180) + +*** + +### botUserId? + +```ts +optional botUserId?: string; +``` + +Defined in: [src/App.ts:183](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L183) + +*** + +### enterpriseId? + +```ts +optional enterpriseId?: string; +``` + +Defined in: [src/App.ts:186](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L186) + +*** + +### teamId? + +```ts +optional teamId?: string; +``` + +Defined in: [src/App.ts:185](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L185) + +*** + +### userId? + +```ts +optional userId?: string; +``` + +Defined in: [src/App.ts:184](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L184) + +*** + +### userToken? + +```ts +optional userToken?: string; +``` + +Defined in: [src/App.ts:181](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L181) diff --git a/docs/english/reference/interfaces/AuthorizeSourceData.md b/docs/english/reference/interfaces/AuthorizeSourceData.md new file mode 100644 index 000000000..8fa5a7532 --- /dev/null +++ b/docs/english/reference/interfaces/AuthorizeSourceData.md @@ -0,0 +1,63 @@ +[@slack/bolt](../index.md) / AuthorizeSourceData + +# Interface: AuthorizeSourceData\ + +Defined in: [src/App.ts:169](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L169) + +Authorization function inputs - authenticated data about an event for the authorization function + +## Type Parameters + +### IsEnterpriseInstall + +`IsEnterpriseInstall` *extends* `boolean` = `false` + +## Properties + +### conversationId? + +```ts +optional conversationId?: string; +``` + +Defined in: [src/App.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L173) + +*** + +### enterpriseId + +```ts +enterpriseId: IsEnterpriseInstall extends true ? string : string | undefined; +``` + +Defined in: [src/App.ts:171](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L171) + +*** + +### isEnterpriseInstall + +```ts +isEnterpriseInstall: IsEnterpriseInstall; +``` + +Defined in: [src/App.ts:174](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L174) + +*** + +### teamId + +```ts +teamId: IsEnterpriseInstall extends true ? string | undefined : string; +``` + +Defined in: [src/App.ts:170](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L170) + +*** + +### userId? + +```ts +optional userId?: string; +``` + +Defined in: [src/App.ts:172](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L172) diff --git a/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md new file mode 100644 index 000000000..523ae7552 --- /dev/null +++ b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md @@ -0,0 +1,141 @@ +[@slack/bolt](../index.md) / AwsLambdaReceiverOptions + +# Interface: AwsLambdaReceiverOptions + +Defined in: [src/receivers/AwsLambdaReceiver.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L84) + +## Properties + +### customPropertiesExtractor? + +```ts +optional customPropertiesExtractor?: (request) => StringIndexed; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:120](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L120) + +Optional `function` that can extract custom properties from an incoming receiver event + +#### Parameters + +##### request + +`AwsEvent` + +The API Gateway event AwsEvent + +#### Returns + +[`StringIndexed`](../type-aliases/StringIndexed.md) + +An object containing custom properties + +#### Default + +```ts +noop +``` + +*** + +### invalidRequestSignatureHandler? + +```ts +optional invalidRequestSignatureHandler?: (args) => void; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:121](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L121) + +#### Parameters + +##### args + +`ReceiverInvalidRequestSignatureHandlerArgs` + +#### Returns + +`void` + +*** + +### logger? + +```ts +optional logger?: Logger; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:100](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L100) + +The Logger for the receiver + +#### Default + +```ts +ConsoleLogger +``` + +*** + +### logLevel? + +```ts +optional logLevel?: LogLevel; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:106](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L106) + +The LogLevel to be used for the logger. + +#### Default + +```ts +LogLevel.INFO +``` + +*** + +### signatureVerification? + +```ts +optional signatureVerification?: boolean; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:112](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L112) + +Flag that determines whether Bolt should [Slack's signature on incoming requests](https://api.slack.com/authentication/verifying-requests-from-slack|verify). + +#### Default + +```ts +true +``` + +*** + +### signingSecret + +```ts +signingSecret: string; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:94](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L94) + +The Slack Signing secret to be used as an input to signature verification to ensure that requests are coming from +Slack. + +If the [signatureVerification](#signatureverification) flag is set to `false`, this can be set to any value as signature verification +using this secret will not be performed. + +#### See + +[https://api.slack.com/authentication/verifying-requests-from-slack#about](https://api.slack.com/authentication/verifying-requests-from-slack#about) for details about signing secrets + +*** + +### unhandledRequestTimeoutMillis? + +```ts +optional unhandledRequestTimeoutMillis?: number; +``` + +Defined in: [src/receivers/AwsLambdaReceiver.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L122) diff --git a/docs/english/reference/interfaces/BaseSlackEvent.md b/docs/english/reference/interfaces/BaseSlackEvent.md new file mode 100644 index 000000000..6253b88b4 --- /dev/null +++ b/docs/english/reference/interfaces/BaseSlackEvent.md @@ -0,0 +1,21 @@ +[@slack/bolt](../index.md) / BaseSlackEvent + +# Interface: BaseSlackEvent\ + +Defined in: [src/types/events/index.ts:68](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L68) + +## Type Parameters + +### T + +`T` *extends* `string` = `string` + +## Properties + +### type + +```ts +type: T; +``` + +Defined in: [src/types/events/index.ts:69](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L69) diff --git a/docs/english/reference/interfaces/BasicElementAction.md b/docs/english/reference/interfaces/BasicElementAction.md new file mode 100644 index 000000000..c0a688fdc --- /dev/null +++ b/docs/english/reference/interfaces/BasicElementAction.md @@ -0,0 +1,79 @@ +[@slack/bolt](../index.md) / BasicElementAction + +# Interface: BasicElementAction\ + +Defined in: [src/types/actions/block-action.ts:39](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L39) + +Any action from Slack's interactive elements + +This type is used to represent actions that aren't known ahead of time. Each of the known element actions also +implement this interface. + +## Extended by + +- [`ButtonAction`](ButtonAction.md) +- [`FeedbackButtonsAction`](FeedbackButtonsAction.md) +- [`IconButtonAction`](IconButtonAction.md) +- [`StaticSelectAction`](StaticSelectAction.md) +- [`MultiStaticSelectAction`](MultiStaticSelectAction.md) +- [`UsersSelectAction`](UsersSelectAction.md) +- [`MultiUsersSelectAction`](MultiUsersSelectAction.md) +- [`ConversationsSelectAction`](ConversationsSelectAction.md) +- [`MultiConversationsSelectAction`](MultiConversationsSelectAction.md) +- [`ChannelsSelectAction`](ChannelsSelectAction.md) +- [`MultiChannelsSelectAction`](MultiChannelsSelectAction.md) +- [`ExternalSelectAction`](ExternalSelectAction.md) +- [`MultiExternalSelectAction`](MultiExternalSelectAction.md) +- [`OverflowAction`](OverflowAction.md) +- [`DatepickerAction`](DatepickerAction.md) +- [`TimepickerAction`](TimepickerAction.md) +- [`RadioButtonsAction`](RadioButtonsAction.md) +- [`CheckboxesAction`](CheckboxesAction.md) +- [`PlainTextInputAction`](PlainTextInputAction.md) +- [`RichTextInputAction`](RichTextInputAction.md) + +## Type Parameters + +### T + +`T` *extends* `string` = `string` + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +*** + +### type + +```ts +type: T; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) diff --git a/docs/english/reference/interfaces/BasicOptionsPayload.md b/docs/english/reference/interfaces/BasicOptionsPayload.md new file mode 100644 index 000000000..f33a1fe95 --- /dev/null +++ b/docs/english/reference/interfaces/BasicOptionsPayload.md @@ -0,0 +1,31 @@ +[@slack/bolt](../index.md) / BasicOptionsPayload + +# Interface: BasicOptionsPayload\ + +Defined in: [src/types/options/index.ts:33](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L33) + +## Type Parameters + +### Type + +`Type` *extends* `string` = `string` + +## Properties + +### type + +```ts +type: Type; +``` + +Defined in: [src/types/options/index.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L34) + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/options/index.ts:35](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L35) diff --git a/docs/english/reference/interfaces/BlockAction.md b/docs/english/reference/interfaces/BlockAction.md new file mode 100644 index 000000000..926bd2598 --- /dev/null +++ b/docs/english/reference/interfaces/BlockAction.md @@ -0,0 +1,360 @@ +[@slack/bolt](../index.md) / BlockAction + +# Interface: BlockAction\ + +Defined in: [src/types/actions/block-action.ts:249](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L249) + +A Slack Block Kit element action wrapped in the standard metadata. + +This describes the entire JSON-encoded body of a request from Slack's Block Kit interactive components. + +## Type Parameters + +### ElementAction + +`ElementAction` *extends* [`BasicElementAction`](BasicElementAction.md) = [`BlockElementAction`](../type-aliases/BlockElementAction.md) + +## Properties + +### actions + +```ts +actions: ElementAction[]; +``` + +Defined in: [src/types/actions/block-action.ts:251](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L251) + +*** + +### api\_app\_id + +```ts +api_app_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:291](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L291) + +*** + +### app\_unfurl? + +```ts +optional app_unfurl?: any; +``` + +Defined in: [src/types/actions/block-action.ts:297](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L297) + +*** + +### bot\_access\_token? + +```ts +optional bot_access_token?: string; +``` + +Defined in: [src/types/actions/block-action.ts:311](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L311) + +An expiring token generated for the context of a workflow step. + +#### See + +[https://docs.slack.dev/authentication/tokens/#wfb](https://docs.slack.dev/authentication/tokens/#wfb) + +*** + +### channel? + +```ts +optional channel?: object; +``` + +Defined in: [src/types/actions/block-action.ts:267](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L267) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### container + +```ts +container: StringIndexed; +``` + +Defined in: [src/types/actions/block-action.ts:294](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L294) + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/actions/block-action.ts:301](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L301) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### function\_data? + +```ts +optional function_data?: object; +``` + +Defined in: [src/types/actions/block-action.ts:317](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L317) + +Information about the executed step. + +#### execution\_id + +```ts +execution_id: string; +``` + +A unique ID for the step being executed. + +##### See + + - [https://docs.slack.dev/workflows/workflow-steps/](https://docs.slack.dev/workflows/workflow-steps/) + - [https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/](https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/) + +#### function + +```ts +function: object; +``` + +Details about the step. + +##### See + + - [https://docs.slack.dev/workflows/workflow-steps/](https://docs.slack.dev/workflows/workflow-steps/) + - [https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/](https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/) + +##### function.callback\_id + +```ts +callback_id: string; +``` + +The unique callback ID of the step. + +###### See + + - [https://docs.slack.dev/workflows/workflow-steps/#create](https://docs.slack.dev/workflows/workflow-steps/#create) + - [https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/](https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/) + +#### inputs + +```ts +inputs: FunctionInputs; +``` + +Values of input parameters for the executed step. + +##### See + + - [https://docs.slack.dev/workflows/workflow-steps/](https://docs.slack.dev/workflows/workflow-steps/) + - [https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/](https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/) + - [https://docs.slack.dev/tools/bolt-js/tutorials/custom-steps/#inputs-outputs](https://docs.slack.dev/tools/bolt-js/tutorials/custom-steps/#inputs-outputs) + +#### See + + - [https://docs.slack.dev/workflows/workflow-steps/](https://docs.slack.dev/workflows/workflow-steps/) + - [https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/](https://docs.slack.dev/tools/bolt-js/concepts/custom-steps/) + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/actions/block-action.ts:300](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L300) + +*** + +### message? + +```ts +optional message?: object; +``` + +Defined in: [src/types/actions/block-action.ts:272](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L272) + +#### Index Signature + +```ts +[key: string]: any +``` + +#### text? + +```ts +optional text?: string; +``` + +#### ts + +```ts +ts: string; +``` + +#### type + +```ts +type: "message"; +``` + +#### user? + +```ts +optional user?: string; +``` + +*** + +### response\_url + +```ts +response_url: string; +``` + +Defined in: [src/types/actions/block-action.ts:289](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L289) + +*** + +### state? + +```ts +optional state?: object; +``` + +Defined in: [src/types/actions/block-action.ts:281](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L281) + +#### values + +```ts +values: object; +``` + +##### Index Signature + +```ts +[blockId: string]: object +``` + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/actions/block-action.ts:252](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L252) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/actions/block-action.ts:288](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L288) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:290](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L290) + +*** + +### type + +```ts +type: "block_actions"; +``` + +Defined in: [src/types/actions/block-action.ts:250](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L250) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/actions/block-action.ts:258](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L258) + +#### id + +```ts +id: string; +``` + +#### name? + +```ts +optional name?: string; +``` + +name will be present if the block_action originates from the Home tab + +#### team\_id? + +```ts +optional team_id?: string; +``` + +#### username + +```ts +username: string; +``` + +*** + +### view? + +```ts +optional view?: ViewOutput; +``` + +Defined in: [src/types/actions/block-action.ts:280](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L280) diff --git a/docs/english/reference/interfaces/BlockOptions.md b/docs/english/reference/interfaces/BlockOptions.md new file mode 100644 index 000000000..f0a84aba9 --- /dev/null +++ b/docs/english/reference/interfaces/BlockOptions.md @@ -0,0 +1,15 @@ +[@slack/bolt](../index.md) / BlockOptions + +# Interface: BlockOptions + +Defined in: [src/types/options/index.ts:160](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L160) + +## Properties + +### options + +```ts +options: Option[]; +``` + +Defined in: [src/types/options/index.ts:161](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L161) diff --git a/docs/english/reference/interfaces/BlockSuggestion.md b/docs/english/reference/interfaces/BlockSuggestion.md new file mode 100644 index 000000000..9a1b79381 --- /dev/null +++ b/docs/english/reference/interfaces/BlockSuggestion.md @@ -0,0 +1,196 @@ +[@slack/bolt](../index.md) / BlockSuggestion + +# Interface: BlockSuggestion + +Defined in: [src/types/options/index.ts:45](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L45) + +external data source in blocks + +## Extends + +- [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Indexable + +```ts +[key: string]: any +``` + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/options/index.ts:48](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L48) + +*** + +### api\_app\_id + +```ts +api_app_id: string; +``` + +Defined in: [src/types/options/index.ts:51](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L51) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/options/index.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L47) + +*** + +### channel? + +```ts +optional channel?: object; +``` + +Defined in: [src/types/options/index.ts:58](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L58) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### container + +```ts +container: StringIndexed; +``` + +Defined in: [src/types/options/index.ts:68](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L68) + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/options/index.ts:73](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L73) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/options/index.ts:72](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L72) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/options/index.ts:52](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L52) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/options/index.ts:67](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L67) + +*** + +### type + +```ts +type: "block_suggestion"; +``` + +Defined in: [src/types/options/index.ts:46](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L46) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/options/index.ts:62](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L62) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/options/index.ts:49](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L49) + +*** + +### view? + +```ts +optional view?: ViewOutput; +``` + +Defined in: [src/types/options/index.ts:70](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L70) diff --git a/docs/english/reference/interfaces/BufferedIncomingMessage.md b/docs/english/reference/interfaces/BufferedIncomingMessage.md new file mode 100644 index 000000000..9d47f4c0f --- /dev/null +++ b/docs/english/reference/interfaces/BufferedIncomingMessage.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / BufferedIncomingMessage + +# Interface: BufferedIncomingMessage + +Defined in: [src/receivers/BufferedIncomingMessage.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/receivers/BufferedIncomingMessage.ts#L5) + +## Extends + +- `IncomingMessage` + +## Properties + +### rawBody + +```ts +rawBody: Buffer; +``` + +Defined in: [src/receivers/BufferedIncomingMessage.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/receivers/BufferedIncomingMessage.ts#L6) diff --git a/docs/english/reference/interfaces/ButtonAction.md b/docs/english/reference/interfaces/ButtonAction.md new file mode 100644 index 000000000..d61a50597 --- /dev/null +++ b/docs/english/reference/interfaces/ButtonAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / ButtonAction + +# Interface: ButtonAction + +Defined in: [src/types/actions/block-action.ts:49](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L49) + +An action from a button element + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"button"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:53](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L53) + +*** + +### text + +```ts +text: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:51](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L51) + +*** + +### type + +```ts +type: "button"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) + +*** + +### url? + +```ts +optional url?: string; +``` + +Defined in: [src/types/actions/block-action.ts:52](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L52) + +*** + +### value? + +```ts +optional value?: string; +``` + +Defined in: [src/types/actions/block-action.ts:50](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L50) diff --git a/docs/english/reference/interfaces/ButtonClick.md b/docs/english/reference/interfaces/ButtonClick.md new file mode 100644 index 000000000..bb2d9b6e7 --- /dev/null +++ b/docs/english/reference/interfaces/ButtonClick.md @@ -0,0 +1,37 @@ +[@slack/bolt](../index.md) / ButtonClick + +# Interface: ButtonClick + +Defined in: [src/types/actions/interactive-message.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L10) + +A button click action from a legacy interactive message. + +## Properties + +### name + +```ts +name: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:12](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L12) + +*** + +### type + +```ts +type: "button"; +``` + +Defined in: [src/types/actions/interactive-message.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L11) + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:13](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L13) diff --git a/docs/english/reference/interfaces/ChannelsSelectAction.md b/docs/english/reference/interfaces/ChannelsSelectAction.md new file mode 100644 index 000000000..772669c4e --- /dev/null +++ b/docs/english/reference/interfaces/ChannelsSelectAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / ChannelsSelectAction + +# Interface: ChannelsSelectAction + +Defined in: [src/types/actions/block-action.ts:142](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L142) + +An action from a select menu with channels list + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"channels_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:146](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L146) + +*** + +### initial\_channel? + +```ts +optional initial_channel?: string; +``` + +Defined in: [src/types/actions/block-action.ts:144](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L144) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L145) + +*** + +### selected\_channel + +```ts +selected_channel: string; +``` + +Defined in: [src/types/actions/block-action.ts:143](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L143) + +*** + +### type + +```ts +type: "channels_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/CheckboxesAction.md b/docs/english/reference/interfaces/CheckboxesAction.md new file mode 100644 index 000000000..0e09d6f68 --- /dev/null +++ b/docs/english/reference/interfaces/CheckboxesAction.md @@ -0,0 +1,97 @@ +[@slack/bolt](../index.md) / CheckboxesAction + +# Interface: CheckboxesAction + +Defined in: [src/types/actions/block-action.ts:224](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L224) + +An action from a checkboxes element + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"checkboxes"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:227](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L227) + +*** + +### initial\_options? + +```ts +optional initial_options?: Option[]; +``` + +Defined in: [src/types/actions/block-action.ts:226](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L226) + +*** + +### selected\_options + +```ts +selected_options: Option[]; +``` + +Defined in: [src/types/actions/block-action.ts:225](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L225) + +*** + +### type + +```ts +type: "checkboxes"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/CodedError.md b/docs/english/reference/interfaces/CodedError.md new file mode 100644 index 000000000..34cfb8015 --- /dev/null +++ b/docs/english/reference/interfaces/CodedError.md @@ -0,0 +1,71 @@ +[@slack/bolt](../index.md) / CodedError + +# Interface: CodedError + +Defined in: [src/errors.ts:4](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L4) + +## Extends + +- `Error` + +## Properties + +### code + +```ts +code: string; +``` + +Defined in: [src/errors.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L5) + +*** + +### missingProperty? + +```ts +optional missingProperty?: string; +``` + +Defined in: [src/errors.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L8) + +*** + +### original? + +```ts +optional original?: Error; +``` + +Defined in: [src/errors.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L6) + +*** + +### originals? + +```ts +optional originals?: Error[]; +``` + +Defined in: [src/errors.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L7) + +*** + +### req? + +```ts +optional req?: + | IncomingMessage + | BufferedIncomingMessage; +``` + +Defined in: [src/errors.ts:9](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L9) + +*** + +### res? + +```ts +optional res?: ServerResponse; +``` + +Defined in: [src/errors.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L10) diff --git a/docs/english/reference/interfaces/Context.md b/docs/english/reference/interfaces/Context.md new file mode 100644 index 000000000..60aa90865 --- /dev/null +++ b/docs/english/reference/interfaces/Context.md @@ -0,0 +1,181 @@ +[@slack/bolt](../index.md) / Context + +# Interface: Context + +Defined in: [src/types/middleware.ts:37](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L37) + +Context object, which provides contextual information associated with an incoming requests. +You can set any other custom attributes in global middleware as long as the key does not conflict with others. + +## Extends + +- [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Indexable + +```ts +[key: string]: any +``` + +## Properties + +### botId? + +```ts +optional botId?: string; +``` + +Defined in: [src/types/middleware.ts:53](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L53) + +This app's bot ID in the installed workspace. +This is required for `ignoreSelf` global middleware. +see also: https://github.com/slackapi/bolt-js/issues/874 + +*** + +### botToken? + +```ts +optional botToken?: string; +``` + +Defined in: [src/types/middleware.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L42) + +A bot token, which starts with `xoxb-`. +This value can be used by `say` (preferred over userToken), + +*** + +### botUserId? + +```ts +optional botUserId?: string; +``` + +Defined in: [src/types/middleware.ts:58](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L58) + +This app's bot user ID in the installed workspace. +This value is optional but allows `ignoreSelf` global middleware be more filter more than just message events. + +*** + +### enterpriseId? + +```ts +optional enterpriseId?: string; +``` + +Defined in: [src/types/middleware.ts:70](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L70) + +Enterprise Grid Organization ID. + +*** + +### functionBotAccessToken? + +```ts +optional functionBotAccessToken?: string; +``` + +Defined in: [src/types/middleware.ts:81](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L81) + +A JIT and function-specific token that, when used to make API calls, +creates an association between a function's execution and subsequent actions +(e.g., buttons and other interactivity) + +*** + +### functionExecutionId? + +```ts +optional functionExecutionId?: string; +``` + +Defined in: [src/types/middleware.ts:86](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L86) + +Function execution ID associated with the event + +*** + +### functionInputs? + +```ts +optional functionInputs?: FunctionInputs; +``` + +Defined in: [src/types/middleware.ts:91](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L91) + +Inputs that were provided to a function when it was executed + +*** + +### isEnterpriseInstall + +```ts +isEnterpriseInstall: boolean; +``` + +Defined in: [src/types/middleware.ts:74](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L74) + +Is the app installed at an Enterprise level? + +*** + +### retryNum? + +```ts +optional retryNum?: number; +``` + +Defined in: [src/types/middleware.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L96) + +Retry count of an Events API request (this property does not exist for other requests) + +*** + +### retryReason? + +```ts +optional retryReason?: string; +``` + +Defined in: [src/types/middleware.ts:100](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L100) + +Retry reason of an Events API request (this property does not exist for other requests) + +*** + +### teamId? + +```ts +optional teamId?: string; +``` + +Defined in: [src/types/middleware.ts:66](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L66) + +Workspace ID. + +*** + +### userId? + +```ts +optional userId?: string; +``` + +Defined in: [src/types/middleware.ts:62](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L62) + +User ID. + +*** + +### userToken? + +```ts +optional userToken?: string; +``` + +Defined in: [src/types/middleware.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L47) + +A bot token, which starts with `xoxp-`. +This value can be used by `say` (overridden by botToken), diff --git a/docs/english/reference/interfaces/ConversationStore.md b/docs/english/reference/interfaces/ConversationStore.md new file mode 100644 index 000000000..36e164d09 --- /dev/null +++ b/docs/english/reference/interfaces/ConversationStore.md @@ -0,0 +1,65 @@ +[@slack/bolt](../index.md) / ConversationStore + +# Interface: ConversationStore\ + +Defined in: [src/conversation-store.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L8) + +Storage backend used by the conversation context middleware + +## Type Parameters + +### ConversationState + +`ConversationState` = `any` + +## Methods + +### get() + +```ts +get(conversationId): Promise; +``` + +Defined in: [src/conversation-store.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L11) + +#### Parameters + +##### conversationId + +`string` + +#### Returns + +`Promise`\<`ConversationState`\> + +*** + +### set() + +```ts +set( + conversationId, + value, + expiresAt? +): Promise; +``` + +Defined in: [src/conversation-store.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L10) + +#### Parameters + +##### conversationId + +`string` + +##### value + +`ConversationState` + +##### expiresAt? + +`number` + +#### Returns + +`Promise`\<`unknown`\> diff --git a/docs/english/reference/interfaces/ConversationsSelectAction.md b/docs/english/reference/interfaces/ConversationsSelectAction.md new file mode 100644 index 000000000..366bd8361 --- /dev/null +++ b/docs/english/reference/interfaces/ConversationsSelectAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / ConversationsSelectAction + +# Interface: ConversationsSelectAction + +Defined in: [src/types/actions/block-action.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L122) + +An action from a select menu with conversations list + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"conversations_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:126](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L126) + +*** + +### initial\_conversation? + +```ts +optional initial_conversation?: string; +``` + +Defined in: [src/types/actions/block-action.ts:124](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L124) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:125](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L125) + +*** + +### selected\_conversation + +```ts +selected_conversation: string; +``` + +Defined in: [src/types/actions/block-action.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L123) + +*** + +### type + +```ts +type: "conversations_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/CustomRoute.md b/docs/english/reference/interfaces/CustomRoute.md new file mode 100644 index 000000000..a0ecbac77 --- /dev/null +++ b/docs/english/reference/interfaces/CustomRoute.md @@ -0,0 +1,49 @@ +[@slack/bolt](../index.md) / CustomRoute + +# Interface: CustomRoute + +Defined in: [src/receivers/custom-routes.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L5) + +## Properties + +### handler + +```ts +handler: (req, res) => void; +``` + +Defined in: [src/receivers/custom-routes.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L8) + +#### Parameters + +##### req + +`ParamsIncomingMessage` + +##### res + +`ServerResponse` + +#### Returns + +`void` + +*** + +### method + +```ts +method: string | string[]; +``` + +Defined in: [src/receivers/custom-routes.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L7) + +*** + +### path + +```ts +path: string; +``` + +Defined in: [src/receivers/custom-routes.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L6) diff --git a/docs/english/reference/interfaces/DatepickerAction.md b/docs/english/reference/interfaces/DatepickerAction.md new file mode 100644 index 000000000..3af86b9f6 --- /dev/null +++ b/docs/english/reference/interfaces/DatepickerAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / DatepickerAction + +# Interface: DatepickerAction + +Defined in: [src/types/actions/block-action.ts:195](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L195) + +An action from a date picker element + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"datepicker"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:199](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L199) + +*** + +### initial\_date? + +```ts +optional initial_date?: string; +``` + +Defined in: [src/types/actions/block-action.ts:197](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L197) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:198](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L198) + +*** + +### selected\_date + +```ts +selected_date: string | null; +``` + +Defined in: [src/types/actions/block-action.ts:196](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L196) + +*** + +### type + +```ts +type: "datepicker"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/DialogOptionGroups.md b/docs/english/reference/interfaces/DialogOptionGroups.md new file mode 100644 index 000000000..685c443cc --- /dev/null +++ b/docs/english/reference/interfaces/DialogOptionGroups.md @@ -0,0 +1,21 @@ +[@slack/bolt](../index.md) / DialogOptionGroups + +# Interface: DialogOptionGroups\ + +Defined in: [src/types/options/index.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L177) + +## Type Parameters + +### Options + +`Options` + +## Properties + +### option\_groups + +```ts +option_groups: object & Options[]; +``` + +Defined in: [src/types/options/index.ts:178](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L178) diff --git a/docs/english/reference/interfaces/DialogOptions.md b/docs/english/reference/interfaces/DialogOptions.md new file mode 100644 index 000000000..088a6089f --- /dev/null +++ b/docs/english/reference/interfaces/DialogOptions.md @@ -0,0 +1,27 @@ +[@slack/bolt](../index.md) / DialogOptions + +# Interface: DialogOptions + +Defined in: [src/types/options/index.ts:166](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L166) + +## Properties + +### options + +```ts +options: object[]; +``` + +Defined in: [src/types/options/index.ts:167](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L167) + +#### label + +```ts +label: string; +``` + +#### value + +```ts +value: string; +``` diff --git a/docs/english/reference/interfaces/DialogSubmitAction.md b/docs/english/reference/interfaces/DialogSubmitAction.md new file mode 100644 index 000000000..7ec57cb68 --- /dev/null +++ b/docs/english/reference/interfaces/DialogSubmitAction.md @@ -0,0 +1,184 @@ +[@slack/bolt](../index.md) / DialogSubmitAction + +# Interface: DialogSubmitAction + +Defined in: [src/types/actions/dialog-action.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L6) + +A Slack dialog submit action wrapped in the standard metadata. + +This describes the entire JSON-encoded body of a request from Slack dialogs. + +## Properties + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/dialog-action.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L26) + +*** + +### callback\_id + +```ts +callback_id: string; +``` + +Defined in: [src/types/actions/dialog-action.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L8) + +*** + +### channel + +```ts +channel: object; +``` + +Defined in: [src/types/actions/dialog-action.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L22) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/actions/dialog-action.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L32) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/actions/dialog-action.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L31) + +*** + +### response\_url + +```ts +response_url: string; +``` + +Defined in: [src/types/actions/dialog-action.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L28) + +*** + +### state + +```ts +state: string; +``` + +Defined in: [src/types/actions/dialog-action.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L10) + +*** + +### submission + +```ts +submission: object; +``` + +Defined in: [src/types/actions/dialog-action.ts:9](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L9) + +#### Index Signature + +```ts +[name: string]: string +``` + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/actions/dialog-action.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L11) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/actions/dialog-action.ts:27](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L27) + +*** + +### type + +```ts +type: "dialog_submission"; +``` + +Defined in: [src/types/actions/dialog-action.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L7) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/actions/dialog-action.ts:17](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L17) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` diff --git a/docs/english/reference/interfaces/DialogSuggestion.md b/docs/english/reference/interfaces/DialogSuggestion.md new file mode 100644 index 000000000..393953936 --- /dev/null +++ b/docs/english/reference/interfaces/DialogSuggestion.md @@ -0,0 +1,176 @@ +[@slack/bolt](../index.md) / DialogSuggestion + +# Interface: DialogSuggestion + +Defined in: [src/types/options/index.ts:118](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L118) + +external data source in dialogs + +## Extends + +- [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Indexable + +```ts +[key: string]: any +``` + +## Properties + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/options/index.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L123) + +*** + +### callback\_id + +```ts +callback_id: string; +``` + +Defined in: [src/types/options/index.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L122) + +*** + +### channel? + +```ts +optional channel?: object; +``` + +Defined in: [src/types/options/index.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L131) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/options/index.ts:143](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L143) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/options/index.ts:142](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L142) + +*** + +### name + +```ts +name: string; +``` + +Defined in: [src/types/options/index.ts:120](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L120) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/options/index.ts:125](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L125) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/options/index.ts:140](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L140) + +*** + +### type + +```ts +type: "dialog_suggestion"; +``` + +Defined in: [src/types/options/index.ts:119](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L119) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/options/index.ts:135](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L135) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/options/index.ts:121](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L121) diff --git a/docs/english/reference/interfaces/DialogValidation.md b/docs/english/reference/interfaces/DialogValidation.md new file mode 100644 index 000000000..92a529af5 --- /dev/null +++ b/docs/english/reference/interfaces/DialogValidation.md @@ -0,0 +1,30 @@ +[@slack/bolt](../index.md) / DialogValidation + +# Interface: DialogValidation + +Defined in: [src/types/actions/dialog-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L42) + +A Slack dialog submission validation response. Use an object of this type to describe errors regarding inputs that +were part of the submission. + +## Properties + +### errors + +```ts +errors: object[]; +``` + +Defined in: [src/types/actions/dialog-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L43) + +#### error + +```ts +error: string; +``` + +#### name + +```ts +name: string; +``` diff --git a/docs/english/reference/interfaces/EnvelopedEvent.md b/docs/english/reference/interfaces/EnvelopedEvent.md new file mode 100644 index 000000000..716d62106 --- /dev/null +++ b/docs/english/reference/interfaces/EnvelopedEvent.md @@ -0,0 +1,145 @@ +[@slack/bolt](../index.md) / EnvelopedEvent + +# Interface: EnvelopedEvent\ + +Defined in: [src/types/events/index.ts:79](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L79) + +A Slack Events API event wrapped in the standard envelope. + +This describes the entire JSON-encoded body of a request from Slack's Events API. + +## Extends + +- [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Type Parameters + +### Event + +`Event` = [`BaseSlackEvent`](BaseSlackEvent.md) + +## Indexable + +```ts +[key: string]: any +``` + +## Properties + +### api\_app\_id + +```ts +api_app_id: string; +``` + +Defined in: [src/types/events/index.ts:85](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L85) + +*** + +### authorizations? + +```ts +optional authorizations?: Authorization[]; +``` + +Defined in: [src/types/events/index.ts:91](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L91) + +*** + +### context\_enterprise\_id? + +```ts +optional context_enterprise_id?: string; +``` + +Defined in: [src/types/events/index.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L84) + +*** + +### context\_team\_id? + +```ts +optional context_team_id?: string; +``` + +Defined in: [src/types/events/index.ts:83](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L83) + +*** + +### enterprise\_id? + +```ts +optional enterprise_id?: string; +``` + +Defined in: [src/types/events/index.ts:82](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L82) + +*** + +### event + +```ts +event: Event; +``` + +Defined in: [src/types/events/index.ts:86](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L86) + +*** + +### event\_id + +```ts +event_id: string; +``` + +Defined in: [src/types/events/index.ts:88](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L88) + +*** + +### event\_time + +```ts +event_time: number; +``` + +Defined in: [src/types/events/index.ts:89](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L89) + +*** + +### is\_ext\_shared\_channel? + +```ts +optional is_ext_shared_channel?: boolean; +``` + +Defined in: [src/types/events/index.ts:90](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L90) + +*** + +### team\_id + +```ts +team_id: string; +``` + +Defined in: [src/types/events/index.ts:81](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L81) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/events/index.ts:80](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L80) + +*** + +### type + +```ts +type: "event_callback"; +``` + +Defined in: [src/types/events/index.ts:87](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L87) diff --git a/docs/english/reference/interfaces/ExpressReceiverOptions.md b/docs/english/reference/interfaces/ExpressReceiverOptions.md new file mode 100644 index 000000000..758546204 --- /dev/null +++ b/docs/english/reference/interfaces/ExpressReceiverOptions.md @@ -0,0 +1,249 @@ +[@slack/bolt](../index.md) / ExpressReceiverOptions + +# Interface: ExpressReceiverOptions + +Defined in: [src/receivers/ExpressReceiver.ts:92](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L92) + +## Properties + +### app? + +```ts +optional app?: Application; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:110](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L110) + +*** + +### clientId? + +```ts +optional clientId?: string; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:103](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L103) + +*** + +### clientSecret? + +```ts +optional clientSecret?: string; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:104](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L104) + +*** + +### customPropertiesExtractor? + +```ts +optional customPropertiesExtractor?: (request) => StringIndexed; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:112](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L112) + +#### Parameters + +##### request + +`Request` + +#### Returns + +[`StringIndexed`](../type-aliases/StringIndexed.md) + +*** + +### dispatchErrorHandler? + +```ts +optional dispatchErrorHandler?: (args) => Promise; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:113](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L113) + +#### Parameters + +##### args + +[`ReceiverDispatchErrorHandlerArgs`](../bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md) + +#### Returns + +`Promise`\<`void`\> + +*** + +### endpoints? + +```ts +optional endpoints?: + | string + | { +[endpointType: string]: string; +}; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L96) + +*** + +### installationStore? + +```ts +optional installationStore?: InstallationStore; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:107](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L107) + +*** + +### installerOptions? + +```ts +optional installerOptions?: InstallerOptions; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:109](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L109) + +*** + +### logger? + +```ts +optional logger?: Logger; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:94](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L94) + +*** + +### logLevel? + +```ts +optional logLevel?: LogLevel; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:95](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L95) + +*** + +### processBeforeResponse? + +```ts +optional processBeforeResponse?: boolean; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:102](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L102) + +*** + +### processEventErrorHandler? + +```ts +optional processEventErrorHandler?: (args) => Promise; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:114](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L114) + +#### Parameters + +##### args + +[`ReceiverProcessEventErrorHandlerArgs`](../bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md) + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### redirectUri? + +```ts +optional redirectUri?: string; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:106](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L106) + +*** + +### router? + +```ts +optional router?: IRouter; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:111](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L111) + +*** + +### scopes? + +```ts +optional scopes?: string | string[]; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:108](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L108) + +*** + +### signatureVerification? + +```ts +optional signatureVerification?: boolean; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:101](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L101) + +*** + +### signingSecret + +```ts +signingSecret: string | (() => PromiseLike); +``` + +Defined in: [src/receivers/ExpressReceiver.ts:93](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L93) + +*** + +### stateSecret? + +```ts +optional stateSecret?: string; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:105](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L105) + +*** + +### unhandledRequestHandler? + +```ts +optional unhandledRequestHandler?: (args) => void; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:118](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L118) + +#### Parameters + +##### args + +[`ReceiverUnhandledRequestHandlerArgs`](../bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md) + +#### Returns + +`void` + +*** + +### unhandledRequestTimeoutMillis? + +```ts +optional unhandledRequestTimeoutMillis?: number; +``` + +Defined in: [src/receivers/ExpressReceiver.ts:119](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L119) diff --git a/docs/english/reference/interfaces/ExternalSelectAction.md b/docs/english/reference/interfaces/ExternalSelectAction.md new file mode 100644 index 000000000..9a4322ff1 --- /dev/null +++ b/docs/english/reference/interfaces/ExternalSelectAction.md @@ -0,0 +1,117 @@ +[@slack/bolt](../index.md) / ExternalSelectAction + +# Interface: ExternalSelectAction + +Defined in: [src/types/actions/block-action.ts:162](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L162) + +An action from a select menu with external data source + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"external_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:167](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L167) + +*** + +### initial\_option? + +```ts +optional initial_option?: Option; +``` + +Defined in: [src/types/actions/block-action.ts:164](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L164) + +*** + +### min\_query\_length? + +```ts +optional min_query_length?: number; +``` + +Defined in: [src/types/actions/block-action.ts:166](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L166) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:165](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L165) + +*** + +### selected\_option? + +```ts +optional selected_option?: Option; +``` + +Defined in: [src/types/actions/block-action.ts:163](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L163) + +*** + +### type + +```ts +type: "external_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/FeedbackButtonsAction.md b/docs/english/reference/interfaces/FeedbackButtonsAction.md new file mode 100644 index 000000000..5e0081917 --- /dev/null +++ b/docs/english/reference/interfaces/FeedbackButtonsAction.md @@ -0,0 +1,87 @@ +[@slack/bolt](../index.md) / FeedbackButtonsAction + +# Interface: FeedbackButtonsAction + +Defined in: [src/types/actions/block-action.ts:59](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L59) + +An action from feedback buttons + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"feedback_buttons"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### text + +```ts +text: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:61](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L61) + +*** + +### type + +```ts +type: "feedback_buttons"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/actions/block-action.ts:60](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L60) diff --git a/docs/english/reference/interfaces/GlobalShortcut.md b/docs/english/reference/interfaces/GlobalShortcut.md new file mode 100644 index 000000000..abc124ef8 --- /dev/null +++ b/docs/english/reference/interfaces/GlobalShortcut.md @@ -0,0 +1,136 @@ +[@slack/bolt](../index.md) / GlobalShortcut + +# Interface: GlobalShortcut + +Defined in: [src/types/shortcuts/global-shortcut.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L7) + +A Slack global shortcut wrapped in the standard metadata. + +This describes the entire JSON-encoded body of a request from Slack global shortcuts. + +## Properties + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L24) + +*** + +### callback\_id + +```ts +callback_id: string; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:9](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L9) + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L28) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:27](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L27) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:17](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L17) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:23](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L23) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L10) + +*** + +### type + +```ts +type: "shortcut"; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L8) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/shortcuts/global-shortcut.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L11) + +#### id + +```ts +id: string; +``` + +#### team\_id + +```ts +team_id: string; +``` + +#### username + +```ts +username: string; +``` diff --git a/docs/english/reference/interfaces/HTTPReceiverOptions.md b/docs/english/reference/interfaces/HTTPReceiverOptions.md new file mode 100644 index 000000000..81768d304 --- /dev/null +++ b/docs/english/reference/interfaces/HTTPReceiverOptions.md @@ -0,0 +1,245 @@ +[@slack/bolt](../index.md) / HTTPReceiverOptions + +# Interface: HTTPReceiverOptions + +Defined in: [src/receivers/HTTPReceiver.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L76) + +## Properties + +### clientId? + +```ts +optional clientId?: string; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:85](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L85) + +*** + +### clientSecret? + +```ts +optional clientSecret?: string; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:86](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L86) + +*** + +### customPropertiesExtractor? + +```ts +optional customPropertiesExtractor?: (request) => StringIndexed; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:92](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L92) + +#### Parameters + +##### request + +[`BufferedIncomingMessage`](BufferedIncomingMessage.md) + +#### Returns + +[`StringIndexed`](../type-aliases/StringIndexed.md) + +*** + +### customRoutes? + +```ts +optional customRoutes?: CustomRoute[]; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:80](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L80) + +*** + +### dispatchErrorHandler? + +```ts +optional dispatchErrorHandler?: (args) => void; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:94](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L94) + +#### Parameters + +##### args + +[`ReceiverDispatchErrorHandlerArgs`](../bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md) + +#### Returns + +`void` + +*** + +### endpoints? + +```ts +optional endpoints?: string | string[]; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:78](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L78) + +*** + +### installationStore? + +```ts +optional installationStore?: InstallationStore; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:89](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L89) + +*** + +### installerOptions? + +```ts +optional installerOptions?: HTTPReceiverInstallerOptions; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:91](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L91) + +*** + +### logger? + +```ts +optional logger?: Logger; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:81](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L81) + +*** + +### logLevel? + +```ts +optional logLevel?: LogLevel; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:82](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L82) + +*** + +### port? + +```ts +optional port?: number; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:79](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L79) + +*** + +### processBeforeResponse? + +```ts +optional processBeforeResponse?: boolean; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:83](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L83) + +*** + +### processEventErrorHandler? + +```ts +optional processEventErrorHandler?: (args) => Promise; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:95](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L95) + +#### Parameters + +##### args + +[`ReceiverProcessEventErrorHandlerArgs`](../bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md) + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### redirectUri? + +```ts +optional redirectUri?: string; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:88](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L88) + +*** + +### scopes? + +```ts +optional scopes?: string | string[]; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:90](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L90) + +*** + +### signatureVerification? + +```ts +optional signatureVerification?: boolean; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L84) + +*** + +### signingSecret + +```ts +signingSecret: string; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:77](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L77) + +*** + +### stateSecret? + +```ts +optional stateSecret?: string; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:87](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L87) + +*** + +### unhandledRequestHandler? + +```ts +optional unhandledRequestHandler?: (args) => void; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:98](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L98) + +#### Parameters + +##### args + +[`ReceiverUnhandledRequestHandlerArgs`](../bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md) + +#### Returns + +`void` + +*** + +### unhandledRequestTimeoutMillis? + +```ts +optional unhandledRequestTimeoutMillis?: number; +``` + +Defined in: [src/receivers/HTTPReceiver.ts:99](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L99) diff --git a/docs/english/reference/interfaces/IconButtonAction.md b/docs/english/reference/interfaces/IconButtonAction.md new file mode 100644 index 000000000..05f878fd7 --- /dev/null +++ b/docs/english/reference/interfaces/IconButtonAction.md @@ -0,0 +1,97 @@ +[@slack/bolt](../index.md) / IconButtonAction + +# Interface: IconButtonAction + +Defined in: [src/types/actions/block-action.ts:67](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L67) + +An action from icon button + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"icon_button"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### icon + +```ts +icon: string; +``` + +Defined in: [src/types/actions/block-action.ts:68](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L68) + +*** + +### text + +```ts +text: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:70](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L70) + +*** + +### type + +```ts +type: "icon_button"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/actions/block-action.ts:69](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L69) diff --git a/docs/english/reference/interfaces/InteractiveMessage.md b/docs/english/reference/interfaces/InteractiveMessage.md new file mode 100644 index 000000000..e07aeba1b --- /dev/null +++ b/docs/english/reference/interfaces/InteractiveMessage.md @@ -0,0 +1,230 @@ +[@slack/bolt](../index.md) / InteractiveMessage + +# Interface: InteractiveMessage\ + +Defined in: [src/types/actions/interactive-message.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L32) + +A Slack legacy interactive message action wrapped in the standard metadata. + +This describes the entire JSON-encoded body of a request from Slack's legacy interactive messages. + +## Type Parameters + +### Action + +`Action` *extends* [`InteractiveAction`](../type-aliases/InteractiveAction.md) = [`InteractiveAction`](../type-aliases/InteractiveAction.md) + +## Properties + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:51](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L51) + +*** + +### actions + +```ts +actions: Action[]; +``` + +Defined in: [src/types/actions/interactive-message.ts:35](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L35) + +*** + +### attachment\_id? + +```ts +optional attachment_id?: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:52](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L52) + +*** + +### callback\_id + +```ts +callback_id: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L34) + +*** + +### channel + +```ts +channel: object; +``` + +Defined in: [src/types/actions/interactive-message.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L47) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/actions/interactive-message.ts:65](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L65) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_app\_unfurl? + +```ts +optional is_app_unfurl?: boolean; +``` + +Defined in: [src/types/actions/interactive-message.ts:56](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L56) + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/actions/interactive-message.ts:64](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L64) + +*** + +### message\_ts? + +```ts +optional message_ts?: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:59](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L59) + +*** + +### original\_message? + +```ts +optional original_message?: object; +``` + +Defined in: [src/types/actions/interactive-message.ts:61](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L61) + +#### Index Signature + +```ts +[key: string]: string +``` + +*** + +### response\_url + +```ts +response_url: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:54](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L54) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/actions/interactive-message.ts:36](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L36) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:53](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L53) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:55](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L55) + +*** + +### type + +```ts +type: "interactive_message"; +``` + +Defined in: [src/types/actions/interactive-message.ts:33](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L33) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/actions/interactive-message.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L42) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` diff --git a/docs/english/reference/interfaces/InteractiveMessageSuggestion.md b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md new file mode 100644 index 000000000..b9ac2bbcd --- /dev/null +++ b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md @@ -0,0 +1,196 @@ +[@slack/bolt](../index.md) / InteractiveMessageSuggestion + +# Interface: InteractiveMessageSuggestion + +Defined in: [src/types/options/index.ts:82](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L82) + +external data source in attachments + +## Extends + +- [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Indexable + +```ts +[key: string]: any +``` + +## Properties + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/options/index.ts:87](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L87) + +*** + +### attachment\_id + +```ts +attachment_id: string; +``` + +Defined in: [src/types/options/index.ts:89](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L89) + +*** + +### callback\_id + +```ts +callback_id: string; +``` + +Defined in: [src/types/options/index.ts:86](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L86) + +*** + +### channel? + +```ts +optional channel?: object; +``` + +Defined in: [src/types/options/index.ts:97](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L97) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/options/index.ts:109](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L109) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/options/index.ts:108](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L108) + +*** + +### message\_ts + +```ts +message_ts: string; +``` + +Defined in: [src/types/options/index.ts:88](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L88) + +*** + +### name + +```ts +name: string; +``` + +Defined in: [src/types/options/index.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L84) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/options/index.ts:91](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L91) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/options/index.ts:106](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L106) + +*** + +### type + +```ts +type: "interactive_message"; +``` + +Defined in: [src/types/options/index.ts:83](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L83) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/options/index.ts:101](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L101) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/options/index.ts:85](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L85) diff --git a/docs/english/reference/interfaces/MenuSelect.md b/docs/english/reference/interfaces/MenuSelect.md new file mode 100644 index 000000000..67844cccb --- /dev/null +++ b/docs/english/reference/interfaces/MenuSelect.md @@ -0,0 +1,43 @@ +[@slack/bolt](../index.md) / MenuSelect + +# Interface: MenuSelect + +Defined in: [src/types/actions/interactive-message.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L19) + +A menu selection action from a legacy interactive message. + +## Properties + +### name + +```ts +name: string; +``` + +Defined in: [src/types/actions/interactive-message.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L21) + +*** + +### selected\_options + +```ts +selected_options: object[]; +``` + +Defined in: [src/types/actions/interactive-message.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L22) + +#### value + +```ts +value: string; +``` + +*** + +### type + +```ts +type: "select"; +``` + +Defined in: [src/types/actions/interactive-message.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L20) diff --git a/docs/english/reference/interfaces/MessageOptions.md b/docs/english/reference/interfaces/MessageOptions.md new file mode 100644 index 000000000..1b63b1f2d --- /dev/null +++ b/docs/english/reference/interfaces/MessageOptions.md @@ -0,0 +1,15 @@ +[@slack/bolt](../index.md) / MessageOptions + +# Interface: MessageOptions + +Defined in: [src/types/options/index.ts:163](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L163) + +## Properties + +### options + +```ts +options: Option[]; +``` + +Defined in: [src/types/options/index.ts:164](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L164) diff --git a/docs/english/reference/interfaces/MessageShortcut.md b/docs/english/reference/interfaces/MessageShortcut.md new file mode 100644 index 000000000..93b2e3e0c --- /dev/null +++ b/docs/english/reference/interfaces/MessageShortcut.md @@ -0,0 +1,224 @@ +[@slack/bolt](../index.md) / MessageShortcut + +# Interface: MessageShortcut + +Defined in: [src/types/shortcuts/message-shortcut.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L7) + +A Slack message action wrapped in the standard metadata. + +This describes the entire JSON-encoded body of a request from Slack message actions. + +## Properties + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:39](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L39) + +*** + +### callback\_id + +```ts +callback_id: string; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:9](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L9) + +*** + +### channel + +```ts +channel: object; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L28) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L43) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L42) + +*** + +### message + +```ts +message: object; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:14](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L14) + +#### Index Signature + +```ts +[key: string]: any +``` + +#### text? + +```ts +optional text?: string; +``` + +#### ts + +```ts +ts: string; +``` + +#### type + +```ts +type: "message"; +``` + +#### user? + +```ts +optional user?: string; +``` + +*** + +### message\_ts + +```ts +message_ts: string; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L11) + +*** + +### response\_url + +```ts +response_url: string; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:12](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L12) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L32) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:38](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L38) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L10) + +*** + +### type + +```ts +type: "message_action"; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L8) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/shortcuts/message-shortcut.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L22) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` + +#### username? + +```ts +optional username?: string; +``` diff --git a/docs/english/reference/interfaces/MultiChannelsSelectAction.md b/docs/english/reference/interfaces/MultiChannelsSelectAction.md new file mode 100644 index 000000000..ff4b6d3a6 --- /dev/null +++ b/docs/english/reference/interfaces/MultiChannelsSelectAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / MultiChannelsSelectAction + +# Interface: MultiChannelsSelectAction + +Defined in: [src/types/actions/block-action.ts:152](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L152) + +An action from a multi select menu with channels list + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"multi_channels_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:156](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L156) + +*** + +### initial\_channels? + +```ts +optional initial_channels?: string[]; +``` + +Defined in: [src/types/actions/block-action.ts:154](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L154) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:155](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L155) + +*** + +### selected\_channels + +```ts +selected_channels: string[]; +``` + +Defined in: [src/types/actions/block-action.ts:153](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L153) + +*** + +### type + +```ts +type: "multi_channels_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/MultiConversationsSelectAction.md b/docs/english/reference/interfaces/MultiConversationsSelectAction.md new file mode 100644 index 000000000..6132aa893 --- /dev/null +++ b/docs/english/reference/interfaces/MultiConversationsSelectAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / MultiConversationsSelectAction + +# Interface: MultiConversationsSelectAction + +Defined in: [src/types/actions/block-action.ts:132](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L132) + +An action from a multi select menu with conversations list + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"multi_conversations_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:136](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L136) + +*** + +### initial\_conversations? + +```ts +optional initial_conversations?: string[]; +``` + +Defined in: [src/types/actions/block-action.ts:134](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L134) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:135](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L135) + +*** + +### selected\_conversations + +```ts +selected_conversations: string[]; +``` + +Defined in: [src/types/actions/block-action.ts:133](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L133) + +*** + +### type + +```ts +type: "multi_conversations_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/MultiExternalSelectAction.md b/docs/english/reference/interfaces/MultiExternalSelectAction.md new file mode 100644 index 000000000..a3657ad50 --- /dev/null +++ b/docs/english/reference/interfaces/MultiExternalSelectAction.md @@ -0,0 +1,117 @@ +[@slack/bolt](../index.md) / MultiExternalSelectAction + +# Interface: MultiExternalSelectAction + +Defined in: [src/types/actions/block-action.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L173) + +An action from a multi select menu with external data source + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"multi_external_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:178](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L178) + +*** + +### initial\_options? + +```ts +optional initial_options?: Option[]; +``` + +Defined in: [src/types/actions/block-action.ts:175](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L175) + +*** + +### min\_query\_length? + +```ts +optional min_query_length?: number; +``` + +Defined in: [src/types/actions/block-action.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L177) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:176](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L176) + +*** + +### selected\_options? + +```ts +optional selected_options?: Option[]; +``` + +Defined in: [src/types/actions/block-action.ts:174](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L174) + +*** + +### type + +```ts +type: "multi_external_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/MultiStaticSelectAction.md b/docs/english/reference/interfaces/MultiStaticSelectAction.md new file mode 100644 index 000000000..9d071f2d0 --- /dev/null +++ b/docs/english/reference/interfaces/MultiStaticSelectAction.md @@ -0,0 +1,119 @@ +[@slack/bolt](../index.md) / MultiStaticSelectAction + +# Interface: MultiStaticSelectAction + +Defined in: [src/types/actions/block-action.ts:89](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L89) + +An action from a multi select menu with static options + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"multi_static_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L96) + +*** + +### initial\_options? + +```ts +optional initial_options?: Option[]; +``` + +Defined in: [src/types/actions/block-action.ts:94](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L94) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:95](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L95) + +*** + +### selected\_options + +```ts +selected_options: object[]; +``` + +Defined in: [src/types/actions/block-action.ts:90](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L90) + +#### text + +```ts +text: PlainTextElement; +``` + +#### value + +```ts +value: string; +``` + +*** + +### type + +```ts +type: "multi_static_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/MultiUsersSelectAction.md b/docs/english/reference/interfaces/MultiUsersSelectAction.md new file mode 100644 index 000000000..e796f3f01 --- /dev/null +++ b/docs/english/reference/interfaces/MultiUsersSelectAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / MultiUsersSelectAction + +# Interface: MultiUsersSelectAction + +Defined in: [src/types/actions/block-action.ts:112](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L112) + +An action from a multi select menu with user list + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"multi_users_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:116](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L116) + +*** + +### initial\_users? + +```ts +optional initial_users?: string[]; +``` + +Defined in: [src/types/actions/block-action.ts:114](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L114) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:115](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L115) + +*** + +### selected\_users + +```ts +selected_users: string[]; +``` + +Defined in: [src/types/actions/block-action.ts:113](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L113) + +*** + +### type + +```ts +type: "multi_users_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/OptionGroups.md b/docs/english/reference/interfaces/OptionGroups.md new file mode 100644 index 000000000..bf4480ff8 --- /dev/null +++ b/docs/english/reference/interfaces/OptionGroups.md @@ -0,0 +1,21 @@ +[@slack/bolt](../index.md) / OptionGroups + +# Interface: OptionGroups\ + +Defined in: [src/types/options/index.ts:172](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L172) + +## Type Parameters + +### Options + +`Options` + +## Properties + +### option\_groups + +```ts +option_groups: object & Options[]; +``` + +Defined in: [src/types/options/index.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L173) diff --git a/docs/english/reference/interfaces/OptionsConstraints.md b/docs/english/reference/interfaces/OptionsConstraints.md new file mode 100644 index 000000000..0d22b67a6 --- /dev/null +++ b/docs/english/reference/interfaces/OptionsConstraints.md @@ -0,0 +1,53 @@ +[@slack/bolt](../index.md) / OptionsConstraints + +# Interface: OptionsConstraints\ + +Defined in: [src/types/options/index.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L18) + +## Type Parameters + +### A + +`A` *extends* [`SlackOptions`](../type-aliases/SlackOptions.md) = [`SlackOptions`](../type-aliases/SlackOptions.md) + +## Properties + +### action\_id? + +```ts +optional action_id?: A extends SlackOptions ? string | RegExp : never; +``` + +Defined in: [src/types/options/index.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L21) + +*** + +### block\_id? + +```ts +optional block_id?: A extends SlackOptions ? string | RegExp : never; +``` + +Defined in: [src/types/options/index.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L20) + +*** + +### callback\_id? + +```ts +optional callback_id?: Extract extends any ? string | RegExp : never; +``` + +Defined in: [src/types/options/index.ts:23](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L23) + +*** + +### type? + +```ts +optional type?: A["type"]; +``` + +Defined in: [src/types/options/index.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L19) diff --git a/docs/english/reference/interfaces/OverflowAction.md b/docs/english/reference/interfaces/OverflowAction.md new file mode 100644 index 000000000..691965021 --- /dev/null +++ b/docs/english/reference/interfaces/OverflowAction.md @@ -0,0 +1,99 @@ +[@slack/bolt](../index.md) / OverflowAction + +# Interface: OverflowAction + +Defined in: [src/types/actions/block-action.ts:184](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L184) + +An action from an overflow menu element + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"overflow"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:189](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L189) + +*** + +### selected\_option + +```ts +selected_option: object; +``` + +Defined in: [src/types/actions/block-action.ts:185](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L185) + +#### text + +```ts +text: PlainTextElement; +``` + +#### value + +```ts +value: string; +``` + +*** + +### type + +```ts +type: "overflow"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/PlainTextInputAction.md b/docs/english/reference/interfaces/PlainTextInputAction.md new file mode 100644 index 000000000..57397354a --- /dev/null +++ b/docs/english/reference/interfaces/PlainTextInputAction.md @@ -0,0 +1,77 @@ +[@slack/bolt](../index.md) / PlainTextInputAction + +# Interface: PlainTextInputAction + +Defined in: [src/types/actions/block-action.ts:233](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L233) + +An action from a plain_text_input element (must use dispatch_action: true) + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"plain_text_input"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### type + +```ts +type: "plain_text_input"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/actions/block-action.ts:234](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L234) diff --git a/docs/english/reference/interfaces/RadioButtonsAction.md b/docs/english/reference/interfaces/RadioButtonsAction.md new file mode 100644 index 000000000..a497e6515 --- /dev/null +++ b/docs/english/reference/interfaces/RadioButtonsAction.md @@ -0,0 +1,97 @@ +[@slack/bolt](../index.md) / RadioButtonsAction + +# Interface: RadioButtonsAction + +Defined in: [src/types/actions/block-action.ts:215](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L215) + +An action from a radio button element + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"radio_buttons"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:218](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L218) + +*** + +### initial\_option? + +```ts +optional initial_option?: Option; +``` + +Defined in: [src/types/actions/block-action.ts:217](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L217) + +*** + +### selected\_option + +```ts +selected_option: Option | null; +``` + +Defined in: [src/types/actions/block-action.ts:216](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L216) + +*** + +### type + +```ts +type: "radio_buttons"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/Receiver.md b/docs/english/reference/interfaces/Receiver.md new file mode 100644 index 000000000..9bc6604c6 --- /dev/null +++ b/docs/english/reference/interfaces/Receiver.md @@ -0,0 +1,65 @@ +[@slack/bolt](../index.md) / Receiver + +# Interface: Receiver + +Defined in: [src/types/receiver.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L26) + +## Methods + +### init() + +```ts +init(app): void; +``` + +Defined in: [src/types/receiver.ts:27](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L27) + +#### Parameters + +##### app + +[`App`](../classes/App.md) + +#### Returns + +`void` + +*** + +### start() + +```ts +start(...args): Promise; +``` + +Defined in: [src/types/receiver.ts:29](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L29) + +#### Parameters + +##### args + +...`any`[] + +#### Returns + +`Promise`\<`unknown`\> + +*** + +### stop() + +```ts +stop(...args): Promise; +``` + +Defined in: [src/types/receiver.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L31) + +#### Parameters + +##### args + +...`any`[] + +#### Returns + +`Promise`\<`unknown`\> diff --git a/docs/english/reference/interfaces/ReceiverEvent.md b/docs/english/reference/interfaces/ReceiverEvent.md new file mode 100644 index 000000000..2ff63db8c --- /dev/null +++ b/docs/english/reference/interfaces/ReceiverEvent.md @@ -0,0 +1,55 @@ +[@slack/bolt](../index.md) / ReceiverEvent + +# Interface: ReceiverEvent + +Defined in: [src/types/receiver.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L5) + +## Properties + +### ack + +```ts +ack: AckFn; +``` + +Defined in: [src/types/receiver.ts:23](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L23) + +*** + +### body + +```ts +body: StringIndexed; +``` + +Defined in: [src/types/receiver.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L7) + +*** + +### customProperties? + +```ts +optional customProperties?: StringIndexed; +``` + +Defined in: [src/types/receiver.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L18) + +*** + +### retryNum? + +```ts +optional retryNum?: number; +``` + +Defined in: [src/types/receiver.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L11) + +*** + +### retryReason? + +```ts +optional retryReason?: string; +``` + +Defined in: [src/types/receiver.ts:15](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L15) diff --git a/docs/english/reference/interfaces/ReceiverRoutes.md b/docs/english/reference/interfaces/ReceiverRoutes.md new file mode 100644 index 000000000..3f1938231 --- /dev/null +++ b/docs/english/reference/interfaces/ReceiverRoutes.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / ReceiverRoutes + +# Interface: ReceiverRoutes + +Defined in: [src/receivers/custom-routes.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L11) + +## Indexable + +```ts +[url: string]: object +``` diff --git a/docs/english/reference/interfaces/ResponseAck.md b/docs/english/reference/interfaces/ResponseAck.md new file mode 100644 index 000000000..fd30f6f60 --- /dev/null +++ b/docs/english/reference/interfaces/ResponseAck.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / ResponseAck + +# Interface: ResponseAck + +Defined in: [src/types/receiver.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L34) + +## Methods + +### bind() + +```ts +bind(): AckFn; +``` + +Defined in: [src/types/receiver.ts:37](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L37) + +#### Returns + +[`AckFn`](../type-aliases/AckFn.md)\<`any`\> diff --git a/docs/english/reference/interfaces/RichTextInputAction.md b/docs/english/reference/interfaces/RichTextInputAction.md new file mode 100644 index 000000000..6335855cc --- /dev/null +++ b/docs/english/reference/interfaces/RichTextInputAction.md @@ -0,0 +1,77 @@ +[@slack/bolt](../index.md) / RichTextInputAction + +# Interface: RichTextInputAction + +Defined in: [src/types/actions/block-action.ts:240](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L240) + +An action from a rich_text_input element (must use dispatch_action: true) + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"rich_text_input"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### rich\_text\_value + +```ts +rich_text_value: RichTextBlock; +``` + +Defined in: [src/types/actions/block-action.ts:241](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L241) + +*** + +### type + +```ts +type: "rich_text_input"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/ShortcutConstraints.md b/docs/english/reference/interfaces/ShortcutConstraints.md new file mode 100644 index 000000000..cc1ded0a9 --- /dev/null +++ b/docs/english/reference/interfaces/ShortcutConstraints.md @@ -0,0 +1,31 @@ +[@slack/bolt](../index.md) / ShortcutConstraints + +# Interface: ShortcutConstraints\ + +Defined in: [src/types/shortcuts/index.ts:14](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/index.ts#L14) + +## Type Parameters + +### S + +`S` *extends* [`SlackShortcut`](../type-aliases/SlackShortcut.md) = [`SlackShortcut`](../type-aliases/SlackShortcut.md) + +## Properties + +### callback\_id? + +```ts +optional callback_id?: string | RegExp; +``` + +Defined in: [src/types/shortcuts/index.ts:16](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/index.ts#L16) + +*** + +### type? + +```ts +optional type?: S["type"]; +``` + +Defined in: [src/types/shortcuts/index.ts:15](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/index.ts#L15) diff --git a/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md new file mode 100644 index 000000000..ca8cba160 --- /dev/null +++ b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md @@ -0,0 +1,67 @@ +[@slack/bolt](../index.md) / SlackCommandMiddlewareArgs + +# Interface: SlackCommandMiddlewareArgs + +Defined in: [src/types/command/index.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L6) + +Arguments which listeners and middleware receive to process a slash command from Slack. + +## Properties + +### ack + +```ts +ack: AckFn; +``` + +Defined in: [src/types/command/index.ts:12](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L12) + +*** + +### body + +```ts +body: SlashCommand; +``` + +Defined in: [src/types/command/index.ts:9](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L9) + +*** + +### command + +```ts +command: SlashCommand; +``` + +Defined in: [src/types/command/index.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L8) + +*** + +### payload + +```ts +payload: SlashCommand; +``` + +Defined in: [src/types/command/index.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L7) + +*** + +### respond + +```ts +respond: RespondFn; +``` + +Defined in: [src/types/command/index.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L11) + +*** + +### say + +```ts +say: SayFn; +``` + +Defined in: [src/types/command/index.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L10) diff --git a/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md new file mode 100644 index 000000000..eb94ca8c4 --- /dev/null +++ b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md @@ -0,0 +1,53 @@ +[@slack/bolt](../index.md) / SlackOptionsMiddlewareArgs + +# Interface: SlackOptionsMiddlewareArgs\ + +Defined in: [src/types/options/index.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L8) + +Arguments which listeners and middleware receive to process an options request from Slack + +## Type Parameters + +### Source + +`Source` *extends* [`OptionsSource`](../type-aliases/OptionsSource.md) = [`OptionsSource`](../type-aliases/OptionsSource.md) + +## Properties + +### ack + +```ts +ack: OptionsAckFn; +``` + +Defined in: [src/types/options/index.ts:12](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L12) + +*** + +### body + +```ts +body: OptionsPayloadFromType; +``` + +Defined in: [src/types/options/index.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L10) + +*** + +### options + +```ts +options: OptionsPayloadFromType; +``` + +Defined in: [src/types/options/index.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L11) + +*** + +### payload + +```ts +payload: OptionsPayloadFromType; +``` + +Defined in: [src/types/options/index.ts:9](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L9) diff --git a/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md new file mode 100644 index 000000000..6b3827820 --- /dev/null +++ b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md @@ -0,0 +1,63 @@ +[@slack/bolt](../index.md) / SlackViewMiddlewareArgs + +# Interface: SlackViewMiddlewareArgs\ + +Defined in: [src/types/view/index.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L19) + +Arguments which listeners and middleware receive to process a view submission event from Slack. + +## Type Parameters + +### ViewActionType + +`ViewActionType` *extends* [`SlackViewAction`](../type-aliases/SlackViewAction.md) = [`SlackViewAction`](../type-aliases/SlackViewAction.md) + +## Properties + +### ack + +```ts +ack: ViewAckFn; +``` + +Defined in: [src/types/view/index.ts:23](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L23) + +*** + +### body + +```ts +body: ViewActionType; +``` + +Defined in: [src/types/view/index.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L22) + +*** + +### payload + +```ts +payload: ViewOutput; +``` + +Defined in: [src/types/view/index.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L20) + +*** + +### respond + +```ts +respond: RespondFn; +``` + +Defined in: [src/types/view/index.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L24) + +*** + +### view + +```ts +view: ViewOutput; +``` + +Defined in: [src/types/view/index.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L21) diff --git a/docs/english/reference/interfaces/SlashCommand.md b/docs/english/reference/interfaces/SlashCommand.md new file mode 100644 index 000000000..f01c207cd --- /dev/null +++ b/docs/english/reference/interfaces/SlashCommand.md @@ -0,0 +1,169 @@ +[@slack/bolt](../index.md) / SlashCommand + +# Interface: SlashCommand + +Defined in: [src/types/command/index.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L20) + +A Slack slash command + +This describes the entire URL-encoded body of a request from Slack's slash commands. + +## Extends + +- [`StringIndexed`](../type-aliases/StringIndexed.md) + +## Indexable + +```ts +[key: string]: any +``` + +## Properties + +### api\_app\_id + +```ts +api_app_id: string; +``` + +Defined in: [src/types/command/index.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L32) + +*** + +### channel\_id + +```ts +channel_id: string; +``` + +Defined in: [src/types/command/index.ts:30](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L30) + +*** + +### channel\_name + +```ts +channel_name: string; +``` + +Defined in: [src/types/command/index.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L31) + +*** + +### command + +```ts +command: string; +``` + +Defined in: [src/types/command/index.ts:22](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L22) + +*** + +### enterprise\_id? + +```ts +optional enterprise_id?: string; +``` + +Defined in: [src/types/command/index.ts:33](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L33) + +*** + +### enterprise\_name? + +```ts +optional enterprise_name?: string; +``` + +Defined in: [src/types/command/index.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L34) + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: string; +``` + +Defined in: [src/types/command/index.ts:36](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L36) + +*** + +### response\_url + +```ts +response_url: string; +``` + +Defined in: [src/types/command/index.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L24) + +*** + +### team\_domain + +```ts +team_domain: string; +``` + +Defined in: [src/types/command/index.ts:29](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L29) + +*** + +### team\_id + +```ts +team_id: string; +``` + +Defined in: [src/types/command/index.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L28) + +*** + +### text + +```ts +text: string; +``` + +Defined in: [src/types/command/index.ts:23](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L23) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/command/index.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L21) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: [src/types/command/index.ts:25](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L25) + +*** + +### user\_id + +```ts +user_id: string; +``` + +Defined in: [src/types/command/index.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L26) + +*** + +### user\_name + +```ts +user_name: string; +``` + +Defined in: [src/types/command/index.ts:27](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L27) diff --git a/docs/english/reference/interfaces/SocketModeReceiverOptions.md b/docs/english/reference/interfaces/SocketModeReceiverOptions.md new file mode 100644 index 000000000..50c10f4f6 --- /dev/null +++ b/docs/english/reference/interfaces/SocketModeReceiverOptions.md @@ -0,0 +1,205 @@ +[@slack/bolt](../index.md) / SocketModeReceiverOptions + +# Interface: SocketModeReceiverOptions + +Defined in: [src/receivers/SocketModeReceiver.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L31) + +## Properties + +### appToken + +```ts +appToken: string; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L41) + +*** + +### autoReconnectEnabled? + +```ts +optional autoReconnectEnabled?: boolean; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L47) + +*** + +### clientId? + +```ts +optional clientId?: string; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L34) + +*** + +### clientPingTimeout? + +```ts +optional clientPingTimeout?: number; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:44](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L44) + +*** + +### clientSecret? + +```ts +optional clientSecret?: string; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:35](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L35) + +*** + +### customPropertiesExtractor? + +```ts +optional customPropertiesExtractor?: (args) => StringIndexed; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:49](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L49) + +#### Parameters + +##### args + +`any` + +#### Returns + +[`StringIndexed`](../type-aliases/StringIndexed.md) + +*** + +### customRoutes? + +```ts +optional customRoutes?: CustomRoute[]; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L43) + +*** + +### dispatcher? + +```ts +optional dispatcher?: SocketModeDispatcher; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L42) + +*** + +### installationStore? + +```ts +optional installationStore?: InstallationStore; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:38](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L38) + +*** + +### installerOptions? + +```ts +optional installerOptions?: InstallerOptions; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L40) + +*** + +### logger? + +```ts +optional logger?: Logger; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L32) + +*** + +### logLevel? + +```ts +optional logLevel?: LogLevel; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:33](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L33) + +*** + +### pingPongLoggingEnabled? + +```ts +optional pingPongLoggingEnabled?: boolean; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:46](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L46) + +*** + +### processEventErrorHandler? + +```ts +optional processEventErrorHandler?: (args) => Promise; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:50](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L50) + +#### Parameters + +##### args + +[`SocketModeReceiverProcessEventErrorHandlerArgs`](SocketModeReceiverProcessEventErrorHandlerArgs.md) + +#### Returns + +`Promise`\<`boolean`\> + +*** + +### redirectUri? + +```ts +optional redirectUri?: string; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:37](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L37) + +*** + +### scopes? + +```ts +optional scopes?: string | string[]; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:39](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L39) + +*** + +### serverPingTimeout? + +```ts +optional serverPingTimeout?: number; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:45](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L45) + +*** + +### stateSecret? + +```ts +optional stateSecret?: string; +``` + +Defined in: [src/receivers/SocketModeReceiver.ts:36](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L36) diff --git a/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md new file mode 100644 index 000000000..dc91e485f --- /dev/null +++ b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md @@ -0,0 +1,35 @@ +[@slack/bolt](../index.md) / SocketModeReceiverProcessEventErrorHandlerArgs + +# Interface: SocketModeReceiverProcessEventErrorHandlerArgs + +Defined in: [src/receivers/SocketModeFunctions.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeFunctions.ts#L24) + +## Properties + +### error + +```ts +error: CodedError | Error; +``` + +Defined in: [src/receivers/SocketModeFunctions.ts:25](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeFunctions.ts#L25) + +*** + +### event + +```ts +event: ReceiverEvent; +``` + +Defined in: [src/receivers/SocketModeFunctions.ts:27](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeFunctions.ts#L27) + +*** + +### logger + +```ts +logger: Logger; +``` + +Defined in: [src/receivers/SocketModeFunctions.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeFunctions.ts#L26) diff --git a/docs/english/reference/interfaces/StaticSelectAction.md b/docs/english/reference/interfaces/StaticSelectAction.md new file mode 100644 index 000000000..6e68cb030 --- /dev/null +++ b/docs/english/reference/interfaces/StaticSelectAction.md @@ -0,0 +1,119 @@ +[@slack/bolt](../index.md) / StaticSelectAction + +# Interface: StaticSelectAction + +Defined in: [src/types/actions/block-action.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L76) + +An action from a select menu with static options + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"static_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:83](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L83) + +*** + +### initial\_option? + +```ts +optional initial_option?: Option; +``` + +Defined in: [src/types/actions/block-action.ts:81](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L81) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:82](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L82) + +*** + +### selected\_option + +```ts +selected_option: object; +``` + +Defined in: [src/types/actions/block-action.ts:77](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L77) + +#### text + +```ts +text: PlainTextElement; +``` + +#### value + +```ts +value: string; +``` + +*** + +### type + +```ts +type: "static_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/TimepickerAction.md b/docs/english/reference/interfaces/TimepickerAction.md new file mode 100644 index 000000000..25e5b5afe --- /dev/null +++ b/docs/english/reference/interfaces/TimepickerAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / TimepickerAction + +# Interface: TimepickerAction + +Defined in: [src/types/actions/block-action.ts:205](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L205) + +An action from a time picker element + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"timepicker"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:209](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L209) + +*** + +### initial\_time? + +```ts +optional initial_time?: string; +``` + +Defined in: [src/types/actions/block-action.ts:207](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L207) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:208](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L208) + +*** + +### selected\_time + +```ts +selected_time: string | null; +``` + +Defined in: [src/types/actions/block-action.ts:206](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L206) + +*** + +### type + +```ts +type: "timepicker"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/UploadedFile.md b/docs/english/reference/interfaces/UploadedFile.md new file mode 100644 index 000000000..1df5ebad6 --- /dev/null +++ b/docs/english/reference/interfaces/UploadedFile.md @@ -0,0 +1,1245 @@ +[@slack/bolt](../index.md) / UploadedFile + +# Interface: UploadedFile + +Defined in: [src/types/view/index.ts:109](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L109) + +## Properties + +### access? + +```ts +optional access?: string; +``` + +Defined in: [src/types/view/index.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L123) + +*** + +### alt\_txt? + +```ts +optional alt_txt?: string; +``` + +Defined in: [src/types/view/index.ts:124](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L124) + +*** + +### app\_id? + +```ts +optional app_id?: string; +``` + +Defined in: [src/types/view/index.ts:125](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L125) + +*** + +### app\_name? + +```ts +optional app_name?: string; +``` + +Defined in: [src/types/view/index.ts:126](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L126) + +*** + +### bot\_id? + +```ts +optional bot_id?: string; +``` + +Defined in: [src/types/view/index.ts:127](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L127) + +*** + +### channel\_actions\_count? + +```ts +optional channel_actions_count?: number; +``` + +Defined in: [src/types/view/index.ts:128](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L128) + +*** + +### channel\_actions\_ts? + +```ts +optional channel_actions_ts?: string; +``` + +Defined in: [src/types/view/index.ts:129](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L129) + +*** + +### channels? + +```ts +optional channels?: string[]; +``` + +Defined in: [src/types/view/index.ts:130](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L130) + +*** + +### comments\_count? + +```ts +optional comments_count?: number; +``` + +Defined in: [src/types/view/index.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L131) + +*** + +### converted\_pdf? + +```ts +optional converted_pdf?: string; +``` + +Defined in: [src/types/view/index.ts:132](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L132) + +*** + +### created + +```ts +created: number; +``` + +Defined in: [src/types/view/index.ts:111](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L111) + +*** + +### deanimate? + +```ts +optional deanimate?: string; +``` + +Defined in: [src/types/view/index.ts:133](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L133) + +*** + +### deanimate\_gif? + +```ts +optional deanimate_gif?: string; +``` + +Defined in: [src/types/view/index.ts:134](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L134) + +*** + +### display\_as\_bot? + +```ts +optional display_as_bot?: boolean; +``` + +Defined in: [src/types/view/index.ts:135](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L135) + +*** + +### duration\_ms? + +```ts +optional duration_ms?: number; +``` + +Defined in: [src/types/view/index.ts:136](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L136) + +*** + +### edit\_link? + +```ts +optional edit_link?: string; +``` + +Defined in: [src/types/view/index.ts:137](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L137) + +*** + +### editable? + +```ts +optional editable?: boolean; +``` + +Defined in: [src/types/view/index.ts:138](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L138) + +*** + +### editor? + +```ts +optional editor?: string; +``` + +Defined in: [src/types/view/index.ts:139](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L139) + +*** + +### external\_id? + +```ts +optional external_id?: string; +``` + +Defined in: [src/types/view/index.ts:140](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L140) + +*** + +### external\_type? + +```ts +optional external_type?: string; +``` + +Defined in: [src/types/view/index.ts:141](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L141) + +*** + +### external\_url? + +```ts +optional external_url?: string; +``` + +Defined in: [src/types/view/index.ts:142](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L142) + +*** + +### file\_access? + +```ts +optional file_access?: string; +``` + +Defined in: [src/types/view/index.ts:143](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L143) + +*** + +### filetype + +```ts +filetype: string; +``` + +Defined in: [src/types/view/index.ts:115](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L115) + +*** + +### groups? + +```ts +optional groups?: string[]; +``` + +Defined in: [src/types/view/index.ts:144](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L144) + +*** + +### has\_more? + +```ts +optional has_more?: boolean; +``` + +Defined in: [src/types/view/index.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L145) + +*** + +### has\_more\_shares? + +```ts +optional has_more_shares?: boolean; +``` + +Defined in: [src/types/view/index.ts:146](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L146) + +*** + +### has\_rich\_preview? + +```ts +optional has_rich_preview?: boolean; +``` + +Defined in: [src/types/view/index.ts:147](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L147) + +*** + +### hls? + +```ts +optional hls?: string; +``` + +Defined in: [src/types/view/index.ts:148](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L148) + +*** + +### hls\_embed? + +```ts +optional hls_embed?: string; +``` + +Defined in: [src/types/view/index.ts:149](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L149) + +*** + +### id + +```ts +id: string; +``` + +Defined in: [src/types/view/index.ts:110](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L110) + +*** + +### image\_exif\_rotation? + +```ts +optional image_exif_rotation?: number; +``` + +Defined in: [src/types/view/index.ts:150](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L150) + +*** + +### ims? + +```ts +optional ims?: string[]; +``` + +Defined in: [src/types/view/index.ts:151](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L151) + +*** + +### is\_channel\_space? + +```ts +optional is_channel_space?: boolean; +``` + +Defined in: [src/types/view/index.ts:152](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L152) + +*** + +### is\_external? + +```ts +optional is_external?: boolean; +``` + +Defined in: [src/types/view/index.ts:153](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L153) + +*** + +### is\_public? + +```ts +optional is_public?: boolean; +``` + +Defined in: [src/types/view/index.ts:154](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L154) + +*** + +### is\_starred? + +```ts +optional is_starred?: boolean; +``` + +Defined in: [src/types/view/index.ts:155](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L155) + +*** + +### last\_editor? + +```ts +optional last_editor?: string; +``` + +Defined in: [src/types/view/index.ts:156](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L156) + +*** + +### last\_read? + +```ts +optional last_read?: number; +``` + +Defined in: [src/types/view/index.ts:157](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L157) + +*** + +### lines? + +```ts +optional lines?: number; +``` + +Defined in: [src/types/view/index.ts:158](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L158) + +*** + +### lines\_more? + +```ts +optional lines_more?: number; +``` + +Defined in: [src/types/view/index.ts:159](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L159) + +*** + +### linked\_channel\_id? + +```ts +optional linked_channel_id?: string; +``` + +Defined in: [src/types/view/index.ts:160](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L160) + +*** + +### media\_display\_type? + +```ts +optional media_display_type?: string; +``` + +Defined in: [src/types/view/index.ts:161](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L161) + +*** + +### mimetype + +```ts +mimetype: string; +``` + +Defined in: [src/types/view/index.ts:116](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L116) + +*** + +### mode? + +```ts +optional mode?: string; +``` + +Defined in: [src/types/view/index.ts:162](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L162) + +*** + +### mp4? + +```ts +optional mp4?: string; +``` + +Defined in: [src/types/view/index.ts:163](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L163) + +*** + +### mp4\_low? + +```ts +optional mp4_low?: string; +``` + +Defined in: [src/types/view/index.ts:164](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L164) + +*** + +### name + +```ts +name: string; +``` + +Defined in: [src/types/view/index.ts:113](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L113) + +*** + +### non\_owner\_editable? + +```ts +optional non_owner_editable?: boolean; +``` + +Defined in: [src/types/view/index.ts:165](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L165) + +*** + +### num\_stars? + +```ts +optional num_stars?: number; +``` + +Defined in: [src/types/view/index.ts:166](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L166) + +*** + +### org\_or\_workspace\_access? + +```ts +optional org_or_workspace_access?: string; +``` + +Defined in: [src/types/view/index.ts:167](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L167) + +*** + +### original\_attachment\_count? + +```ts +optional original_attachment_count?: number; +``` + +Defined in: [src/types/view/index.ts:168](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L168) + +*** + +### original\_h? + +```ts +optional original_h?: string; +``` + +Defined in: [src/types/view/index.ts:169](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L169) + +*** + +### original\_w? + +```ts +optional original_w?: string; +``` + +Defined in: [src/types/view/index.ts:170](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L170) + +*** + +### permalink + +```ts +permalink: string; +``` + +Defined in: [src/types/view/index.ts:117](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L117) + +*** + +### permalink\_public? + +```ts +optional permalink_public?: string; +``` + +Defined in: [src/types/view/index.ts:171](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L171) + +*** + +### pinned\_to? + +```ts +optional pinned_to?: string[]; +``` + +Defined in: [src/types/view/index.ts:172](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L172) + +*** + +### pjpeg? + +```ts +optional pjpeg?: string; +``` + +Defined in: [src/types/view/index.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L173) + +*** + +### plain\_text? + +```ts +optional plain_text?: string; +``` + +Defined in: [src/types/view/index.ts:174](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L174) + +*** + +### pretty\_type? + +```ts +optional pretty_type?: string; +``` + +Defined in: [src/types/view/index.ts:175](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L175) + +*** + +### preview? + +```ts +optional preview?: string; +``` + +Defined in: [src/types/view/index.ts:176](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L176) + +*** + +### preview\_highlight? + +```ts +optional preview_highlight?: string; +``` + +Defined in: [src/types/view/index.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L177) + +*** + +### preview\_is\_truncated? + +```ts +optional preview_is_truncated?: boolean; +``` + +Defined in: [src/types/view/index.ts:178](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L178) + +*** + +### preview\_plain\_text? + +```ts +optional preview_plain_text?: string; +``` + +Defined in: [src/types/view/index.ts:179](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L179) + +*** + +### private\_channels\_with\_file\_access\_count? + +```ts +optional private_channels_with_file_access_count?: number; +``` + +Defined in: [src/types/view/index.ts:180](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L180) + +*** + +### public\_url\_shared? + +```ts +optional public_url_shared?: boolean; +``` + +Defined in: [src/types/view/index.ts:181](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L181) + +*** + +### simplified\_html? + +```ts +optional simplified_html?: string; +``` + +Defined in: [src/types/view/index.ts:182](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L182) + +*** + +### size? + +```ts +optional size?: number; +``` + +Defined in: [src/types/view/index.ts:183](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L183) + +*** + +### source\_team? + +```ts +optional source_team?: string; +``` + +Defined in: [src/types/view/index.ts:184](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L184) + +*** + +### subject? + +```ts +optional subject?: string; +``` + +Defined in: [src/types/view/index.ts:185](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L185) + +*** + +### subtype? + +```ts +optional subtype?: string; +``` + +Defined in: [src/types/view/index.ts:186](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L186) + +*** + +### thumb\_1024? + +```ts +optional thumb_1024?: string; +``` + +Defined in: [src/types/view/index.ts:187](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L187) + +*** + +### thumb\_1024\_gif? + +```ts +optional thumb_1024_gif?: string; +``` + +Defined in: [src/types/view/index.ts:188](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L188) + +*** + +### thumb\_1024\_h? + +```ts +optional thumb_1024_h?: string; +``` + +Defined in: [src/types/view/index.ts:189](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L189) + +*** + +### thumb\_1024\_w? + +```ts +optional thumb_1024_w?: string; +``` + +Defined in: [src/types/view/index.ts:190](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L190) + +*** + +### thumb\_160? + +```ts +optional thumb_160?: string; +``` + +Defined in: [src/types/view/index.ts:191](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L191) + +*** + +### thumb\_160\_gif? + +```ts +optional thumb_160_gif?: string; +``` + +Defined in: [src/types/view/index.ts:192](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L192) + +*** + +### thumb\_160\_h? + +```ts +optional thumb_160_h?: string; +``` + +Defined in: [src/types/view/index.ts:193](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L193) + +*** + +### thumb\_160\_w? + +```ts +optional thumb_160_w?: string; +``` + +Defined in: [src/types/view/index.ts:194](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L194) + +*** + +### thumb\_360? + +```ts +optional thumb_360?: string; +``` + +Defined in: [src/types/view/index.ts:195](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L195) + +*** + +### thumb\_360\_gif? + +```ts +optional thumb_360_gif?: string; +``` + +Defined in: [src/types/view/index.ts:196](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L196) + +*** + +### thumb\_360\_h? + +```ts +optional thumb_360_h?: string; +``` + +Defined in: [src/types/view/index.ts:197](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L197) + +*** + +### thumb\_360\_w? + +```ts +optional thumb_360_w?: string; +``` + +Defined in: [src/types/view/index.ts:198](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L198) + +*** + +### thumb\_480? + +```ts +optional thumb_480?: string; +``` + +Defined in: [src/types/view/index.ts:199](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L199) + +*** + +### thumb\_480\_gif? + +```ts +optional thumb_480_gif?: string; +``` + +Defined in: [src/types/view/index.ts:200](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L200) + +*** + +### thumb\_480\_h? + +```ts +optional thumb_480_h?: string; +``` + +Defined in: [src/types/view/index.ts:201](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L201) + +*** + +### thumb\_480\_w? + +```ts +optional thumb_480_w?: string; +``` + +Defined in: [src/types/view/index.ts:202](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L202) + +*** + +### thumb\_64? + +```ts +optional thumb_64?: string; +``` + +Defined in: [src/types/view/index.ts:203](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L203) + +*** + +### thumb\_64\_gif? + +```ts +optional thumb_64_gif?: string; +``` + +Defined in: [src/types/view/index.ts:204](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L204) + +*** + +### thumb\_64\_h? + +```ts +optional thumb_64_h?: string; +``` + +Defined in: [src/types/view/index.ts:205](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L205) + +*** + +### thumb\_64\_w? + +```ts +optional thumb_64_w?: string; +``` + +Defined in: [src/types/view/index.ts:206](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L206) + +*** + +### thumb\_720? + +```ts +optional thumb_720?: string; +``` + +Defined in: [src/types/view/index.ts:207](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L207) + +*** + +### thumb\_720\_gif? + +```ts +optional thumb_720_gif?: string; +``` + +Defined in: [src/types/view/index.ts:208](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L208) + +*** + +### thumb\_720\_h? + +```ts +optional thumb_720_h?: string; +``` + +Defined in: [src/types/view/index.ts:209](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L209) + +*** + +### thumb\_720\_w? + +```ts +optional thumb_720_w?: string; +``` + +Defined in: [src/types/view/index.ts:210](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L210) + +*** + +### thumb\_80? + +```ts +optional thumb_80?: string; +``` + +Defined in: [src/types/view/index.ts:211](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L211) + +*** + +### thumb\_80\_gif? + +```ts +optional thumb_80_gif?: string; +``` + +Defined in: [src/types/view/index.ts:216](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L216) + +*** + +### thumb\_80\_h? + +```ts +optional thumb_80_h?: string; +``` + +Defined in: [src/types/view/index.ts:217](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L217) + +*** + +### thumb\_80\_w? + +```ts +optional thumb_80_w?: string; +``` + +Defined in: [src/types/view/index.ts:218](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L218) + +*** + +### thumb\_800? + +```ts +optional thumb_800?: string; +``` + +Defined in: [src/types/view/index.ts:212](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L212) + +*** + +### thumb\_800\_gif? + +```ts +optional thumb_800_gif?: string; +``` + +Defined in: [src/types/view/index.ts:213](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L213) + +*** + +### thumb\_800\_h? + +```ts +optional thumb_800_h?: string; +``` + +Defined in: [src/types/view/index.ts:214](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L214) + +*** + +### thumb\_800\_w? + +```ts +optional thumb_800_w?: string; +``` + +Defined in: [src/types/view/index.ts:215](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L215) + +*** + +### thumb\_960? + +```ts +optional thumb_960?: string; +``` + +Defined in: [src/types/view/index.ts:219](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L219) + +*** + +### thumb\_960\_gif? + +```ts +optional thumb_960_gif?: string; +``` + +Defined in: [src/types/view/index.ts:220](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L220) + +*** + +### thumb\_960\_h? + +```ts +optional thumb_960_h?: string; +``` + +Defined in: [src/types/view/index.ts:221](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L221) + +*** + +### thumb\_960\_w? + +```ts +optional thumb_960_w?: string; +``` + +Defined in: [src/types/view/index.ts:222](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L222) + +*** + +### thumb\_gif? + +```ts +optional thumb_gif?: string; +``` + +Defined in: [src/types/view/index.ts:223](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L223) + +*** + +### thumb\_pdf? + +```ts +optional thumb_pdf?: string; +``` + +Defined in: [src/types/view/index.ts:224](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L224) + +*** + +### thumb\_pdf\_h? + +```ts +optional thumb_pdf_h?: string; +``` + +Defined in: [src/types/view/index.ts:225](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L225) + +*** + +### thumb\_pdf\_w? + +```ts +optional thumb_pdf_w?: string; +``` + +Defined in: [src/types/view/index.ts:226](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L226) + +*** + +### thumb\_tiny? + +```ts +optional thumb_tiny?: string; +``` + +Defined in: [src/types/view/index.ts:227](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L227) + +*** + +### thumb\_video? + +```ts +optional thumb_video?: string; +``` + +Defined in: [src/types/view/index.ts:228](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L228) + +*** + +### thumb\_video\_h? + +```ts +optional thumb_video_h?: number; +``` + +Defined in: [src/types/view/index.ts:229](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L229) + +*** + +### thumb\_video\_w? + +```ts +optional thumb_video_w?: number; +``` + +Defined in: [src/types/view/index.ts:230](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L230) + +*** + +### timestamp + +```ts +timestamp: number; +``` + +Defined in: [src/types/view/index.ts:112](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L112) + +*** + +### title + +```ts +title: string; +``` + +Defined in: [src/types/view/index.ts:114](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L114) + +*** + +### updated? + +```ts +optional updated?: number; +``` + +Defined in: [src/types/view/index.ts:231](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L231) + +*** + +### url\_private + +```ts +url_private: string; +``` + +Defined in: [src/types/view/index.ts:118](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L118) + +*** + +### url\_private\_download + +```ts +url_private_download: string; +``` + +Defined in: [src/types/view/index.ts:119](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L119) + +*** + +### url\_static\_preview? + +```ts +optional url_static_preview?: string; +``` + +Defined in: [src/types/view/index.ts:232](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L232) + +*** + +### user + +```ts +user: string; +``` + +Defined in: [src/types/view/index.ts:120](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L120) + +*** + +### user\_team + +```ts +user_team: string; +``` + +Defined in: [src/types/view/index.ts:121](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L121) + +*** + +### username? + +```ts +optional username?: string; +``` + +Defined in: [src/types/view/index.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L122) + +*** + +### vtt? + +```ts +optional vtt?: string; +``` + +Defined in: [src/types/view/index.ts:233](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L233) diff --git a/docs/english/reference/interfaces/UsersSelectAction.md b/docs/english/reference/interfaces/UsersSelectAction.md new file mode 100644 index 000000000..184cff797 --- /dev/null +++ b/docs/english/reference/interfaces/UsersSelectAction.md @@ -0,0 +1,107 @@ +[@slack/bolt](../index.md) / UsersSelectAction + +# Interface: UsersSelectAction + +Defined in: [src/types/actions/block-action.ts:102](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L102) + +An action from a select menu with user list + +## Extends + +- [`BasicElementAction`](BasicElementAction.md)\<`"users_select"`\> + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L42) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_id`](BasicElementAction.md#action_id) + +*** + +### action\_ts + +```ts +action_ts: string; +``` + +Defined in: [src/types/actions/block-action.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L43) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`action_ts`](BasicElementAction.md#action_ts) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/actions/block-action.ts:41](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L41) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`block_id`](BasicElementAction.md#block_id) + +*** + +### confirm? + +```ts +optional confirm?: Confirmation; +``` + +Defined in: [src/types/actions/block-action.ts:106](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L106) + +*** + +### initial\_user? + +```ts +optional initial_user?: string; +``` + +Defined in: [src/types/actions/block-action.ts:104](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L104) + +*** + +### placeholder? + +```ts +optional placeholder?: PlainTextElement; +``` + +Defined in: [src/types/actions/block-action.ts:105](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L105) + +*** + +### selected\_user + +```ts +selected_user: string; +``` + +Defined in: [src/types/actions/block-action.ts:103](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L103) + +*** + +### type + +```ts +type: "users_select"; +``` + +Defined in: [src/types/actions/block-action.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L40) + +#### Inherited from + +[`BasicElementAction`](BasicElementAction.md).[`type`](BasicElementAction.md#type) diff --git a/docs/english/reference/interfaces/ViewClearResponseAction.md b/docs/english/reference/interfaces/ViewClearResponseAction.md new file mode 100644 index 000000000..31d625211 --- /dev/null +++ b/docs/english/reference/interfaces/ViewClearResponseAction.md @@ -0,0 +1,15 @@ +[@slack/bolt](../index.md) / ViewClearResponseAction + +# Interface: ViewClearResponseAction + +Defined in: [src/types/view/index.ts:298](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L298) + +## Properties + +### response\_action + +```ts +response_action: "clear"; +``` + +Defined in: [src/types/view/index.ts:299](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L299) diff --git a/docs/english/reference/interfaces/ViewClosedAction.md b/docs/english/reference/interfaces/ViewClosedAction.md new file mode 100644 index 000000000..aeb432379 --- /dev/null +++ b/docs/english/reference/interfaces/ViewClosedAction.md @@ -0,0 +1,136 @@ +[@slack/bolt](../index.md) / ViewClosedAction + +# Interface: ViewClosedAction + +Defined in: [src/types/view/index.ts:78](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L78) + +A Slack view_closed event wrapped in the standard metadata. + +This describes the entire JSON-encoded body of a view_closed event. + +## Properties + +### api\_app\_id + +```ts +api_app_id: string; +``` + +Defined in: [src/types/view/index.ts:92](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L92) + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/view/index.ts:97](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L97) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_cleared + +```ts +is_cleared: boolean; +``` + +Defined in: [src/types/view/index.ts:94](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L94) + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/view/index.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L96) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/view/index.ts:80](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L80) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/view/index.ts:93](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L93) + +*** + +### type + +```ts +type: "view_closed"; +``` + +Defined in: [src/types/view/index.ts:79](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L79) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/view/index.ts:86](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L86) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` + +*** + +### view + +```ts +view: ViewOutput; +``` + +Defined in: [src/types/view/index.ts:91](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L91) diff --git a/docs/english/reference/interfaces/ViewConstraints.md b/docs/english/reference/interfaces/ViewConstraints.md new file mode 100644 index 000000000..88eb0543d --- /dev/null +++ b/docs/english/reference/interfaces/ViewConstraints.md @@ -0,0 +1,25 @@ +[@slack/bolt](../index.md) / ViewConstraints + +# Interface: ViewConstraints + +Defined in: [src/types/view/index.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L11) + +## Properties + +### callback\_id? + +```ts +optional callback_id?: string | RegExp; +``` + +Defined in: [src/types/view/index.ts:12](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L12) + +*** + +### type? + +```ts +optional type?: "view_closed" | "view_submission"; +``` + +Defined in: [src/types/view/index.ts:13](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L13) diff --git a/docs/english/reference/interfaces/ViewErrorsResponseAction.md b/docs/english/reference/interfaces/ViewErrorsResponseAction.md new file mode 100644 index 000000000..1f9bdf602 --- /dev/null +++ b/docs/english/reference/interfaces/ViewErrorsResponseAction.md @@ -0,0 +1,31 @@ +[@slack/bolt](../index.md) / ViewErrorsResponseAction + +# Interface: ViewErrorsResponseAction + +Defined in: [src/types/view/index.ts:302](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L302) + +## Properties + +### errors + +```ts +errors: object; +``` + +Defined in: [src/types/view/index.ts:304](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L304) + +#### Index Signature + +```ts +[blockId: string]: string +``` + +*** + +### response\_action + +```ts +response_action: "errors"; +``` + +Defined in: [src/types/view/index.ts:303](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L303) diff --git a/docs/english/reference/interfaces/ViewOutput.md b/docs/english/reference/interfaces/ViewOutput.md new file mode 100644 index 000000000..64b18d82d --- /dev/null +++ b/docs/english/reference/interfaces/ViewOutput.md @@ -0,0 +1,279 @@ +[@slack/bolt](../index.md) / ViewOutput + +# Interface: ViewOutput + +Defined in: [src/types/view/index.ts:254](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L254) + +## Properties + +### app\_id + +```ts +app_id: string | null; +``` + +Defined in: [src/types/view/index.ts:259](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L259) + +*** + +### app\_installed\_team\_id? + +```ts +optional app_installed_team_id?: string; +``` + +Defined in: [src/types/view/index.ts:258](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L258) + +*** + +### app\_unfurl\_url? + +```ts +optional app_unfurl_url?: string; +``` + +Defined in: [src/types/view/index.ts:282](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L282) + +*** + +### blocks + +```ts +blocks: (Block | KnownBlock)[]; +``` + +Defined in: [src/types/view/index.ts:263](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L263) + +*** + +### bot\_id + +```ts +bot_id: string; +``` + +Defined in: [src/types/view/index.ts:260](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L260) + +*** + +### callback\_id + +```ts +callback_id: string; +``` + +Defined in: [src/types/view/index.ts:256](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L256) + +*** + +### channel? + +```ts +optional channel?: string; +``` + +Defined in: [src/types/view/index.ts:285](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L285) + +*** + +### clear\_on\_close + +```ts +clear_on_close: boolean; +``` + +Defined in: [src/types/view/index.ts:277](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L277) + +*** + +### close + +```ts +close: PlainTextElementOutput | null; +``` + +Defined in: [src/types/view/index.ts:264](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L264) + +*** + +### entity\_url? + +```ts +optional entity_url?: string; +``` + +Defined in: [src/types/view/index.ts:280](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L280) + +*** + +### external\_id? + +```ts +optional external_id?: string; +``` + +Defined in: [src/types/view/index.ts:279](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L279) + +*** + +### external\_ref? + +```ts +optional external_ref?: object; +``` + +Defined in: [src/types/view/index.ts:281](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L281) + +#### id + +```ts +id: string; +``` + +#### type? + +```ts +optional type?: string; +``` + +*** + +### hash + +```ts +hash: string; +``` + +Defined in: [src/types/view/index.ts:273](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L273) + +*** + +### id + +```ts +id: string; +``` + +Defined in: [src/types/view/index.ts:255](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L255) + +*** + +### message\_ts? + +```ts +optional message_ts?: string; +``` + +Defined in: [src/types/view/index.ts:283](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L283) + +*** + +### notify\_on\_close + +```ts +notify_on_close: boolean; +``` + +Defined in: [src/types/view/index.ts:278](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L278) + +*** + +### previous\_view\_id + +```ts +previous_view_id: string | null; +``` + +Defined in: [src/types/view/index.ts:276](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L276) + +*** + +### private\_metadata + +```ts +private_metadata: string; +``` + +Defined in: [src/types/view/index.ts:274](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L274) + +*** + +### root\_view\_id + +```ts +root_view_id: string | null; +``` + +Defined in: [src/types/view/index.ts:275](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L275) + +*** + +### state + +```ts +state: object; +``` + +Defined in: [src/types/view/index.ts:266](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L266) + +#### values + +```ts +values: object; +``` + +##### Index Signature + +```ts +[blockId: string]: object +``` + +*** + +### submit + +```ts +submit: PlainTextElementOutput | null; +``` + +Defined in: [src/types/view/index.ts:265](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L265) + +*** + +### team\_id + +```ts +team_id: string; +``` + +Defined in: [src/types/view/index.ts:257](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L257) + +*** + +### thread\_ts? + +```ts +optional thread_ts?: string; +``` + +Defined in: [src/types/view/index.ts:284](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L284) + +*** + +### title + +```ts +title: PlainTextElementOutput; +``` + +Defined in: [src/types/view/index.ts:261](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L261) + +*** + +### type + +```ts +type: string; +``` + +Defined in: [src/types/view/index.ts:262](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L262) diff --git a/docs/english/reference/interfaces/ViewPushResponseAction.md b/docs/english/reference/interfaces/ViewPushResponseAction.md new file mode 100644 index 000000000..a79e758aa --- /dev/null +++ b/docs/english/reference/interfaces/ViewPushResponseAction.md @@ -0,0 +1,25 @@ +[@slack/bolt](../index.md) / ViewPushResponseAction + +# Interface: ViewPushResponseAction + +Defined in: [src/types/view/index.ts:293](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L293) + +## Properties + +### response\_action + +```ts +response_action: "push"; +``` + +Defined in: [src/types/view/index.ts:294](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L294) + +*** + +### view + +```ts +view: View; +``` + +Defined in: [src/types/view/index.ts:295](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L295) diff --git a/docs/english/reference/interfaces/ViewResponseUrl.md b/docs/english/reference/interfaces/ViewResponseUrl.md new file mode 100644 index 000000000..dc975976b --- /dev/null +++ b/docs/english/reference/interfaces/ViewResponseUrl.md @@ -0,0 +1,45 @@ +[@slack/bolt](../index.md) / ViewResponseUrl + +# Interface: ViewResponseUrl + +Defined in: [src/types/view/index.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L34) + +## Properties + +### action\_id + +```ts +action_id: string; +``` + +Defined in: [src/types/view/index.ts:36](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L36) + +*** + +### block\_id + +```ts +block_id: string; +``` + +Defined in: [src/types/view/index.ts:35](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L35) + +*** + +### channel\_id + +```ts +channel_id: string; +``` + +Defined in: [src/types/view/index.ts:37](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L37) + +*** + +### response\_url + +```ts +response_url: string; +``` + +Defined in: [src/types/view/index.ts:38](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L38) diff --git a/docs/english/reference/interfaces/ViewStateSelectedOption.md b/docs/english/reference/interfaces/ViewStateSelectedOption.md new file mode 100644 index 000000000..371a71b6d --- /dev/null +++ b/docs/english/reference/interfaces/ViewStateSelectedOption.md @@ -0,0 +1,25 @@ +[@slack/bolt](../index.md) / ViewStateSelectedOption + +# Interface: ViewStateSelectedOption + +Defined in: [src/types/view/index.ts:103](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L103) + +## Properties + +### text + +```ts +text: PlainTextElement; +``` + +Defined in: [src/types/view/index.ts:104](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L104) + +*** + +### value + +```ts +value: string; +``` + +Defined in: [src/types/view/index.ts:105](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L105) diff --git a/docs/english/reference/interfaces/ViewStateValue.md b/docs/english/reference/interfaces/ViewStateValue.md new file mode 100644 index 000000000..6c4f8c818 --- /dev/null +++ b/docs/english/reference/interfaces/ViewStateValue.md @@ -0,0 +1,155 @@ +[@slack/bolt](../index.md) / ViewStateValue + +# Interface: ViewStateValue + +Defined in: [src/types/view/index.ts:236](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L236) + +## Properties + +### files? + +```ts +optional files?: UploadedFile[]; +``` + +Defined in: [src/types/view/index.ts:251](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L251) + +*** + +### rich\_text\_value? + +```ts +optional rich_text_value?: RichTextBlock; +``` + +Defined in: [src/types/view/index.ts:250](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L250) + +*** + +### selected\_channel? + +```ts +optional selected_channel?: string | null; +``` + +Defined in: [src/types/view/index.ts:243](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L243) + +*** + +### selected\_channels? + +```ts +optional selected_channels?: string[]; +``` + +Defined in: [src/types/view/index.ts:247](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L247) + +*** + +### selected\_conversation? + +```ts +optional selected_conversation?: string | null; +``` + +Defined in: [src/types/view/index.ts:242](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L242) + +*** + +### selected\_conversations? + +```ts +optional selected_conversations?: string[]; +``` + +Defined in: [src/types/view/index.ts:246](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L246) + +*** + +### selected\_date? + +```ts +optional selected_date?: string | null; +``` + +Defined in: [src/types/view/index.ts:239](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L239) + +*** + +### selected\_date\_time? + +```ts +optional selected_date_time?: number | null; +``` + +Defined in: [src/types/view/index.ts:241](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L241) + +*** + +### selected\_option? + +```ts +optional selected_option?: ViewStateSelectedOption | null; +``` + +Defined in: [src/types/view/index.ts:245](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L245) + +*** + +### selected\_options? + +```ts +optional selected_options?: ViewStateSelectedOption[]; +``` + +Defined in: [src/types/view/index.ts:249](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L249) + +*** + +### selected\_time? + +```ts +optional selected_time?: string | null; +``` + +Defined in: [src/types/view/index.ts:240](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L240) + +*** + +### selected\_user? + +```ts +optional selected_user?: string | null; +``` + +Defined in: [src/types/view/index.ts:244](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L244) + +*** + +### selected\_users? + +```ts +optional selected_users?: string[]; +``` + +Defined in: [src/types/view/index.ts:248](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L248) + +*** + +### type + +```ts +type: string; +``` + +Defined in: [src/types/view/index.ts:237](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L237) + +*** + +### value? + +```ts +optional value?: string | null; +``` + +Defined in: [src/types/view/index.ts:238](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L238) diff --git a/docs/english/reference/interfaces/ViewSubmitAction.md b/docs/english/reference/interfaces/ViewSubmitAction.md new file mode 100644 index 000000000..9405a9ed4 --- /dev/null +++ b/docs/english/reference/interfaces/ViewSubmitAction.md @@ -0,0 +1,146 @@ +[@slack/bolt](../index.md) / ViewSubmitAction + +# Interface: ViewSubmitAction + +Defined in: [src/types/view/index.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L47) + +A Slack view_submission event wrapped in the standard metadata. + +This describes the entire JSON-encoded body of a view_submission event. + +## Properties + +### api\_app\_id + +```ts +api_app_id: string; +``` + +Defined in: [src/types/view/index.ts:61](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L61) + +*** + +### enterprise? + +```ts +optional enterprise?: object; +``` + +Defined in: [src/types/view/index.ts:66](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L66) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +*** + +### is\_enterprise\_install? + +```ts +optional is_enterprise_install?: boolean; +``` + +Defined in: [src/types/view/index.ts:65](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L65) + +*** + +### response\_urls? + +```ts +optional response_urls?: ViewResponseUrl[]; +``` + +Defined in: [src/types/view/index.ts:70](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L70) + +*** + +### team + +```ts +team: + | { + domain: string; + enterprise_id?: string; + enterprise_name?: string; + id: string; +} + | null; +``` + +Defined in: [src/types/view/index.ts:49](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L49) + +*** + +### token + +```ts +token: string; +``` + +Defined in: [src/types/view/index.ts:62](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L62) + +*** + +### trigger\_id + +```ts +trigger_id: string; +``` + +Defined in: [src/types/view/index.ts:63](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L63) + +*** + +### type + +```ts +type: "view_submission"; +``` + +Defined in: [src/types/view/index.ts:48](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L48) + +*** + +### user + +```ts +user: object; +``` + +Defined in: [src/types/view/index.ts:55](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L55) + +#### id + +```ts +id: string; +``` + +#### name + +```ts +name: string; +``` + +#### team\_id? + +```ts +optional team_id?: string; +``` + +*** + +### view + +```ts +view: ViewOutput; +``` + +Defined in: [src/types/view/index.ts:60](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L60) diff --git a/docs/english/reference/interfaces/ViewUpdateResponseAction.md b/docs/english/reference/interfaces/ViewUpdateResponseAction.md new file mode 100644 index 000000000..121b868b8 --- /dev/null +++ b/docs/english/reference/interfaces/ViewUpdateResponseAction.md @@ -0,0 +1,25 @@ +[@slack/bolt](../index.md) / ViewUpdateResponseAction + +# Interface: ViewUpdateResponseAction + +Defined in: [src/types/view/index.ts:288](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L288) + +## Properties + +### response\_action + +```ts +response_action: "update"; +``` + +Defined in: [src/types/view/index.ts:289](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L289) + +*** + +### view + +```ts +view: View; +``` + +Defined in: [src/types/view/index.ts:290](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L290) diff --git a/docs/english/reference/type-aliases/AckFn.md b/docs/english/reference/type-aliases/AckFn.md new file mode 100644 index 000000000..c22fcf0a9 --- /dev/null +++ b/docs/english/reference/type-aliases/AckFn.md @@ -0,0 +1,25 @@ +[@slack/bolt](../index.md) / AckFn + +# Type Alias: AckFn\ + +```ts +type AckFn = (response?) => Promise; +``` + +Defined in: [src/types/utilities.ts:45](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L45) + +## Type Parameters + +### Response + +`Response` + +## Parameters + +### response? + +`Response` + +## Returns + +`Promise`\<`void`\> diff --git a/docs/english/reference/type-aliases/AnyMiddlewareArgs.md b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md new file mode 100644 index 000000000..90e266af7 --- /dev/null +++ b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md @@ -0,0 +1,15 @@ +[@slack/bolt](../index.md) / AnyMiddlewareArgs + +# Type Alias: AnyMiddlewareArgs + +```ts +type AnyMiddlewareArgs = + | SlackEventMiddlewareArgs + | SlackActionMiddlewareArgs + | SlackCommandMiddlewareArgs + | SlackOptionsMiddlewareArgs + | SlackViewMiddlewareArgs + | SlackShortcutMiddlewareArgs; +``` + +Defined in: [src/types/middleware.ts:12](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L12) diff --git a/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md new file mode 100644 index 000000000..215f5e9c0 --- /dev/null +++ b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / AssistantThreadContextChangedMiddleware + +# Type Alias: AssistantThreadContextChangedMiddleware + +```ts +type AssistantThreadContextChangedMiddleware = Middleware; +``` + +Defined in: [src/Assistant.ts:68](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L68) diff --git a/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md new file mode 100644 index 000000000..3bd77d149 --- /dev/null +++ b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / AssistantThreadStartedMiddleware + +# Type Alias: AssistantThreadStartedMiddleware + +```ts +type AssistantThreadStartedMiddleware = Middleware; +``` + +Defined in: [src/Assistant.ts:67](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L67) + +Middleware diff --git a/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md new file mode 100644 index 000000000..01ddd3bee --- /dev/null +++ b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / AssistantUserMessageMiddleware + +# Type Alias: AssistantUserMessageMiddleware + +```ts +type AssistantUserMessageMiddleware = Middleware; +``` + +Defined in: [src/Assistant.ts:69](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L69) diff --git a/docs/english/reference/type-aliases/Authorize.md b/docs/english/reference/type-aliases/Authorize.md new file mode 100644 index 000000000..121129bc8 --- /dev/null +++ b/docs/english/reference/type-aliases/Authorize.md @@ -0,0 +1,31 @@ +[@slack/bolt](../index.md) / Authorize + +# Type Alias: Authorize\ + +```ts +type Authorize = (source, body?) => Promise; +``` + +Defined in: [src/App.ts:163](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L163) + +Authorization function - seeds the middleware processing and listeners with an authorization context + +## Type Parameters + +### IsEnterpriseInstall + +`IsEnterpriseInstall` *extends* `boolean` = `false` + +## Parameters + +### source + +[`AuthorizeSourceData`](../interfaces/AuthorizeSourceData.md)\<`IsEnterpriseInstall`\> + +### body? + +[`AnyMiddlewareArgs`](AnyMiddlewareArgs.md)\[`"body"`\] + +## Returns + +`Promise`\<[`AuthorizeResult`](../interfaces/AuthorizeResult.md)\> diff --git a/docs/english/reference/type-aliases/BlockButtonAction.md b/docs/english/reference/type-aliases/BlockButtonAction.md new file mode 100644 index 000000000..81c6de821 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockButtonAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockButtonAction + +# Type Alias: BlockButtonAction + +```ts +type BlockButtonAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:350](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L350) diff --git a/docs/english/reference/type-aliases/BlockChannelsSelectAction.md b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md new file mode 100644 index 000000000..f98ef1c58 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockChannelsSelectAction + +# Type Alias: BlockChannelsSelectAction + +```ts +type BlockChannelsSelectAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:356](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L356) diff --git a/docs/english/reference/type-aliases/BlockCheckboxesAction.md b/docs/english/reference/type-aliases/BlockCheckboxesAction.md new file mode 100644 index 000000000..18ffdcbb9 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockCheckboxesAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockCheckboxesAction + +# Type Alias: BlockCheckboxesAction + +```ts +type BlockCheckboxesAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:362](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L362) diff --git a/docs/english/reference/type-aliases/BlockConversationsSelectAction.md b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md new file mode 100644 index 000000000..8b8724aef --- /dev/null +++ b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockConversationsSelectAction + +# Type Alias: BlockConversationsSelectAction + +```ts +type BlockConversationsSelectAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:355](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L355) diff --git a/docs/english/reference/type-aliases/BlockDatepickerAction.md b/docs/english/reference/type-aliases/BlockDatepickerAction.md new file mode 100644 index 000000000..fd3c9e728 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockDatepickerAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockDatepickerAction + +# Type Alias: BlockDatepickerAction + +```ts +type BlockDatepickerAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:359](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L359) diff --git a/docs/english/reference/type-aliases/BlockElementAction.md b/docs/english/reference/type-aliases/BlockElementAction.md new file mode 100644 index 000000000..f29f5c71d --- /dev/null +++ b/docs/english/reference/type-aliases/BlockElementAction.md @@ -0,0 +1,33 @@ +[@slack/bolt](../index.md) / BlockElementAction + +# Type Alias: BlockElementAction + +```ts +type BlockElementAction = + | ButtonAction + | FeedbackButtonsAction + | IconButtonAction + | UsersSelectAction + | MultiUsersSelectAction + | StaticSelectAction + | MultiStaticSelectAction + | ConversationsSelectAction + | MultiConversationsSelectAction + | ChannelsSelectAction + | MultiChannelsSelectAction + | ExternalSelectAction + | MultiExternalSelectAction + | OverflowAction + | DatepickerAction + | TimepickerAction + | RadioButtonsAction + | CheckboxesAction + | PlainTextInputAction + | RichTextInputAction; +``` + +Defined in: [src/types/actions/block-action.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L11) + +All known actions from in Slack's interactive elements + +This is a discriminated union. The discriminant is the `type` property. diff --git a/docs/english/reference/type-aliases/BlockExternalSelectAction.md b/docs/english/reference/type-aliases/BlockExternalSelectAction.md new file mode 100644 index 000000000..5d95aeebd --- /dev/null +++ b/docs/english/reference/type-aliases/BlockExternalSelectAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockExternalSelectAction + +# Type Alias: BlockExternalSelectAction + +```ts +type BlockExternalSelectAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:357](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L357) diff --git a/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md new file mode 100644 index 000000000..81da19224 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockFeedbackButtonsAction + +# Type Alias: BlockFeedbackButtonsAction + +```ts +type BlockFeedbackButtonsAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:351](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L351) diff --git a/docs/english/reference/type-aliases/BlockIconButtonAction.md b/docs/english/reference/type-aliases/BlockIconButtonAction.md new file mode 100644 index 000000000..9e08724ce --- /dev/null +++ b/docs/english/reference/type-aliases/BlockIconButtonAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockIconButtonAction + +# Type Alias: BlockIconButtonAction + +```ts +type BlockIconButtonAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:352](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L352) diff --git a/docs/english/reference/type-aliases/BlockOverflowAction.md b/docs/english/reference/type-aliases/BlockOverflowAction.md new file mode 100644 index 000000000..d03935713 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockOverflowAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockOverflowAction + +# Type Alias: BlockOverflowAction + +```ts +type BlockOverflowAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:358](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L358) diff --git a/docs/english/reference/type-aliases/BlockPlainTextInputAction.md b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md new file mode 100644 index 000000000..dcf8647c4 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockPlainTextInputAction + +# Type Alias: BlockPlainTextInputAction + +```ts +type BlockPlainTextInputAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:363](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L363) diff --git a/docs/english/reference/type-aliases/BlockRadioButtonsAction.md b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md new file mode 100644 index 000000000..555864561 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockRadioButtonsAction + +# Type Alias: BlockRadioButtonsAction + +```ts +type BlockRadioButtonsAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:361](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L361) diff --git a/docs/english/reference/type-aliases/BlockStaticSelectAction.md b/docs/english/reference/type-aliases/BlockStaticSelectAction.md new file mode 100644 index 000000000..70908b0ce --- /dev/null +++ b/docs/english/reference/type-aliases/BlockStaticSelectAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockStaticSelectAction + +# Type Alias: BlockStaticSelectAction + +```ts +type BlockStaticSelectAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:353](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L353) diff --git a/docs/english/reference/type-aliases/BlockTimepickerAction.md b/docs/english/reference/type-aliases/BlockTimepickerAction.md new file mode 100644 index 000000000..a98feff71 --- /dev/null +++ b/docs/english/reference/type-aliases/BlockTimepickerAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockTimepickerAction + +# Type Alias: BlockTimepickerAction + +```ts +type BlockTimepickerAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:360](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L360) diff --git a/docs/english/reference/type-aliases/BlockUsersSelectAction.md b/docs/english/reference/type-aliases/BlockUsersSelectAction.md new file mode 100644 index 000000000..4562148be --- /dev/null +++ b/docs/english/reference/type-aliases/BlockUsersSelectAction.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / BlockUsersSelectAction + +# Type Alias: BlockUsersSelectAction + +```ts +type BlockUsersSelectAction = BlockAction; +``` + +Defined in: [src/types/actions/block-action.ts:354](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L354) diff --git a/docs/english/reference/type-aliases/EventFromType.md b/docs/english/reference/type-aliases/EventFromType.md new file mode 100644 index 000000000..d4286598a --- /dev/null +++ b/docs/english/reference/type-aliases/EventFromType.md @@ -0,0 +1,20 @@ +[@slack/bolt](../index.md) / EventFromType + +# Type Alias: EventFromType\ + +```ts +type EventFromType = KnownEventFromType extends never ? BaseSlackEvent : KnownEventFromType; +``` + +Defined in: [src/types/events/index.ts:108](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L108) + +Type function which given a string `T` returns a type for the matching Slack event(s). + +When the string matches known event(s) from the `SlackEvent` union, only those types are returned (also as a union). +Otherwise, the `BasicSlackEvent` type is returned. + +## Type Parameters + +### T + +`T` *extends* `string` diff --git a/docs/english/reference/type-aliases/EventTypePattern.md b/docs/english/reference/type-aliases/EventTypePattern.md new file mode 100644 index 000000000..fb30bf1f8 --- /dev/null +++ b/docs/english/reference/type-aliases/EventTypePattern.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / EventTypePattern + +# Type Alias: EventTypePattern + +```ts +type EventTypePattern = string | RegExp; +``` + +Defined in: [src/types/events/index.ts:71](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L71) diff --git a/docs/english/reference/type-aliases/FunctionInputs.md b/docs/english/reference/type-aliases/FunctionInputs.md new file mode 100644 index 000000000..53ba1bd84 --- /dev/null +++ b/docs/english/reference/type-aliases/FunctionInputs.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / FunctionInputs + +# Type Alias: FunctionInputs + +```ts +type FunctionInputs = Record; +``` + +Defined in: [src/types/events/index.ts:72](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L72) diff --git a/docs/english/reference/type-aliases/InteractiveAction.md b/docs/english/reference/type-aliases/InteractiveAction.md new file mode 100644 index 000000000..34c17e017 --- /dev/null +++ b/docs/english/reference/type-aliases/InteractiveAction.md @@ -0,0 +1,14 @@ +[@slack/bolt](../index.md) / InteractiveAction + +# Type Alias: InteractiveAction + +```ts +type InteractiveAction = + | ButtonClick + | MenuSelect; +``` + +Defined in: [src/types/actions/interactive-message.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L5) + +All actions which Slack delivers from legacy interactive messages. The full body of these actions are represented +as [[InteractiveMessage]]. diff --git a/docs/english/reference/type-aliases/InteractiveButtonClick.md b/docs/english/reference/type-aliases/InteractiveButtonClick.md new file mode 100644 index 000000000..184698dac --- /dev/null +++ b/docs/english/reference/type-aliases/InteractiveButtonClick.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / InteractiveButtonClick + +# Type Alias: InteractiveButtonClick + +```ts +type InteractiveButtonClick = InteractiveMessage; +``` + +Defined in: [src/types/actions/interactive-message.ts:74](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L74) diff --git a/docs/english/reference/type-aliases/InteractiveMenuSelect.md b/docs/english/reference/type-aliases/InteractiveMenuSelect.md new file mode 100644 index 000000000..8cfb676fc --- /dev/null +++ b/docs/english/reference/type-aliases/InteractiveMenuSelect.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / InteractiveMenuSelect + +# Type Alias: InteractiveMenuSelect + +```ts +type InteractiveMenuSelect = InteractiveMessage; +``` + +Defined in: [src/types/actions/interactive-message.ts:75](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L75) diff --git a/docs/english/reference/type-aliases/KnownEventFromType.md b/docs/english/reference/type-aliases/KnownEventFromType.md new file mode 100644 index 000000000..eeca8729e --- /dev/null +++ b/docs/english/reference/type-aliases/KnownEventFromType.md @@ -0,0 +1,17 @@ +[@slack/bolt](../index.md) / KnownEventFromType + +# Type Alias: KnownEventFromType\ + +```ts +type KnownEventFromType = Extract; +``` + +Defined in: [src/types/events/index.ts:110](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L110) + +## Type Parameters + +### T + +`T` *extends* `string` diff --git a/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md b/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md new file mode 100644 index 000000000..171865442 --- /dev/null +++ b/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md @@ -0,0 +1,17 @@ +[@slack/bolt](../index.md) / KnownOptionsPayloadFromType + +# Type Alias: KnownOptionsPayloadFromType\ + +```ts +type KnownOptionsPayloadFromType = Extract; +``` + +Defined in: [src/types/options/index.ts:40](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L40) + +## Type Parameters + +### T + +`T` *extends* `string` diff --git a/docs/english/reference/type-aliases/Middleware.md b/docs/english/reference/type-aliases/Middleware.md new file mode 100644 index 000000000..6c0966e38 --- /dev/null +++ b/docs/english/reference/type-aliases/Middleware.md @@ -0,0 +1,29 @@ +[@slack/bolt](../index.md) / Middleware + +# Type Alias: Middleware\ + +```ts +type Middleware = (args) => Promise; +``` + +Defined in: [src/types/middleware.ts:29](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L29) + +## Type Parameters + +### Args + +`Args` + +### CustomContext + +`CustomContext` = [`StringIndexed`](StringIndexed.md) + +## Parameters + +### args + +`Args` & [`AllMiddlewareArgs`](../interfaces/AllMiddlewareArgs.md)\<`CustomContext`\> + +## Returns + +`Promise`\<`void`\> diff --git a/docs/english/reference/type-aliases/NextFn.md b/docs/english/reference/type-aliases/NextFn.md new file mode 100644 index 000000000..f75332159 --- /dev/null +++ b/docs/english/reference/type-aliases/NextFn.md @@ -0,0 +1,13 @@ +[@slack/bolt](../index.md) / NextFn + +# Type Alias: NextFn + +```ts +type NextFn = () => Promise; +``` + +Defined in: [src/types/middleware.ts:117](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L117) + +## Returns + +`Promise`\<`void`\> diff --git a/docs/english/reference/type-aliases/OptionsPayloadFromType.md b/docs/english/reference/type-aliases/OptionsPayloadFromType.md new file mode 100644 index 000000000..677c39952 --- /dev/null +++ b/docs/english/reference/type-aliases/OptionsPayloadFromType.md @@ -0,0 +1,15 @@ +[@slack/bolt](../index.md) / OptionsPayloadFromType + +# Type Alias: OptionsPayloadFromType\ + +```ts +type OptionsPayloadFromType = KnownOptionsPayloadFromType extends never ? BasicOptionsPayload : KnownOptionsPayloadFromType; +``` + +Defined in: [src/types/options/index.ts:38](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L38) + +## Type Parameters + +### T + +`T` *extends* `string` diff --git a/docs/english/reference/type-aliases/OptionsSource.md b/docs/english/reference/type-aliases/OptionsSource.md new file mode 100644 index 000000000..1724e99d3 --- /dev/null +++ b/docs/english/reference/type-aliases/OptionsSource.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / OptionsSource + +# Type Alias: OptionsSource + +```ts +type OptionsSource = SlackOptions["type"]; +``` + +Defined in: [src/types/options/index.ts:30](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L30) + +All sources from which Slack sends options requests. diff --git a/docs/english/reference/type-aliases/RespondArguments.md b/docs/english/reference/type-aliases/RespondArguments.md new file mode 100644 index 000000000..9182e05f2 --- /dev/null +++ b/docs/english/reference/type-aliases/RespondArguments.md @@ -0,0 +1,43 @@ +[@slack/bolt](../index.md) / RespondArguments + +# Type Alias: RespondArguments + +```ts +type RespondArguments = DistributiveOmit & object; +``` + +Defined in: [src/types/utilities.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L34) + +## Type Declaration + +### delete\_original? + +```ts +optional delete_original?: boolean; +``` + +### replace\_original? + +```ts +optional replace_original?: boolean; +``` + +### response\_type? + +```ts +optional response_type?: "in_channel" | "ephemeral"; +``` + +Response URLs can be used to send ephemeral messages or in-channel messages using this argument + +### text? + +```ts +optional text?: string; +``` + +### thread\_ts? + +```ts +optional thread_ts?: string; +``` diff --git a/docs/english/reference/type-aliases/RespondFn.md b/docs/english/reference/type-aliases/RespondFn.md new file mode 100644 index 000000000..5993b9946 --- /dev/null +++ b/docs/english/reference/type-aliases/RespondFn.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / RespondFn + +# Type Alias: RespondFn + +```ts +type RespondFn = (message) => Promise>>; +``` + +Defined in: [src/types/utilities.ts:43](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L43) + +## Parameters + +### message + +`string` \| [`RespondArguments`](RespondArguments.md) + +## Returns + +`Promise`\<`Awaited`\<`ReturnType`\<`FetchFunction`\>\>\> diff --git a/docs/english/reference/type-aliases/SayArguments.md b/docs/english/reference/type-aliases/SayArguments.md new file mode 100644 index 000000000..6b21b7a1d --- /dev/null +++ b/docs/english/reference/type-aliases/SayArguments.md @@ -0,0 +1,17 @@ +[@slack/bolt](../index.md) / SayArguments + +# Type Alias: SayArguments + +```ts +type SayArguments = DistributiveOmit & object; +``` + +Defined in: [src/types/utilities.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L28) + +## Type Declaration + +### channel? + +```ts +optional channel?: string; +``` diff --git a/docs/english/reference/type-aliases/SayFn.md b/docs/english/reference/type-aliases/SayFn.md new file mode 100644 index 000000000..cfaaff0b7 --- /dev/null +++ b/docs/english/reference/type-aliases/SayFn.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / SayFn + +# Type Alias: SayFn + +```ts +type SayFn = (message) => Promise; +``` + +Defined in: [src/types/utilities.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L32) + +## Parameters + +### message + +`string` \| [`SayArguments`](SayArguments.md) + +## Returns + +`Promise`\<`ChatPostMessageResponse`\> diff --git a/docs/english/reference/type-aliases/SayStreamArguments.md b/docs/english/reference/type-aliases/SayStreamArguments.md new file mode 100644 index 000000000..a08ff5693 --- /dev/null +++ b/docs/english/reference/type-aliases/SayStreamArguments.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / SayStreamArguments + +# Type Alias: SayStreamArguments + +```ts +type SayStreamArguments = Partial>; +``` + +Defined in: [src/context/create-say-stream.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/context/create-say-stream.ts#L5) diff --git a/docs/english/reference/type-aliases/SayStreamFn.md b/docs/english/reference/type-aliases/SayStreamFn.md new file mode 100644 index 000000000..7a1488052 --- /dev/null +++ b/docs/english/reference/type-aliases/SayStreamFn.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / SayStreamFn + +# Type Alias: SayStreamFn + +```ts +type SayStreamFn = (args?) => ReturnType; +``` + +Defined in: [src/context/create-say-stream.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/context/create-say-stream.ts#L7) + +## Parameters + +### args? + +[`SayStreamArguments`](SayStreamArguments.md) + +## Returns + +`ReturnType`\<`WebClient`\[`"chatStream"`\]\> diff --git a/docs/english/reference/type-aliases/SetStatusArguments.md b/docs/english/reference/type-aliases/SetStatusArguments.md new file mode 100644 index 000000000..a670f0c35 --- /dev/null +++ b/docs/english/reference/type-aliases/SetStatusArguments.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / SetStatusArguments + +# Type Alias: SetStatusArguments + +```ts +type SetStatusArguments = Omit; +``` + +Defined in: [src/context/create-set-status.ts:3](https://github.com/slackapi/bolt-js/blob/main/src/context/create-set-status.ts#L3) diff --git a/docs/english/reference/type-aliases/SetStatusFn.md b/docs/english/reference/type-aliases/SetStatusFn.md new file mode 100644 index 000000000..eb72dc5ff --- /dev/null +++ b/docs/english/reference/type-aliases/SetStatusFn.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / SetStatusFn + +# Type Alias: SetStatusFn + +```ts +type SetStatusFn = (status) => Promise; +``` + +Defined in: [src/context/create-set-status.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/context/create-set-status.ts#L5) + +## Parameters + +### status + +`string` \| [`SetStatusArguments`](SetStatusArguments.md) + +## Returns + +`Promise`\<`AssistantThreadsSetStatusResponse`\> diff --git a/docs/english/reference/type-aliases/SlackAction.md b/docs/english/reference/type-aliases/SlackAction.md new file mode 100644 index 000000000..018793c9e --- /dev/null +++ b/docs/english/reference/type-aliases/SlackAction.md @@ -0,0 +1,25 @@ +[@slack/bolt](../index.md) / SlackAction + +# Type Alias: SlackAction + +```ts +type SlackAction = + | BlockAction + | InteractiveMessage + | DialogSubmitAction; +``` + +Defined in: [src/types/actions/index.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L26) + +All known actions from Slack's Block Kit interactive components, message actions, dialogs, and legacy interactive +messages. + +TODO: BlockAction's default generic parameter (ElementAction) might be too specific to allow for this type to be used +as a constraint on SlackActionMiddlewareArgs' Action generic parameter. + +If someone were to instantiate SlackActionMiddlewareArgs>, would it work? We need it to +work as long as SomeNewAction implements BasicElementAction. + +We don't want to substitute BlockAction with BlockAction here because that means the completions +offered when no generic parameter is bound would be limited to BasicElementAction rather than the union of known +actions - ElementAction. diff --git a/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md new file mode 100644 index 000000000..a96455fe5 --- /dev/null +++ b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md @@ -0,0 +1,72 @@ +[@slack/bolt](../index.md) / SlackActionMiddlewareArgs + +# Type Alias: SlackActionMiddlewareArgs\ + +```ts +type SlackActionMiddlewareArgs = object & Action extends Exclude ? object : unknown; +``` + +Defined in: [src/types/actions/index.ts:46](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L46) + +Arguments which listeners and middleware receive to process an action from Slack's Block Kit interactive components, +message actions, dialogs, or legacy interactive messages. + +The type parameter `Action` represents the entire JSON-encoded request body from Slack. The generic type +`BlockAction` can be used to create a type for this parameter based on an element's action type. In +this case `ElementAction` must extend `BasicElementAction`. + +## Type Declaration + +### ack + +```ts +ack: ActionAckFn; +``` + +### action + +```ts +action: Action extends BlockAction ? ElementAction : Action extends InteractiveMessage ? InteractiveAction : Action; +``` + +### body + +```ts +body: Action; +``` + +### complete? + +```ts +optional complete?: FunctionCompleteFn; +``` + +### fail? + +```ts +optional fail?: FunctionFailFn; +``` + +### inputs? + +```ts +optional inputs?: FunctionInputs; +``` + +### payload + +```ts +payload: Action extends BlockAction ? ElementAction : Action extends InteractiveMessage ? InteractiveAction : Action; +``` + +### respond + +```ts +respond: RespondFn; +``` + +## Type Parameters + +### Action + +`Action` *extends* [`SlackAction`](SlackAction.md) = [`SlackAction`](SlackAction.md) diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md new file mode 100644 index 000000000..af19d9913 --- /dev/null +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md @@ -0,0 +1,45 @@ +[@slack/bolt](../index.md) / SlackEventMiddlewareArgs + +# Type Alias: SlackEventMiddlewareArgs\ + +```ts +type SlackEventMiddlewareArgs = object & EventType extends "message" ? object : unknown & EventFromType extends + | { + channel: string; +} + | { + item: { + channel: string; + }; +} ? object : unknown & EventFromType extends EventWithChannelContext ? EventFromType extends EventWithThreadTsContext | EventWithTsContext ? object : unknown : unknown & EventType extends "function_executed" ? object : object; +``` + +Defined in: [src/types/events/index.ts:39](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L39) + +Arguments which listeners and middleware receive to process an event from Slack's Events API. + +## Type Declaration + +### body + +```ts +body: EnvelopedEvent>; +``` + +### event + +```ts +event: EventFromType; +``` + +### payload + +```ts +payload: EventFromType; +``` + +## Type Parameters + +### EventType + +`EventType` *extends* `string` = `string` diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md new file mode 100644 index 000000000..7ebaf3368 --- /dev/null +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md @@ -0,0 +1,19 @@ +[@slack/bolt](../index.md) / SlackEventMiddlewareArgsOptions + +# Type Alias: SlackEventMiddlewareArgsOptions + +```ts +type SlackEventMiddlewareArgsOptions = object; +``` + +Defined in: [src/types/events/index.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L7) + +## Properties + +### autoAcknowledge + +```ts +autoAcknowledge: boolean; +``` + +Defined in: [src/types/events/index.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L7) diff --git a/docs/english/reference/type-aliases/SlackOptions.md b/docs/english/reference/type-aliases/SlackOptions.md new file mode 100644 index 000000000..59596dc3e --- /dev/null +++ b/docs/english/reference/type-aliases/SlackOptions.md @@ -0,0 +1,12 @@ +[@slack/bolt](../index.md) / SlackOptions + +# Type Alias: SlackOptions + +```ts +type SlackOptions = + | BlockSuggestion + | InteractiveMessageSuggestion + | DialogSuggestion; +``` + +Defined in: [src/types/options/index.ts:15](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L15) diff --git a/docs/english/reference/type-aliases/SlackShortcut.md b/docs/english/reference/type-aliases/SlackShortcut.md new file mode 100644 index 000000000..99450cdda --- /dev/null +++ b/docs/english/reference/type-aliases/SlackShortcut.md @@ -0,0 +1,13 @@ +[@slack/bolt](../index.md) / SlackShortcut + +# Type Alias: SlackShortcut + +```ts +type SlackShortcut = + | GlobalShortcut + | MessageShortcut; +``` + +Defined in: [src/types/shortcuts/index.ts:12](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/index.ts#L12) + +All known shortcuts from Slack. diff --git a/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md new file mode 100644 index 000000000..b3be60bde --- /dev/null +++ b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md @@ -0,0 +1,51 @@ +[@slack/bolt](../index.md) / SlackShortcutMiddlewareArgs + +# Type Alias: SlackShortcutMiddlewareArgs\ + +```ts +type SlackShortcutMiddlewareArgs = object & Shortcut extends MessageShortcut ? object : unknown; +``` + +Defined in: [src/types/shortcuts/index.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/index.ts#L24) + +Arguments which listeners and middleware receive to process a shortcut from Slack. + +The type parameter `Shortcut` represents the entire JSON-encoded request body from Slack. + +## Type Declaration + +### ack + +```ts +ack: AckFn; +``` + +### body + +```ts +body: Shortcut; +``` + +### payload + +```ts +payload: Shortcut; +``` + +### respond + +```ts +respond: RespondFn; +``` + +### shortcut + +```ts +shortcut: Shortcut; +``` + +## Type Parameters + +### Shortcut + +`Shortcut` *extends* [`SlackShortcut`](SlackShortcut.md) = [`SlackShortcut`](SlackShortcut.md) diff --git a/docs/english/reference/type-aliases/SlackViewAction.md b/docs/english/reference/type-aliases/SlackViewAction.md new file mode 100644 index 000000000..5e4006316 --- /dev/null +++ b/docs/english/reference/type-aliases/SlackViewAction.md @@ -0,0 +1,13 @@ +[@slack/bolt](../index.md) / SlackViewAction + +# Type Alias: SlackViewAction + +```ts +type SlackViewAction = + | ViewSubmitAction + | ViewClosedAction; +``` + +Defined in: [src/types/view/index.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L8) + +Known view action types diff --git a/docs/english/reference/type-aliases/StringIndexed.md b/docs/english/reference/type-aliases/StringIndexed.md new file mode 100644 index 000000000..4a1063c04 --- /dev/null +++ b/docs/english/reference/type-aliases/StringIndexed.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / StringIndexed + +# Type Alias: StringIndexed + +```ts +type StringIndexed = Record; +``` + +Defined in: [src/types/utilities.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L7) + +Extend this interface to build a type that is treated as an open set of properties, where each key is a string. diff --git a/docs/english/reference/type-aliases/ViewResponseAction.md b/docs/english/reference/type-aliases/ViewResponseAction.md new file mode 100644 index 000000000..a43f1c95a --- /dev/null +++ b/docs/english/reference/type-aliases/ViewResponseAction.md @@ -0,0 +1,13 @@ +[@slack/bolt](../index.md) / ViewResponseAction + +# Type Alias: ViewResponseAction + +```ts +type ViewResponseAction = + | ViewUpdateResponseAction + | ViewPushResponseAction + | ViewClearResponseAction + | ViewErrorsResponseAction; +``` + +Defined in: [src/types/view/index.ts:309](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L309) diff --git a/docs/english/reference/type-aliases/XOR.md b/docs/english/reference/type-aliases/XOR.md new file mode 100644 index 000000000..302eb0adb --- /dev/null +++ b/docs/english/reference/type-aliases/XOR.md @@ -0,0 +1,21 @@ +[@slack/bolt](../index.md) / XOR + +# Type Alias: XOR\ + +```ts +type XOR = T | U extends Record ? Without & U | Without & T : T | U; +``` + +Defined in: [src/types/utilities.ts:13](https://github.com/slackapi/bolt-js/blob/main/src/types/utilities.ts#L13) + +Type function which allows either types `T` or `U`, but not both. + +## Type Parameters + +### T + +`T` + +### U + +`U` diff --git a/docs/english/reference/variables/autoAcknowledge.md b/docs/english/reference/variables/autoAcknowledge.md new file mode 100644 index 000000000..38b64d1f9 --- /dev/null +++ b/docs/english/reference/variables/autoAcknowledge.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / autoAcknowledge + +# Variable: autoAcknowledge + +```ts +const autoAcknowledge: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:132](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L132) + +Middleware that auto acknowledges the request received diff --git a/docs/english/reference/variables/contextBuiltinKeys.md b/docs/english/reference/variables/contextBuiltinKeys.md new file mode 100644 index 000000000..f7961e3c7 --- /dev/null +++ b/docs/english/reference/variables/contextBuiltinKeys.md @@ -0,0 +1,9 @@ +[@slack/bolt](../index.md) / contextBuiltinKeys + +# Variable: contextBuiltinKeys + +```ts +const contextBuiltinKeys: string[]; +``` + +Defined in: [src/types/middleware.ts:103](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L103) diff --git a/docs/english/reference/variables/directMention.md b/docs/english/reference/variables/directMention.md new file mode 100644 index 000000000..eed713abe --- /dev/null +++ b/docs/english/reference/variables/directMention.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / directMention + +# Variable: directMention + +```ts +const directMention: Middleware>; +``` + +Defined in: [src/middleware/builtin.ts:359](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L359) + +Filters out any message event whose text does not start with an @-mention of the handling app. diff --git a/docs/english/reference/variables/ignoreSelf.md b/docs/english/reference/variables/ignoreSelf.md new file mode 100644 index 000000000..d5581dab0 --- /dev/null +++ b/docs/english/reference/variables/ignoreSelf.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / ignoreSelf + +# Variable: ignoreSelf + +```ts +const ignoreSelf: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:312](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L312) + +Filters out any event originating from the handling app. diff --git a/docs/english/reference/variables/onlyActions.md b/docs/english/reference/variables/onlyActions.md new file mode 100644 index 000000000..18497dd93 --- /dev/null +++ b/docs/english/reference/variables/onlyActions.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / onlyActions + +# Variable: onlyActions + +```ts +const onlyActions: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L76) + +Middleware that filters out any event that isn't an action diff --git a/docs/english/reference/variables/onlyCommands.md b/docs/english/reference/variables/onlyCommands.md new file mode 100644 index 000000000..7f49c6a10 --- /dev/null +++ b/docs/english/reference/variables/onlyCommands.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / onlyCommands + +# Variable: onlyCommands + +```ts +const onlyCommands: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:94](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L94) + +Middleware that filters out any event that isn't a command diff --git a/docs/english/reference/variables/onlyEvents.md b/docs/english/reference/variables/onlyEvents.md new file mode 100644 index 000000000..90fadf6ee --- /dev/null +++ b/docs/english/reference/variables/onlyEvents.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / onlyEvents + +# Variable: onlyEvents + +```ts +const onlyEvents: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:113](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L113) + +Middleware that filters out any event that isn't an event diff --git a/docs/english/reference/variables/onlyOptions.md b/docs/english/reference/variables/onlyOptions.md new file mode 100644 index 000000000..2dfb3f9a4 --- /dev/null +++ b/docs/english/reference/variables/onlyOptions.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / onlyOptions + +# Variable: onlyOptions + +```ts +const onlyOptions: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:103](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L103) + +Middleware that filters out any event that isn't an options diff --git a/docs/english/reference/variables/onlyShortcuts.md b/docs/english/reference/variables/onlyShortcuts.md new file mode 100644 index 000000000..b789eaa31 --- /dev/null +++ b/docs/english/reference/variables/onlyShortcuts.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / onlyShortcuts + +# Variable: onlyShortcuts + +```ts +const onlyShortcuts: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:85](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L85) + +Middleware that filters out any event that isn't a shortcut diff --git a/docs/english/reference/variables/onlyViewActions.md b/docs/english/reference/variables/onlyViewActions.md new file mode 100644 index 000000000..e63bec8ff --- /dev/null +++ b/docs/english/reference/variables/onlyViewActions.md @@ -0,0 +1,11 @@ +[@slack/bolt](../index.md) / onlyViewActions + +# Variable: onlyViewActions + +```ts +const onlyViewActions: Middleware; +``` + +Defined in: [src/middleware/builtin.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/middleware/builtin.ts#L123) + +Middleware that filters out any event that isn't a view_submission or view_closed event diff --git a/package-lock.json b/package-lock.json index de005a304..272f63a2b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -38,6 +38,8 @@ "source-map-support": "^0.5.12", "ts-node": "^10.9.2", "tsd": "^0.31.2", + "typedoc": "^0.28.20", + "typedoc-plugin-markdown": "^4.13.0", "typescript": "5.3.3" }, "engines": { @@ -467,6 +469,20 @@ "node": ">=12" } }, + "node_modules/@gerrit0/mini-shiki": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz", + "integrity": "sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^3.23.0", + "@shikijs/langs": "^3.23.0", + "@shikijs/themes": "^3.23.0", + "@shikijs/types": "^3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, "node_modules/@inquirer/external-editor": { "version": "1.0.3", "dev": true, @@ -766,6 +782,55 @@ "node": ">=14" } }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", + "integrity": "sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz", + "integrity": "sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz", + "integrity": "sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz", + "integrity": "sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "dev": true, + "license": "MIT" + }, "node_modules/@sinclair/typebox": { "version": "0.27.10", "dev": true, @@ -975,6 +1040,16 @@ "@types/send": "*" } }, + "node_modules/@types/hast": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.5.tgz", + "integrity": "sha512-rp/ezSWaD1m44dPKICGhiskI13nVr7qTloFwDa/IYkhhf5nzwP+zIQcIJh3WIFSBOy/H1PzB40jPjMDksN4F+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, "node_modules/@types/http-errors": { "version": "2.0.5", "license": "MIT", @@ -1088,6 +1163,13 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "dev": true, + "license": "MIT" + }, "node_modules/accepts": { "version": "2.0.0", "license": "MIT", @@ -1692,6 +1774,19 @@ "node": ">=8.6" } }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/error-ex": { "version": "1.3.4", "dev": true, @@ -2540,6 +2635,26 @@ "dev": true, "license": "MIT" }, + "node_modules/linkify-it": { + "version": "5.0.2", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.2.tgz", + "integrity": "sha512-ONTm2jCMAVZjgQa/Fy1kScXsuOoF5NPTsoFBdE1KVIZ2vAh/r9+Bqo+0jINCBYnavTPQZz38QzFTme79ENoN3Q==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], + "license": "MIT", + "dependencies": { + "uc.micro": "^2.0.0" + } + }, "node_modules/locate-path": { "version": "6.0.0", "dev": true, @@ -2621,6 +2736,13 @@ "node": ">=10" } }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true, + "license": "MIT" + }, "node_modules/make-dir": { "version": "4.0.0", "dev": true, @@ -2651,6 +2773,34 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/markdown-it": { + "version": "14.3.0", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.3.0.tgz", + "integrity": "sha512-RCEsPjR+sr0x+AuYp601tKTkgFG4YEPLCzHST3cQ/fhlJkqAkz1L2/Qbp1j9qw5SBwQHFBoW8+hoN5xssOF0Tw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/puzrin" + }, + { + "type": "github", + "url": "https://github.com/sponsors/markdown-it" + } + ], + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.5.0", + "linkify-it": "^5.0.2", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, "node_modules/math-intrinsics": { "version": "1.1.0", "license": "MIT", @@ -2658,6 +2808,13 @@ "node": ">= 0.4" } }, + "node_modules/mdurl": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.1.0.tgz", + "integrity": "sha512-1+HBaOx0zi/dQWht8rNv9MYf9qqpqL/kxI0hXImU6Y547zM6Sni8BQibt7ifgMcYtQg41ao3Ivd6cnSM86inpg==", + "dev": true, + "license": "MIT" + }, "node_modules/media-typer": { "version": "1.1.0", "license": "MIT", @@ -3287,6 +3444,16 @@ "resolve": "^1.11.1" } }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/qs": { "version": "6.15.0", "license": "BSD-3-Clause", @@ -4334,6 +4501,82 @@ "node": ">= 0.6" } }, + "node_modules/typedoc": { + "version": "0.28.20", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.20.tgz", + "integrity": "sha512-uSKqkh8Cr48vllnEy+jdaAgOeR6Y+QCBW7usgUsKj7gJEfR7stw9U/fE49LBnj2tPRKPY0c0EBJSWe9Appmplg==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@gerrit0/mini-shiki": "^3.23.0", + "lunr": "^2.3.9", + "markdown-it": "^14.3.0", + "minimatch": "^10.2.5", + "yaml": "^2.9.0" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 18", + "pnpm": ">= 10" + }, + "peerDependencies": { + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.13.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.13.0.tgz", + "integrity": "sha512-OHaOLoMTS0wL2ud73WXvxv486mrUEtgXxW4iKiTOGJVipT/VBWY76rlVRMQGes7aVonoIf5roWRe1UvHbufLlQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.28.x" + } + }, + "node_modules/typedoc/node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", + "dev": true, + "license": "MIT", + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/typedoc/node_modules/brace-expansion": { + "version": "5.0.9", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.9.tgz", + "integrity": "sha512-ScQ4IuvIEF1TMlP7Zt+vjJ//9zlPb2SDcxWxM3bk8s6t6GGdJ7KO1dCcTidOPJKePW30LE/2cT7wCyPho9/Wxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^4.0.2" + }, + "engines": { + "node": "20 || >=22" + } + }, + "node_modules/typedoc/node_modules/minimatch": { + "version": "10.2.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.6.tgz", + "integrity": "sha512-vpLQEs+VLCr1nU0BXS07maYoFwlDAH0gngQuuttxIwutDFEMHq2blX+8vpgxDdK3J1PwjCJiep77OitTZ4Ll1A==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "brace-expansion": "^5.0.8" + }, + "engines": { + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/typescript": { "version": "5.3.3", "dev": true, @@ -4346,6 +4589,13 @@ "node": ">=14.17" } }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true, + "license": "MIT" + }, "node_modules/undici": { "version": "7.25.0", "resolved": "https://registry.npmjs.org/undici/-/undici-7.25.0.tgz", @@ -4483,6 +4733,22 @@ "dev": true, "license": "ISC" }, + "node_modules/yaml": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.9.0.tgz", + "integrity": "sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA==", + "dev": true, + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" + } + }, "node_modules/yargs": { "version": "17.7.2", "dev": true, diff --git a/package.json b/package.json index 04a32c4bb..9c2e616b5 100644 --- a/package.json +++ b/package.json @@ -28,6 +28,7 @@ "build": "npm run build:clean && tsc", "build:clean": "shx rm -rf ./dist ./coverage", "changeset": "npx @changesets/cli", + "docs": "npx typedoc --plugin typedoc-plugin-markdown", "lint": "npx @biomejs/biome check docs src test examples", "lint:fix": "npx @biomejs/biome check --write docs src test examples", "prepare": "npm run build", @@ -35,7 +36,7 @@ "test:coverage": "c8 npm run test:unit", "test:types": "tsd --files test/types", "test:unit": "TS_NODE_PROJECT=tsconfig.json mocha --config test/unit/.mocharc.json", - "version": "npm run changeset version && npm install", + "version": "npm run changeset version && npm install && npm run docs", "watch": "npx nodemon --watch 'src' --ext 'ts' --exec npm run build" }, "repository": { @@ -76,6 +77,8 @@ "source-map-support": "^0.5.12", "ts-node": "^10.9.2", "tsd": "^0.31.2", + "typedoc": "^0.28.20", + "typedoc-plugin-markdown": "^4.13.0", "typescript": "5.3.3" }, "peerDependencies": { diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 000000000..a1fa9a88c --- /dev/null +++ b/typedoc.json @@ -0,0 +1,27 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": ["src/index.ts"], + "plugin": ["typedoc-plugin-markdown"], + "outputs": [ + { + "name": "markdown", + "path": "docs/english/reference" + } + ], + "skipErrorChecking": true, + "excludeExternals": true, + "useCodeBlocks": true, + "logLevel": "Error", + "readme": "none", + "gitRevision": "main", + "includeVersion": true, + "excludePrivate": true, + "excludeProtected": true, + "excludeInternal": true, + "hideGenerator": true, + "jsDocCompatibility": true, + "hidePageHeader": true, + "entryFileName": "index", + "excludeScopesInPaths": true, + "exclude": ["**/*.test.ts", "**/*.spec.ts", "**/*.test-d.ts"] +} From e29663deda4ea5af575e6821d34b1bf2caccbbc2 Mon Sep 17 00:00:00 2001 From: Haley Elmendorf Date: Thu, 27 Aug 2026 09:58:44 -0500 Subject: [PATCH 2/7] docs: escape generics in SlackAction JSDoc so docs site builds The SlackAction type-alias comment contained raw generic syntax (SlackActionMiddlewareArgs>) that TypeDoc copies verbatim into the generated Markdown. Docusaurus's MDX parser reads the unescaped `<` as a JSX tag and fails the docs-site build. Wrap the generic expressions in backticks (inline code) so they render literally, and regenerate the reference. Co-Authored-By: Claude --- docs/english/reference/type-aliases/SlackAction.md | 4 ++-- src/types/actions/index.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/english/reference/type-aliases/SlackAction.md b/docs/english/reference/type-aliases/SlackAction.md index 018793c9e..23401a7e6 100644 --- a/docs/english/reference/type-aliases/SlackAction.md +++ b/docs/english/reference/type-aliases/SlackAction.md @@ -17,9 +17,9 @@ messages. TODO: BlockAction's default generic parameter (ElementAction) might be too specific to allow for this type to be used as a constraint on SlackActionMiddlewareArgs' Action generic parameter. -If someone were to instantiate SlackActionMiddlewareArgs>, would it work? We need it to +If someone were to instantiate `SlackActionMiddlewareArgs>`, would it work? We need it to work as long as SomeNewAction implements BasicElementAction. -We don't want to substitute BlockAction with BlockAction here because that means the completions +We don't want to substitute BlockAction with `BlockAction` here because that means the completions offered when no generic parameter is bound would be limited to BasicElementAction rather than the union of known actions - ElementAction. diff --git a/src/types/actions/index.ts b/src/types/actions/index.ts index 7a635b5a0..1b36c493e 100644 --- a/src/types/actions/index.ts +++ b/src/types/actions/index.ts @@ -16,10 +16,10 @@ export * from './interactive-message'; * TODO: BlockAction's default generic parameter (ElementAction) might be too specific to allow for this type to be used * as a constraint on SlackActionMiddlewareArgs' Action generic parameter. * - * If someone were to instantiate SlackActionMiddlewareArgs>, would it work? We need it to + * If someone were to instantiate `SlackActionMiddlewareArgs>`, would it work? We need it to * work as long as SomeNewAction implements BasicElementAction. * - * We don't want to substitute BlockAction with BlockAction here because that means the completions + * We don't want to substitute BlockAction with `BlockAction` here because that means the completions * offered when no generic parameter is bound would be limited to BasicElementAction rather than the union of known * actions - ElementAction. */ From adffeeb4f070700b99a9560a383695a2f27b074b Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Thu, 27 Aug 2026 08:50:45 -0700 Subject: [PATCH 3/7] go --- docs/english/_sidebar.json | 4 +++ .../functions/bufferIncomingMessage.md | 4 +++ .../functions/buildContentResponse.md | 4 +++ .../functions/buildNoBodyResponse.md | 4 +++ .../functions/buildSSLCheckResponse.md | 4 +++ .../functions/buildUrlVerificationResponse.md | 4 +++ .../defaultAsyncDispatchErrorHandler.md | 4 +++ .../functions/defaultDispatchErrorHandler.md | 4 +++ .../defaultProcessEventErrorHandler.md | 4 +++ .../defaultUnhandledRequestHandler.md | 4 +++ .../extractRetryNumFromHTTPRequest.md | 4 +++ .../extractRetryReasonFromHTTPRequest.md | 4 +++ .../functions/getHeader.md | 4 +++ .../functions/isBufferedIncomingMessage.md | 4 +++ .../functions/parseAndVerifyHTTPRequest.md | 4 +++ .../functions/parseHTTPRequestBody.md | 4 +++ .../namespaces/HTTPModuleFunctions/index.md | 4 +++ .../ReceiverDispatchErrorHandlerArgs.md | 4 +++ .../ReceiverProcessEventErrorHandlerArgs.md | 4 +++ .../ReceiverUnhandledRequestHandlerArgs.md | 4 +++ .../interfaces/RequestVerificationOptions.md | 4 +++ docs/english/reference/classes/App.md | 4 +++ .../classes/AppInitializationError.md | 4 +++ docs/english/reference/classes/Assistant.md | 4 +++ .../classes/AssistantInitializationError.md | 4 +++ .../classes/AssistantMissingPropertyError.md | 4 +++ .../reference/classes/AuthorizationError.md | 4 +++ .../reference/classes/AwsLambdaReceiver.md | 4 +++ .../classes/ContextMissingPropertyError.md | 4 +++ .../CustomFunctionCompleteFailError.md | 4 +++ .../CustomFunctionCompleteSuccessError.md | 4 +++ .../CustomFunctionInitializationError.md | 4 +++ .../classes/CustomRouteInitializationError.md | 4 +++ .../reference/classes/ExpressReceiver.md | 4 +++ .../english/reference/classes/HTTPReceiver.md | 4 +++ .../HTTPReceiverDeferredRequestError.md | 4 +++ .../reference/classes/HTTPResponseAck.md | 4 +++ .../classes/InvalidCustomPropertyError.md | 4 +++ docs/english/reference/classes/MemoryStore.md | 4 +++ .../classes/MultipleListenerError.md | 4 +++ .../classes/ReceiverAuthenticityError.md | 4 +++ .../classes/ReceiverInconsistentStateError.md | 4 +++ .../classes/ReceiverMultipleAckError.md | 4 +++ .../english/reference/classes/RespondError.md | 4 +++ .../reference/classes/SocketModeReceiver.md | 4 +++ .../english/reference/classes/UnknownError.md | 4 +++ .../reference/enumerations/ErrorCode.md | 4 +++ .../reference/functions/asCodedError.md | 4 +++ .../functions/buildReceiverRoutes.md | 4 +++ .../defaultProcessEventErrorHandler.md | 4 +++ .../reference/functions/isCodedError.md | 4 +++ .../reference/functions/isFulfilled.md | 4 +++ .../english/reference/functions/isRejected.md | 4 +++ .../isSlackEventMiddlewareArgsOptions.md | 4 +++ .../functions/isValidSlackRequest.md | 4 +++ .../reference/functions/matchCommandName.md | 4 +++ .../reference/functions/matchConstraints.md | 4 +++ .../reference/functions/matchEventType.md | 4 +++ .../reference/functions/matchMessage.md | 4 +++ docs/english/reference/functions/subtype.md | 4 +++ .../reference/functions/verifySlackRequest.md | 4 +++ docs/english/reference/index.md | 4 +++ .../reference/interfaces/ActionConstraints.md | 4 +++ .../reference/interfaces/AllMiddlewareArgs.md | 4 +++ .../reference/interfaces/AppOptions.md | 4 +++ .../reference/interfaces/AssistantConfig.md | 4 +++ .../reference/interfaces/AuthorizeResult.md | 4 +++ .../interfaces/AuthorizeSourceData.md | 4 +++ .../interfaces/AwsLambdaReceiverOptions.md | 4 +++ .../reference/interfaces/BaseSlackEvent.md | 4 +++ .../interfaces/BasicElementAction.md | 4 +++ .../interfaces/BasicOptionsPayload.md | 4 +++ .../reference/interfaces/BlockAction.md | 4 +++ .../reference/interfaces/BlockOptions.md | 4 +++ .../reference/interfaces/BlockSuggestion.md | 4 +++ .../interfaces/BufferedIncomingMessage.md | 4 +++ .../reference/interfaces/ButtonAction.md | 4 +++ .../reference/interfaces/ButtonClick.md | 4 +++ .../interfaces/ChannelsSelectAction.md | 4 +++ .../reference/interfaces/CheckboxesAction.md | 4 +++ .../reference/interfaces/CodedError.md | 4 +++ docs/english/reference/interfaces/Context.md | 4 +++ .../reference/interfaces/ConversationStore.md | 4 +++ .../interfaces/ConversationsSelectAction.md | 4 +++ .../reference/interfaces/CustomRoute.md | 4 +++ .../reference/interfaces/DatepickerAction.md | 4 +++ .../interfaces/DialogOptionGroups.md | 4 +++ .../reference/interfaces/DialogOptions.md | 4 +++ .../interfaces/DialogSubmitAction.md | 4 +++ .../reference/interfaces/DialogSuggestion.md | 4 +++ .../reference/interfaces/DialogValidation.md | 4 +++ .../reference/interfaces/EnvelopedEvent.md | 4 +++ .../interfaces/ExpressReceiverOptions.md | 4 +++ .../interfaces/ExternalSelectAction.md | 4 +++ .../interfaces/FeedbackButtonsAction.md | 4 +++ .../reference/interfaces/GlobalShortcut.md | 4 +++ .../interfaces/HTTPReceiverOptions.md | 4 +++ .../reference/interfaces/IconButtonAction.md | 4 +++ .../interfaces/InteractiveMessage.md | 4 +++ .../InteractiveMessageSuggestion.md | 4 +++ .../reference/interfaces/MenuSelect.md | 4 +++ .../reference/interfaces/MessageOptions.md | 4 +++ .../reference/interfaces/MessageShortcut.md | 4 +++ .../interfaces/MultiChannelsSelectAction.md | 4 +++ .../MultiConversationsSelectAction.md | 4 +++ .../interfaces/MultiExternalSelectAction.md | 4 +++ .../interfaces/MultiStaticSelectAction.md | 4 +++ .../interfaces/MultiUsersSelectAction.md | 4 +++ .../reference/interfaces/OptionGroups.md | 4 +++ .../interfaces/OptionsConstraints.md | 4 +++ .../reference/interfaces/OverflowAction.md | 4 +++ .../interfaces/PlainTextInputAction.md | 4 +++ .../interfaces/RadioButtonsAction.md | 4 +++ docs/english/reference/interfaces/Receiver.md | 4 +++ .../reference/interfaces/ReceiverEvent.md | 4 +++ .../reference/interfaces/ReceiverRoutes.md | 4 +++ .../reference/interfaces/ResponseAck.md | 4 +++ .../interfaces/RichTextInputAction.md | 4 +++ .../interfaces/ShortcutConstraints.md | 4 +++ .../interfaces/SlackCommandMiddlewareArgs.md | 4 +++ .../interfaces/SlackOptionsMiddlewareArgs.md | 4 +++ .../interfaces/SlackViewMiddlewareArgs.md | 4 +++ .../reference/interfaces/SlashCommand.md | 4 +++ .../interfaces/SocketModeReceiverOptions.md | 4 +++ ...odeReceiverProcessEventErrorHandlerArgs.md | 4 +++ .../interfaces/StaticSelectAction.md | 4 +++ .../reference/interfaces/TimepickerAction.md | 4 +++ .../reference/interfaces/UploadedFile.md | 4 +++ .../reference/interfaces/UsersSelectAction.md | 4 +++ .../interfaces/ViewClearResponseAction.md | 4 +++ .../reference/interfaces/ViewClosedAction.md | 4 +++ .../reference/interfaces/ViewConstraints.md | 4 +++ .../interfaces/ViewErrorsResponseAction.md | 4 +++ .../reference/interfaces/ViewOutput.md | 4 +++ .../interfaces/ViewPushResponseAction.md | 4 +++ .../reference/interfaces/ViewResponseUrl.md | 4 +++ .../interfaces/ViewStateSelectedOption.md | 4 +++ .../reference/interfaces/ViewStateValue.md | 4 +++ .../reference/interfaces/ViewSubmitAction.md | 4 +++ .../interfaces/ViewUpdateResponseAction.md | 4 +++ docs/english/reference/type-aliases/AckFn.md | 4 +++ .../type-aliases/AnyMiddlewareArgs.md | 4 +++ ...AssistantThreadContextChangedMiddleware.md | 4 +++ .../AssistantThreadStartedMiddleware.md | 4 +++ .../AssistantUserMessageMiddleware.md | 4 +++ .../reference/type-aliases/Authorize.md | 4 +++ .../type-aliases/BlockButtonAction.md | 4 +++ .../type-aliases/BlockChannelsSelectAction.md | 4 +++ .../type-aliases/BlockCheckboxesAction.md | 4 +++ .../BlockConversationsSelectAction.md | 4 +++ .../type-aliases/BlockDatepickerAction.md | 4 +++ .../type-aliases/BlockElementAction.md | 4 +++ .../type-aliases/BlockExternalSelectAction.md | 4 +++ .../BlockFeedbackButtonsAction.md | 4 +++ .../type-aliases/BlockIconButtonAction.md | 4 +++ .../type-aliases/BlockOverflowAction.md | 4 +++ .../type-aliases/BlockPlainTextInputAction.md | 4 +++ .../type-aliases/BlockRadioButtonsAction.md | 4 +++ .../type-aliases/BlockStaticSelectAction.md | 4 +++ .../type-aliases/BlockTimepickerAction.md | 4 +++ .../type-aliases/BlockUsersSelectAction.md | 4 +++ .../reference/type-aliases/EventFromType.md | 4 +++ .../type-aliases/EventTypePattern.md | 4 +++ .../reference/type-aliases/FunctionInputs.md | 4 +++ .../type-aliases/InteractiveAction.md | 4 +++ .../type-aliases/InteractiveButtonClick.md | 4 +++ .../type-aliases/InteractiveMenuSelect.md | 4 +++ .../type-aliases/KnownEventFromType.md | 4 +++ .../KnownOptionsPayloadFromType.md | 4 +++ .../reference/type-aliases/Middleware.md | 4 +++ docs/english/reference/type-aliases/NextFn.md | 4 +++ .../type-aliases/OptionsPayloadFromType.md | 4 +++ .../reference/type-aliases/OptionsSource.md | 4 +++ .../type-aliases/RespondArguments.md | 4 +++ .../reference/type-aliases/RespondFn.md | 4 +++ .../reference/type-aliases/SayArguments.md | 4 +++ docs/english/reference/type-aliases/SayFn.md | 4 +++ .../type-aliases/SayStreamArguments.md | 4 +++ .../reference/type-aliases/SayStreamFn.md | 4 +++ .../type-aliases/SetStatusArguments.md | 4 +++ .../reference/type-aliases/SetStatusFn.md | 4 +++ .../reference/type-aliases/SlackAction.md | 4 +++ .../type-aliases/SlackActionMiddlewareArgs.md | 4 +++ .../type-aliases/SlackEventMiddlewareArgs.md | 4 +++ .../SlackEventMiddlewareArgsOptions.md | 4 +++ .../reference/type-aliases/SlackOptions.md | 4 +++ .../reference/type-aliases/SlackShortcut.md | 4 +++ .../SlackShortcutMiddlewareArgs.md | 4 +++ .../reference/type-aliases/SlackViewAction.md | 4 +++ .../reference/type-aliases/StringIndexed.md | 4 +++ .../type-aliases/ViewResponseAction.md | 4 +++ docs/english/reference/type-aliases/XOR.md | 4 +++ .../reference/variables/autoAcknowledge.md | 4 +++ .../reference/variables/contextBuiltinKeys.md | 4 +++ .../reference/variables/directMention.md | 4 +++ .../english/reference/variables/ignoreSelf.md | 4 +++ .../reference/variables/onlyActions.md | 4 +++ .../reference/variables/onlyCommands.md | 4 +++ .../english/reference/variables/onlyEvents.md | 4 +++ .../reference/variables/onlyOptions.md | 4 +++ .../reference/variables/onlyShortcuts.md | 4 +++ .../reference/variables/onlyViewActions.md | 4 +++ package.json | 2 +- typedoc-plugin-sidebar-labels.mjs | 26 +++++++++++++++++++ typedoc.json | 2 +- 205 files changed, 836 insertions(+), 2 deletions(-) create mode 100644 typedoc-plugin-sidebar-labels.mjs diff --git a/docs/english/_sidebar.json b/docs/english/_sidebar.json index 009b95c22..ada2284e8 100644 --- a/docs/english/_sidebar.json +++ b/docs/english/_sidebar.json @@ -116,6 +116,10 @@ { "type": "category", "label": "Reference", + "link": { + "type": "doc", + "id": "tools/bolt-js/reference/index" + }, "items": [ { "type": "autogenerated", diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md index 9af8edb83..99131a1d0 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "bufferIncomingMessage" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / bufferIncomingMessage # Function: bufferIncomingMessage() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md index 91496ef38..6083f855a 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "buildContentResponse" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildContentResponse # Function: buildContentResponse() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md index d04c0570e..70ce9c6c3 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "buildNoBodyResponse" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildNoBodyResponse # Function: buildNoBodyResponse() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md index 88520ea8d..1481869b2 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "buildSSLCheckResponse" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildSSLCheckResponse # Function: buildSSLCheckResponse() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md index ed09e6c7c..e9f8ba528 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "buildUrlVerificationResponse" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildUrlVerificationResponse # Function: buildUrlVerificationResponse() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md index 41e8c3f71..fde0509ee 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "defaultAsyncDispatchErrorHandler" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultAsyncDispatchErrorHandler # Function: defaultAsyncDispatchErrorHandler() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md index 08d27148e..3b2ea8beb 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "defaultDispatchErrorHandler" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultDispatchErrorHandler # Function: defaultDispatchErrorHandler() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md index 74fb71b52..c27a50251 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "defaultProcessEventErrorHandler" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultProcessEventErrorHandler # Function: defaultProcessEventErrorHandler() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md index f69790e59..887e5a69d 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "defaultUnhandledRequestHandler" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultUnhandledRequestHandler # Function: defaultUnhandledRequestHandler() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md index d46919aaf..e5e774560 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "extractRetryNumFromHTTPRequest" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / extractRetryNumFromHTTPRequest # Function: extractRetryNumFromHTTPRequest() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md index 8130c030f..5a4cc4331 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "extractRetryReasonFromHTTPRequest" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / extractRetryReasonFromHTTPRequest # Function: extractRetryReasonFromHTTPRequest() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md index 6bfb659e2..0c7d069c5 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "getHeader" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / getHeader # Function: getHeader() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md index 8557d64b3..d9cd9bc51 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "isBufferedIncomingMessage" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / isBufferedIncomingMessage # Function: isBufferedIncomingMessage() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md index 613bbb8f3..644ed9b90 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "parseAndVerifyHTTPRequest" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / parseAndVerifyHTTPRequest # Function: parseAndVerifyHTTPRequest() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md index 858f0f2c2..7f3bd7741 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "parseHTTPRequestBody" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / parseHTTPRequestBody # Function: parseHTTPRequestBody() diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md index 620f3c767..7623510a1 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "HTTPModuleFunctions" +--- + [@slack/bolt](../../../index.md) / HTTPModuleFunctions # HTTPModuleFunctions diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md index 9ffba7196..53e229032 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverDispatchErrorHandlerArgs" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverDispatchErrorHandlerArgs # Interface: ReceiverDispatchErrorHandlerArgs diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md index d71f21c24..40ee3a1c1 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverProcessEventErrorHandlerArgs" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverProcessEventErrorHandlerArgs # Interface: ReceiverProcessEventErrorHandlerArgs diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md index 6a1ea7796..8affb6488 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverUnhandledRequestHandlerArgs" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverUnhandledRequestHandlerArgs # Interface: ReceiverUnhandledRequestHandlerArgs diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md index e55389d79..279027935 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "RequestVerificationOptions" +--- + [@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / RequestVerificationOptions # Interface: RequestVerificationOptions diff --git a/docs/english/reference/classes/App.md b/docs/english/reference/classes/App.md index 0e21bfb85..b487b5fe3 100644 --- a/docs/english/reference/classes/App.md +++ b/docs/english/reference/classes/App.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "App" +--- + [@slack/bolt](../index.md) / App # Class: App\ diff --git a/docs/english/reference/classes/AppInitializationError.md b/docs/english/reference/classes/AppInitializationError.md index a796ef050..26ef1be9d 100644 --- a/docs/english/reference/classes/AppInitializationError.md +++ b/docs/english/reference/classes/AppInitializationError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AppInitializationError" +--- + [@slack/bolt](../index.md) / AppInitializationError # Class: AppInitializationError diff --git a/docs/english/reference/classes/Assistant.md b/docs/english/reference/classes/Assistant.md index 9ecf58865..4fe945981 100644 --- a/docs/english/reference/classes/Assistant.md +++ b/docs/english/reference/classes/Assistant.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "Assistant" +--- + [@slack/bolt](../index.md) / Assistant # Class: Assistant diff --git a/docs/english/reference/classes/AssistantInitializationError.md b/docs/english/reference/classes/AssistantInitializationError.md index 28cc6eeac..528a4a125 100644 --- a/docs/english/reference/classes/AssistantInitializationError.md +++ b/docs/english/reference/classes/AssistantInitializationError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AssistantInitializationError" +--- + [@slack/bolt](../index.md) / AssistantInitializationError # Class: AssistantInitializationError diff --git a/docs/english/reference/classes/AssistantMissingPropertyError.md b/docs/english/reference/classes/AssistantMissingPropertyError.md index f9a71c183..ecc74f1ae 100644 --- a/docs/english/reference/classes/AssistantMissingPropertyError.md +++ b/docs/english/reference/classes/AssistantMissingPropertyError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AssistantMissingPropertyError" +--- + [@slack/bolt](../index.md) / AssistantMissingPropertyError # Class: AssistantMissingPropertyError diff --git a/docs/english/reference/classes/AuthorizationError.md b/docs/english/reference/classes/AuthorizationError.md index c11cb57cf..b4a3162fa 100644 --- a/docs/english/reference/classes/AuthorizationError.md +++ b/docs/english/reference/classes/AuthorizationError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AuthorizationError" +--- + [@slack/bolt](../index.md) / AuthorizationError # Class: AuthorizationError diff --git a/docs/english/reference/classes/AwsLambdaReceiver.md b/docs/english/reference/classes/AwsLambdaReceiver.md index d6bc0dd1a..860f841d1 100644 --- a/docs/english/reference/classes/AwsLambdaReceiver.md +++ b/docs/english/reference/classes/AwsLambdaReceiver.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AwsLambdaReceiver" +--- + [@slack/bolt](../index.md) / AwsLambdaReceiver # Class: AwsLambdaReceiver diff --git a/docs/english/reference/classes/ContextMissingPropertyError.md b/docs/english/reference/classes/ContextMissingPropertyError.md index be849fcc0..3d18b146d 100644 --- a/docs/english/reference/classes/ContextMissingPropertyError.md +++ b/docs/english/reference/classes/ContextMissingPropertyError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ContextMissingPropertyError" +--- + [@slack/bolt](../index.md) / ContextMissingPropertyError # Class: ContextMissingPropertyError diff --git a/docs/english/reference/classes/CustomFunctionCompleteFailError.md b/docs/english/reference/classes/CustomFunctionCompleteFailError.md index 2ba8cf435..11bd3006b 100644 --- a/docs/english/reference/classes/CustomFunctionCompleteFailError.md +++ b/docs/english/reference/classes/CustomFunctionCompleteFailError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "CustomFunctionCompleteFailError" +--- + [@slack/bolt](../index.md) / CustomFunctionCompleteFailError # Class: CustomFunctionCompleteFailError diff --git a/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md index 1e06b1ebb..ba0be2292 100644 --- a/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md +++ b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "CustomFunctionCompleteSuccessError" +--- + [@slack/bolt](../index.md) / CustomFunctionCompleteSuccessError # Class: CustomFunctionCompleteSuccessError diff --git a/docs/english/reference/classes/CustomFunctionInitializationError.md b/docs/english/reference/classes/CustomFunctionInitializationError.md index f35901e9c..407762cda 100644 --- a/docs/english/reference/classes/CustomFunctionInitializationError.md +++ b/docs/english/reference/classes/CustomFunctionInitializationError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "CustomFunctionInitializationError" +--- + [@slack/bolt](../index.md) / CustomFunctionInitializationError # Class: CustomFunctionInitializationError diff --git a/docs/english/reference/classes/CustomRouteInitializationError.md b/docs/english/reference/classes/CustomRouteInitializationError.md index fae8b67c2..34c98c46b 100644 --- a/docs/english/reference/classes/CustomRouteInitializationError.md +++ b/docs/english/reference/classes/CustomRouteInitializationError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "CustomRouteInitializationError" +--- + [@slack/bolt](../index.md) / CustomRouteInitializationError # Class: CustomRouteInitializationError diff --git a/docs/english/reference/classes/ExpressReceiver.md b/docs/english/reference/classes/ExpressReceiver.md index db464fda2..02b299845 100644 --- a/docs/english/reference/classes/ExpressReceiver.md +++ b/docs/english/reference/classes/ExpressReceiver.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ExpressReceiver" +--- + [@slack/bolt](../index.md) / ExpressReceiver # Class: ExpressReceiver diff --git a/docs/english/reference/classes/HTTPReceiver.md b/docs/english/reference/classes/HTTPReceiver.md index d9fafa850..d0a6de504 100644 --- a/docs/english/reference/classes/HTTPReceiver.md +++ b/docs/english/reference/classes/HTTPReceiver.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "HTTPReceiver" +--- + [@slack/bolt](../index.md) / HTTPReceiver # Class: HTTPReceiver diff --git a/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md index f56cfce23..8f890500c 100644 --- a/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md +++ b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "HTTPReceiverDeferredRequestError" +--- + [@slack/bolt](../index.md) / HTTPReceiverDeferredRequestError # Class: HTTPReceiverDeferredRequestError diff --git a/docs/english/reference/classes/HTTPResponseAck.md b/docs/english/reference/classes/HTTPResponseAck.md index 9c707ffa0..e334c3328 100644 --- a/docs/english/reference/classes/HTTPResponseAck.md +++ b/docs/english/reference/classes/HTTPResponseAck.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "HTTPResponseAck" +--- + [@slack/bolt](../index.md) / HTTPResponseAck # Class: HTTPResponseAck diff --git a/docs/english/reference/classes/InvalidCustomPropertyError.md b/docs/english/reference/classes/InvalidCustomPropertyError.md index 963cb05e4..8961c46e3 100644 --- a/docs/english/reference/classes/InvalidCustomPropertyError.md +++ b/docs/english/reference/classes/InvalidCustomPropertyError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "InvalidCustomPropertyError" +--- + [@slack/bolt](../index.md) / InvalidCustomPropertyError # Class: InvalidCustomPropertyError diff --git a/docs/english/reference/classes/MemoryStore.md b/docs/english/reference/classes/MemoryStore.md index 386401252..a168f640e 100644 --- a/docs/english/reference/classes/MemoryStore.md +++ b/docs/english/reference/classes/MemoryStore.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MemoryStore" +--- + [@slack/bolt](../index.md) / MemoryStore # Class: MemoryStore\ diff --git a/docs/english/reference/classes/MultipleListenerError.md b/docs/english/reference/classes/MultipleListenerError.md index 5fa6ca1d3..e5e890dde 100644 --- a/docs/english/reference/classes/MultipleListenerError.md +++ b/docs/english/reference/classes/MultipleListenerError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MultipleListenerError" +--- + [@slack/bolt](../index.md) / MultipleListenerError # Class: MultipleListenerError diff --git a/docs/english/reference/classes/ReceiverAuthenticityError.md b/docs/english/reference/classes/ReceiverAuthenticityError.md index 23b38c4a3..4e6740e32 100644 --- a/docs/english/reference/classes/ReceiverAuthenticityError.md +++ b/docs/english/reference/classes/ReceiverAuthenticityError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverAuthenticityError" +--- + [@slack/bolt](../index.md) / ReceiverAuthenticityError # Class: ReceiverAuthenticityError diff --git a/docs/english/reference/classes/ReceiverInconsistentStateError.md b/docs/english/reference/classes/ReceiverInconsistentStateError.md index 785c7088b..c901f5bcd 100644 --- a/docs/english/reference/classes/ReceiverInconsistentStateError.md +++ b/docs/english/reference/classes/ReceiverInconsistentStateError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverInconsistentStateError" +--- + [@slack/bolt](../index.md) / ReceiverInconsistentStateError # Class: ReceiverInconsistentStateError diff --git a/docs/english/reference/classes/ReceiverMultipleAckError.md b/docs/english/reference/classes/ReceiverMultipleAckError.md index 9416f38dd..69832a8c5 100644 --- a/docs/english/reference/classes/ReceiverMultipleAckError.md +++ b/docs/english/reference/classes/ReceiverMultipleAckError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverMultipleAckError" +--- + [@slack/bolt](../index.md) / ReceiverMultipleAckError # Class: ReceiverMultipleAckError diff --git a/docs/english/reference/classes/RespondError.md b/docs/english/reference/classes/RespondError.md index a812d99de..fecfa59bd 100644 --- a/docs/english/reference/classes/RespondError.md +++ b/docs/english/reference/classes/RespondError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "RespondError" +--- + [@slack/bolt](../index.md) / RespondError # Class: RespondError diff --git a/docs/english/reference/classes/SocketModeReceiver.md b/docs/english/reference/classes/SocketModeReceiver.md index 603d25e6d..2ee99bb83 100644 --- a/docs/english/reference/classes/SocketModeReceiver.md +++ b/docs/english/reference/classes/SocketModeReceiver.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SocketModeReceiver" +--- + [@slack/bolt](../index.md) / SocketModeReceiver # Class: SocketModeReceiver diff --git a/docs/english/reference/classes/UnknownError.md b/docs/english/reference/classes/UnknownError.md index ea3017df9..10d705a1f 100644 --- a/docs/english/reference/classes/UnknownError.md +++ b/docs/english/reference/classes/UnknownError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "UnknownError" +--- + [@slack/bolt](../index.md) / UnknownError # Class: UnknownError diff --git a/docs/english/reference/enumerations/ErrorCode.md b/docs/english/reference/enumerations/ErrorCode.md index f54da7149..68d30fc1c 100644 --- a/docs/english/reference/enumerations/ErrorCode.md +++ b/docs/english/reference/enumerations/ErrorCode.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ErrorCode" +--- + [@slack/bolt](../index.md) / ErrorCode # Enumeration: ErrorCode diff --git a/docs/english/reference/functions/asCodedError.md b/docs/english/reference/functions/asCodedError.md index a2092b6da..bbd0f6d88 100644 --- a/docs/english/reference/functions/asCodedError.md +++ b/docs/english/reference/functions/asCodedError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "asCodedError" +--- + [@slack/bolt](../index.md) / asCodedError # Function: asCodedError() diff --git a/docs/english/reference/functions/buildReceiverRoutes.md b/docs/english/reference/functions/buildReceiverRoutes.md index d1ab604f4..58e24ee04 100644 --- a/docs/english/reference/functions/buildReceiverRoutes.md +++ b/docs/english/reference/functions/buildReceiverRoutes.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "buildReceiverRoutes" +--- + [@slack/bolt](../index.md) / buildReceiverRoutes # Function: buildReceiverRoutes() diff --git a/docs/english/reference/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/functions/defaultProcessEventErrorHandler.md index 7c74f95a0..939b119fc 100644 --- a/docs/english/reference/functions/defaultProcessEventErrorHandler.md +++ b/docs/english/reference/functions/defaultProcessEventErrorHandler.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "defaultProcessEventErrorHandler" +--- + [@slack/bolt](../index.md) / defaultProcessEventErrorHandler # Function: defaultProcessEventErrorHandler() diff --git a/docs/english/reference/functions/isCodedError.md b/docs/english/reference/functions/isCodedError.md index b082a9bb8..8fd5ebfb2 100644 --- a/docs/english/reference/functions/isCodedError.md +++ b/docs/english/reference/functions/isCodedError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "isCodedError" +--- + [@slack/bolt](../index.md) / isCodedError # Function: isCodedError() diff --git a/docs/english/reference/functions/isFulfilled.md b/docs/english/reference/functions/isFulfilled.md index 17fb0364e..d88cbfad5 100644 --- a/docs/english/reference/functions/isFulfilled.md +++ b/docs/english/reference/functions/isFulfilled.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "isFulfilled" +--- + [@slack/bolt](../index.md) / isFulfilled # Function: isFulfilled() diff --git a/docs/english/reference/functions/isRejected.md b/docs/english/reference/functions/isRejected.md index a1ef1b2dd..9fe9cc5c2 100644 --- a/docs/english/reference/functions/isRejected.md +++ b/docs/english/reference/functions/isRejected.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "isRejected" +--- + [@slack/bolt](../index.md) / isRejected # Function: isRejected() diff --git a/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md index b9b048c12..8bb5b69d2 100644 --- a/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md +++ b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "isSlackEventMiddlewareArgsOptions" +--- + [@slack/bolt](../index.md) / isSlackEventMiddlewareArgsOptions # Function: isSlackEventMiddlewareArgsOptions() diff --git a/docs/english/reference/functions/isValidSlackRequest.md b/docs/english/reference/functions/isValidSlackRequest.md index 9db2b7f49..191c48ba7 100644 --- a/docs/english/reference/functions/isValidSlackRequest.md +++ b/docs/english/reference/functions/isValidSlackRequest.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "isValidSlackRequest" +--- + [@slack/bolt](../index.md) / isValidSlackRequest # Function: isValidSlackRequest() diff --git a/docs/english/reference/functions/matchCommandName.md b/docs/english/reference/functions/matchCommandName.md index 56f36d9cf..b9a2f75f6 100644 --- a/docs/english/reference/functions/matchCommandName.md +++ b/docs/english/reference/functions/matchCommandName.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "matchCommandName" +--- + [@slack/bolt](../index.md) / matchCommandName # Function: matchCommandName() diff --git a/docs/english/reference/functions/matchConstraints.md b/docs/english/reference/functions/matchConstraints.md index 40ce4a416..f50ba8378 100644 --- a/docs/english/reference/functions/matchConstraints.md +++ b/docs/english/reference/functions/matchConstraints.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "matchConstraints" +--- + [@slack/bolt](../index.md) / matchConstraints # Function: matchConstraints() diff --git a/docs/english/reference/functions/matchEventType.md b/docs/english/reference/functions/matchEventType.md index 3414905f5..493ddf504 100644 --- a/docs/english/reference/functions/matchEventType.md +++ b/docs/english/reference/functions/matchEventType.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "matchEventType" +--- + [@slack/bolt](../index.md) / matchEventType # Function: matchEventType() diff --git a/docs/english/reference/functions/matchMessage.md b/docs/english/reference/functions/matchMessage.md index 8c959445c..360a54594 100644 --- a/docs/english/reference/functions/matchMessage.md +++ b/docs/english/reference/functions/matchMessage.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "matchMessage" +--- + [@slack/bolt](../index.md) / matchMessage # Function: matchMessage() diff --git a/docs/english/reference/functions/subtype.md b/docs/english/reference/functions/subtype.md index 964b2c40f..26362c585 100644 --- a/docs/english/reference/functions/subtype.md +++ b/docs/english/reference/functions/subtype.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "subtype" +--- + [@slack/bolt](../index.md) / subtype # Function: subtype() diff --git a/docs/english/reference/functions/verifySlackRequest.md b/docs/english/reference/functions/verifySlackRequest.md index d2f8c172f..24ed7b8aa 100644 --- a/docs/english/reference/functions/verifySlackRequest.md +++ b/docs/english/reference/functions/verifySlackRequest.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "verifySlackRequest" +--- + [@slack/bolt](../index.md) / verifySlackRequest # Function: verifySlackRequest() diff --git a/docs/english/reference/index.md b/docs/english/reference/index.md index 5a293b146..987f31985 100644 --- a/docs/english/reference/index.md +++ b/docs/english/reference/index.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "@slack/bolt" +--- + # @slack/bolt v5.0.0 ## Namespaces diff --git a/docs/english/reference/interfaces/ActionConstraints.md b/docs/english/reference/interfaces/ActionConstraints.md index 517b560f4..3882ac964 100644 --- a/docs/english/reference/interfaces/ActionConstraints.md +++ b/docs/english/reference/interfaces/ActionConstraints.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ActionConstraints" +--- + [@slack/bolt](../index.md) / ActionConstraints # Interface: ActionConstraints\ diff --git a/docs/english/reference/interfaces/AllMiddlewareArgs.md b/docs/english/reference/interfaces/AllMiddlewareArgs.md index 183d7719e..10535c881 100644 --- a/docs/english/reference/interfaces/AllMiddlewareArgs.md +++ b/docs/english/reference/interfaces/AllMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AllMiddlewareArgs" +--- + [@slack/bolt](../index.md) / AllMiddlewareArgs # Interface: AllMiddlewareArgs\ diff --git a/docs/english/reference/interfaces/AppOptions.md b/docs/english/reference/interfaces/AppOptions.md index afe01723a..3a4b64896 100644 --- a/docs/english/reference/interfaces/AppOptions.md +++ b/docs/english/reference/interfaces/AppOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AppOptions" +--- + [@slack/bolt](../index.md) / AppOptions # Interface: AppOptions diff --git a/docs/english/reference/interfaces/AssistantConfig.md b/docs/english/reference/interfaces/AssistantConfig.md index 030610269..5aa5e4dac 100644 --- a/docs/english/reference/interfaces/AssistantConfig.md +++ b/docs/english/reference/interfaces/AssistantConfig.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AssistantConfig" +--- + [@slack/bolt](../index.md) / AssistantConfig # Interface: AssistantConfig diff --git a/docs/english/reference/interfaces/AuthorizeResult.md b/docs/english/reference/interfaces/AuthorizeResult.md index 4bd768ba3..eb97cec16 100644 --- a/docs/english/reference/interfaces/AuthorizeResult.md +++ b/docs/english/reference/interfaces/AuthorizeResult.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AuthorizeResult" +--- + [@slack/bolt](../index.md) / AuthorizeResult # Interface: AuthorizeResult diff --git a/docs/english/reference/interfaces/AuthorizeSourceData.md b/docs/english/reference/interfaces/AuthorizeSourceData.md index 8fa5a7532..b8f0a8674 100644 --- a/docs/english/reference/interfaces/AuthorizeSourceData.md +++ b/docs/english/reference/interfaces/AuthorizeSourceData.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AuthorizeSourceData" +--- + [@slack/bolt](../index.md) / AuthorizeSourceData # Interface: AuthorizeSourceData\ diff --git a/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md index 523ae7552..3f60833e8 100644 --- a/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md +++ b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AwsLambdaReceiverOptions" +--- + [@slack/bolt](../index.md) / AwsLambdaReceiverOptions # Interface: AwsLambdaReceiverOptions diff --git a/docs/english/reference/interfaces/BaseSlackEvent.md b/docs/english/reference/interfaces/BaseSlackEvent.md index 6253b88b4..3e97fcb36 100644 --- a/docs/english/reference/interfaces/BaseSlackEvent.md +++ b/docs/english/reference/interfaces/BaseSlackEvent.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BaseSlackEvent" +--- + [@slack/bolt](../index.md) / BaseSlackEvent # Interface: BaseSlackEvent\ diff --git a/docs/english/reference/interfaces/BasicElementAction.md b/docs/english/reference/interfaces/BasicElementAction.md index c0a688fdc..c002fcff6 100644 --- a/docs/english/reference/interfaces/BasicElementAction.md +++ b/docs/english/reference/interfaces/BasicElementAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BasicElementAction" +--- + [@slack/bolt](../index.md) / BasicElementAction # Interface: BasicElementAction\ diff --git a/docs/english/reference/interfaces/BasicOptionsPayload.md b/docs/english/reference/interfaces/BasicOptionsPayload.md index f33a1fe95..600145c82 100644 --- a/docs/english/reference/interfaces/BasicOptionsPayload.md +++ b/docs/english/reference/interfaces/BasicOptionsPayload.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BasicOptionsPayload" +--- + [@slack/bolt](../index.md) / BasicOptionsPayload # Interface: BasicOptionsPayload\ diff --git a/docs/english/reference/interfaces/BlockAction.md b/docs/english/reference/interfaces/BlockAction.md index 926bd2598..c77632532 100644 --- a/docs/english/reference/interfaces/BlockAction.md +++ b/docs/english/reference/interfaces/BlockAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockAction" +--- + [@slack/bolt](../index.md) / BlockAction # Interface: BlockAction\ diff --git a/docs/english/reference/interfaces/BlockOptions.md b/docs/english/reference/interfaces/BlockOptions.md index f0a84aba9..fed7b7062 100644 --- a/docs/english/reference/interfaces/BlockOptions.md +++ b/docs/english/reference/interfaces/BlockOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockOptions" +--- + [@slack/bolt](../index.md) / BlockOptions # Interface: BlockOptions diff --git a/docs/english/reference/interfaces/BlockSuggestion.md b/docs/english/reference/interfaces/BlockSuggestion.md index 9a1b79381..dcadec998 100644 --- a/docs/english/reference/interfaces/BlockSuggestion.md +++ b/docs/english/reference/interfaces/BlockSuggestion.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockSuggestion" +--- + [@slack/bolt](../index.md) / BlockSuggestion # Interface: BlockSuggestion diff --git a/docs/english/reference/interfaces/BufferedIncomingMessage.md b/docs/english/reference/interfaces/BufferedIncomingMessage.md index 9d47f4c0f..157876070 100644 --- a/docs/english/reference/interfaces/BufferedIncomingMessage.md +++ b/docs/english/reference/interfaces/BufferedIncomingMessage.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BufferedIncomingMessage" +--- + [@slack/bolt](../index.md) / BufferedIncomingMessage # Interface: BufferedIncomingMessage diff --git a/docs/english/reference/interfaces/ButtonAction.md b/docs/english/reference/interfaces/ButtonAction.md index d61a50597..a8929a41b 100644 --- a/docs/english/reference/interfaces/ButtonAction.md +++ b/docs/english/reference/interfaces/ButtonAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ButtonAction" +--- + [@slack/bolt](../index.md) / ButtonAction # Interface: ButtonAction diff --git a/docs/english/reference/interfaces/ButtonClick.md b/docs/english/reference/interfaces/ButtonClick.md index bb2d9b6e7..e1b0e504f 100644 --- a/docs/english/reference/interfaces/ButtonClick.md +++ b/docs/english/reference/interfaces/ButtonClick.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ButtonClick" +--- + [@slack/bolt](../index.md) / ButtonClick # Interface: ButtonClick diff --git a/docs/english/reference/interfaces/ChannelsSelectAction.md b/docs/english/reference/interfaces/ChannelsSelectAction.md index 772669c4e..7bbb9a239 100644 --- a/docs/english/reference/interfaces/ChannelsSelectAction.md +++ b/docs/english/reference/interfaces/ChannelsSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ChannelsSelectAction" +--- + [@slack/bolt](../index.md) / ChannelsSelectAction # Interface: ChannelsSelectAction diff --git a/docs/english/reference/interfaces/CheckboxesAction.md b/docs/english/reference/interfaces/CheckboxesAction.md index 0e09d6f68..4b58d27c8 100644 --- a/docs/english/reference/interfaces/CheckboxesAction.md +++ b/docs/english/reference/interfaces/CheckboxesAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "CheckboxesAction" +--- + [@slack/bolt](../index.md) / CheckboxesAction # Interface: CheckboxesAction diff --git a/docs/english/reference/interfaces/CodedError.md b/docs/english/reference/interfaces/CodedError.md index 34cfb8015..57517d477 100644 --- a/docs/english/reference/interfaces/CodedError.md +++ b/docs/english/reference/interfaces/CodedError.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "CodedError" +--- + [@slack/bolt](../index.md) / CodedError # Interface: CodedError diff --git a/docs/english/reference/interfaces/Context.md b/docs/english/reference/interfaces/Context.md index 60aa90865..f117bda97 100644 --- a/docs/english/reference/interfaces/Context.md +++ b/docs/english/reference/interfaces/Context.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "Context" +--- + [@slack/bolt](../index.md) / Context # Interface: Context diff --git a/docs/english/reference/interfaces/ConversationStore.md b/docs/english/reference/interfaces/ConversationStore.md index 36e164d09..eb97b254c 100644 --- a/docs/english/reference/interfaces/ConversationStore.md +++ b/docs/english/reference/interfaces/ConversationStore.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ConversationStore" +--- + [@slack/bolt](../index.md) / ConversationStore # Interface: ConversationStore\ diff --git a/docs/english/reference/interfaces/ConversationsSelectAction.md b/docs/english/reference/interfaces/ConversationsSelectAction.md index 366bd8361..44beae51b 100644 --- a/docs/english/reference/interfaces/ConversationsSelectAction.md +++ b/docs/english/reference/interfaces/ConversationsSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ConversationsSelectAction" +--- + [@slack/bolt](../index.md) / ConversationsSelectAction # Interface: ConversationsSelectAction diff --git a/docs/english/reference/interfaces/CustomRoute.md b/docs/english/reference/interfaces/CustomRoute.md index a0ecbac77..cc2368e29 100644 --- a/docs/english/reference/interfaces/CustomRoute.md +++ b/docs/english/reference/interfaces/CustomRoute.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "CustomRoute" +--- + [@slack/bolt](../index.md) / CustomRoute # Interface: CustomRoute diff --git a/docs/english/reference/interfaces/DatepickerAction.md b/docs/english/reference/interfaces/DatepickerAction.md index 3af86b9f6..ac065e934 100644 --- a/docs/english/reference/interfaces/DatepickerAction.md +++ b/docs/english/reference/interfaces/DatepickerAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "DatepickerAction" +--- + [@slack/bolt](../index.md) / DatepickerAction # Interface: DatepickerAction diff --git a/docs/english/reference/interfaces/DialogOptionGroups.md b/docs/english/reference/interfaces/DialogOptionGroups.md index 685c443cc..98db3fba7 100644 --- a/docs/english/reference/interfaces/DialogOptionGroups.md +++ b/docs/english/reference/interfaces/DialogOptionGroups.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "DialogOptionGroups" +--- + [@slack/bolt](../index.md) / DialogOptionGroups # Interface: DialogOptionGroups\ diff --git a/docs/english/reference/interfaces/DialogOptions.md b/docs/english/reference/interfaces/DialogOptions.md index 088a6089f..07b82057c 100644 --- a/docs/english/reference/interfaces/DialogOptions.md +++ b/docs/english/reference/interfaces/DialogOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "DialogOptions" +--- + [@slack/bolt](../index.md) / DialogOptions # Interface: DialogOptions diff --git a/docs/english/reference/interfaces/DialogSubmitAction.md b/docs/english/reference/interfaces/DialogSubmitAction.md index 7ec57cb68..97d0342c1 100644 --- a/docs/english/reference/interfaces/DialogSubmitAction.md +++ b/docs/english/reference/interfaces/DialogSubmitAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "DialogSubmitAction" +--- + [@slack/bolt](../index.md) / DialogSubmitAction # Interface: DialogSubmitAction diff --git a/docs/english/reference/interfaces/DialogSuggestion.md b/docs/english/reference/interfaces/DialogSuggestion.md index 393953936..7af283859 100644 --- a/docs/english/reference/interfaces/DialogSuggestion.md +++ b/docs/english/reference/interfaces/DialogSuggestion.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "DialogSuggestion" +--- + [@slack/bolt](../index.md) / DialogSuggestion # Interface: DialogSuggestion diff --git a/docs/english/reference/interfaces/DialogValidation.md b/docs/english/reference/interfaces/DialogValidation.md index 92a529af5..d539812ea 100644 --- a/docs/english/reference/interfaces/DialogValidation.md +++ b/docs/english/reference/interfaces/DialogValidation.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "DialogValidation" +--- + [@slack/bolt](../index.md) / DialogValidation # Interface: DialogValidation diff --git a/docs/english/reference/interfaces/EnvelopedEvent.md b/docs/english/reference/interfaces/EnvelopedEvent.md index 716d62106..d95085439 100644 --- a/docs/english/reference/interfaces/EnvelopedEvent.md +++ b/docs/english/reference/interfaces/EnvelopedEvent.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "EnvelopedEvent" +--- + [@slack/bolt](../index.md) / EnvelopedEvent # Interface: EnvelopedEvent\ diff --git a/docs/english/reference/interfaces/ExpressReceiverOptions.md b/docs/english/reference/interfaces/ExpressReceiverOptions.md index 758546204..af1df00ef 100644 --- a/docs/english/reference/interfaces/ExpressReceiverOptions.md +++ b/docs/english/reference/interfaces/ExpressReceiverOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ExpressReceiverOptions" +--- + [@slack/bolt](../index.md) / ExpressReceiverOptions # Interface: ExpressReceiverOptions diff --git a/docs/english/reference/interfaces/ExternalSelectAction.md b/docs/english/reference/interfaces/ExternalSelectAction.md index 9a4322ff1..f798c2478 100644 --- a/docs/english/reference/interfaces/ExternalSelectAction.md +++ b/docs/english/reference/interfaces/ExternalSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ExternalSelectAction" +--- + [@slack/bolt](../index.md) / ExternalSelectAction # Interface: ExternalSelectAction diff --git a/docs/english/reference/interfaces/FeedbackButtonsAction.md b/docs/english/reference/interfaces/FeedbackButtonsAction.md index 5e0081917..b17814237 100644 --- a/docs/english/reference/interfaces/FeedbackButtonsAction.md +++ b/docs/english/reference/interfaces/FeedbackButtonsAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "FeedbackButtonsAction" +--- + [@slack/bolt](../index.md) / FeedbackButtonsAction # Interface: FeedbackButtonsAction diff --git a/docs/english/reference/interfaces/GlobalShortcut.md b/docs/english/reference/interfaces/GlobalShortcut.md index abc124ef8..683b3cad1 100644 --- a/docs/english/reference/interfaces/GlobalShortcut.md +++ b/docs/english/reference/interfaces/GlobalShortcut.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "GlobalShortcut" +--- + [@slack/bolt](../index.md) / GlobalShortcut # Interface: GlobalShortcut diff --git a/docs/english/reference/interfaces/HTTPReceiverOptions.md b/docs/english/reference/interfaces/HTTPReceiverOptions.md index 81768d304..fff1e2e87 100644 --- a/docs/english/reference/interfaces/HTTPReceiverOptions.md +++ b/docs/english/reference/interfaces/HTTPReceiverOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "HTTPReceiverOptions" +--- + [@slack/bolt](../index.md) / HTTPReceiverOptions # Interface: HTTPReceiverOptions diff --git a/docs/english/reference/interfaces/IconButtonAction.md b/docs/english/reference/interfaces/IconButtonAction.md index 05f878fd7..5abdfa25d 100644 --- a/docs/english/reference/interfaces/IconButtonAction.md +++ b/docs/english/reference/interfaces/IconButtonAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "IconButtonAction" +--- + [@slack/bolt](../index.md) / IconButtonAction # Interface: IconButtonAction diff --git a/docs/english/reference/interfaces/InteractiveMessage.md b/docs/english/reference/interfaces/InteractiveMessage.md index e07aeba1b..6891791a8 100644 --- a/docs/english/reference/interfaces/InteractiveMessage.md +++ b/docs/english/reference/interfaces/InteractiveMessage.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "InteractiveMessage" +--- + [@slack/bolt](../index.md) / InteractiveMessage # Interface: InteractiveMessage\ diff --git a/docs/english/reference/interfaces/InteractiveMessageSuggestion.md b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md index b9ac2bbcd..aff2818fc 100644 --- a/docs/english/reference/interfaces/InteractiveMessageSuggestion.md +++ b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "InteractiveMessageSuggestion" +--- + [@slack/bolt](../index.md) / InteractiveMessageSuggestion # Interface: InteractiveMessageSuggestion diff --git a/docs/english/reference/interfaces/MenuSelect.md b/docs/english/reference/interfaces/MenuSelect.md index 67844cccb..c51c22845 100644 --- a/docs/english/reference/interfaces/MenuSelect.md +++ b/docs/english/reference/interfaces/MenuSelect.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MenuSelect" +--- + [@slack/bolt](../index.md) / MenuSelect # Interface: MenuSelect diff --git a/docs/english/reference/interfaces/MessageOptions.md b/docs/english/reference/interfaces/MessageOptions.md index 1b63b1f2d..e67b9850b 100644 --- a/docs/english/reference/interfaces/MessageOptions.md +++ b/docs/english/reference/interfaces/MessageOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MessageOptions" +--- + [@slack/bolt](../index.md) / MessageOptions # Interface: MessageOptions diff --git a/docs/english/reference/interfaces/MessageShortcut.md b/docs/english/reference/interfaces/MessageShortcut.md index 93b2e3e0c..4ded0a82f 100644 --- a/docs/english/reference/interfaces/MessageShortcut.md +++ b/docs/english/reference/interfaces/MessageShortcut.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MessageShortcut" +--- + [@slack/bolt](../index.md) / MessageShortcut # Interface: MessageShortcut diff --git a/docs/english/reference/interfaces/MultiChannelsSelectAction.md b/docs/english/reference/interfaces/MultiChannelsSelectAction.md index ff4b6d3a6..9afd346db 100644 --- a/docs/english/reference/interfaces/MultiChannelsSelectAction.md +++ b/docs/english/reference/interfaces/MultiChannelsSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MultiChannelsSelectAction" +--- + [@slack/bolt](../index.md) / MultiChannelsSelectAction # Interface: MultiChannelsSelectAction diff --git a/docs/english/reference/interfaces/MultiConversationsSelectAction.md b/docs/english/reference/interfaces/MultiConversationsSelectAction.md index 6132aa893..1f91f3abc 100644 --- a/docs/english/reference/interfaces/MultiConversationsSelectAction.md +++ b/docs/english/reference/interfaces/MultiConversationsSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MultiConversationsSelectAction" +--- + [@slack/bolt](../index.md) / MultiConversationsSelectAction # Interface: MultiConversationsSelectAction diff --git a/docs/english/reference/interfaces/MultiExternalSelectAction.md b/docs/english/reference/interfaces/MultiExternalSelectAction.md index a3657ad50..0ccb76a4d 100644 --- a/docs/english/reference/interfaces/MultiExternalSelectAction.md +++ b/docs/english/reference/interfaces/MultiExternalSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MultiExternalSelectAction" +--- + [@slack/bolt](../index.md) / MultiExternalSelectAction # Interface: MultiExternalSelectAction diff --git a/docs/english/reference/interfaces/MultiStaticSelectAction.md b/docs/english/reference/interfaces/MultiStaticSelectAction.md index 9d071f2d0..49c99d2b4 100644 --- a/docs/english/reference/interfaces/MultiStaticSelectAction.md +++ b/docs/english/reference/interfaces/MultiStaticSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MultiStaticSelectAction" +--- + [@slack/bolt](../index.md) / MultiStaticSelectAction # Interface: MultiStaticSelectAction diff --git a/docs/english/reference/interfaces/MultiUsersSelectAction.md b/docs/english/reference/interfaces/MultiUsersSelectAction.md index e796f3f01..cdd10633d 100644 --- a/docs/english/reference/interfaces/MultiUsersSelectAction.md +++ b/docs/english/reference/interfaces/MultiUsersSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "MultiUsersSelectAction" +--- + [@slack/bolt](../index.md) / MultiUsersSelectAction # Interface: MultiUsersSelectAction diff --git a/docs/english/reference/interfaces/OptionGroups.md b/docs/english/reference/interfaces/OptionGroups.md index bf4480ff8..4865b4e4e 100644 --- a/docs/english/reference/interfaces/OptionGroups.md +++ b/docs/english/reference/interfaces/OptionGroups.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "OptionGroups" +--- + [@slack/bolt](../index.md) / OptionGroups # Interface: OptionGroups\ diff --git a/docs/english/reference/interfaces/OptionsConstraints.md b/docs/english/reference/interfaces/OptionsConstraints.md index 0d22b67a6..fdca23f86 100644 --- a/docs/english/reference/interfaces/OptionsConstraints.md +++ b/docs/english/reference/interfaces/OptionsConstraints.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "OptionsConstraints" +--- + [@slack/bolt](../index.md) / OptionsConstraints # Interface: OptionsConstraints\ diff --git a/docs/english/reference/interfaces/OverflowAction.md b/docs/english/reference/interfaces/OverflowAction.md index 691965021..4b2dbb204 100644 --- a/docs/english/reference/interfaces/OverflowAction.md +++ b/docs/english/reference/interfaces/OverflowAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "OverflowAction" +--- + [@slack/bolt](../index.md) / OverflowAction # Interface: OverflowAction diff --git a/docs/english/reference/interfaces/PlainTextInputAction.md b/docs/english/reference/interfaces/PlainTextInputAction.md index 57397354a..2e2d31a15 100644 --- a/docs/english/reference/interfaces/PlainTextInputAction.md +++ b/docs/english/reference/interfaces/PlainTextInputAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "PlainTextInputAction" +--- + [@slack/bolt](../index.md) / PlainTextInputAction # Interface: PlainTextInputAction diff --git a/docs/english/reference/interfaces/RadioButtonsAction.md b/docs/english/reference/interfaces/RadioButtonsAction.md index a497e6515..022edb9bf 100644 --- a/docs/english/reference/interfaces/RadioButtonsAction.md +++ b/docs/english/reference/interfaces/RadioButtonsAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "RadioButtonsAction" +--- + [@slack/bolt](../index.md) / RadioButtonsAction # Interface: RadioButtonsAction diff --git a/docs/english/reference/interfaces/Receiver.md b/docs/english/reference/interfaces/Receiver.md index 9bc6604c6..0f4a5466b 100644 --- a/docs/english/reference/interfaces/Receiver.md +++ b/docs/english/reference/interfaces/Receiver.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "Receiver" +--- + [@slack/bolt](../index.md) / Receiver # Interface: Receiver diff --git a/docs/english/reference/interfaces/ReceiverEvent.md b/docs/english/reference/interfaces/ReceiverEvent.md index 2ff63db8c..3b0b92b98 100644 --- a/docs/english/reference/interfaces/ReceiverEvent.md +++ b/docs/english/reference/interfaces/ReceiverEvent.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverEvent" +--- + [@slack/bolt](../index.md) / ReceiverEvent # Interface: ReceiverEvent diff --git a/docs/english/reference/interfaces/ReceiverRoutes.md b/docs/english/reference/interfaces/ReceiverRoutes.md index 3f1938231..24eafc006 100644 --- a/docs/english/reference/interfaces/ReceiverRoutes.md +++ b/docs/english/reference/interfaces/ReceiverRoutes.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ReceiverRoutes" +--- + [@slack/bolt](../index.md) / ReceiverRoutes # Interface: ReceiverRoutes diff --git a/docs/english/reference/interfaces/ResponseAck.md b/docs/english/reference/interfaces/ResponseAck.md index fd30f6f60..f9c6c13b7 100644 --- a/docs/english/reference/interfaces/ResponseAck.md +++ b/docs/english/reference/interfaces/ResponseAck.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ResponseAck" +--- + [@slack/bolt](../index.md) / ResponseAck # Interface: ResponseAck diff --git a/docs/english/reference/interfaces/RichTextInputAction.md b/docs/english/reference/interfaces/RichTextInputAction.md index 6335855cc..c9bfc12bb 100644 --- a/docs/english/reference/interfaces/RichTextInputAction.md +++ b/docs/english/reference/interfaces/RichTextInputAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "RichTextInputAction" +--- + [@slack/bolt](../index.md) / RichTextInputAction # Interface: RichTextInputAction diff --git a/docs/english/reference/interfaces/ShortcutConstraints.md b/docs/english/reference/interfaces/ShortcutConstraints.md index cc1ded0a9..727525448 100644 --- a/docs/english/reference/interfaces/ShortcutConstraints.md +++ b/docs/english/reference/interfaces/ShortcutConstraints.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ShortcutConstraints" +--- + [@slack/bolt](../index.md) / ShortcutConstraints # Interface: ShortcutConstraints\ diff --git a/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md index ca8cba160..0fb4e7286 100644 --- a/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackCommandMiddlewareArgs" +--- + [@slack/bolt](../index.md) / SlackCommandMiddlewareArgs # Interface: SlackCommandMiddlewareArgs diff --git a/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md index eb94ca8c4..49576721a 100644 --- a/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackOptionsMiddlewareArgs" +--- + [@slack/bolt](../index.md) / SlackOptionsMiddlewareArgs # Interface: SlackOptionsMiddlewareArgs\ diff --git a/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md index 6b3827820..dbb22fd6b 100644 --- a/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackViewMiddlewareArgs" +--- + [@slack/bolt](../index.md) / SlackViewMiddlewareArgs # Interface: SlackViewMiddlewareArgs\ diff --git a/docs/english/reference/interfaces/SlashCommand.md b/docs/english/reference/interfaces/SlashCommand.md index f01c207cd..9892a5dfb 100644 --- a/docs/english/reference/interfaces/SlashCommand.md +++ b/docs/english/reference/interfaces/SlashCommand.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlashCommand" +--- + [@slack/bolt](../index.md) / SlashCommand # Interface: SlashCommand diff --git a/docs/english/reference/interfaces/SocketModeReceiverOptions.md b/docs/english/reference/interfaces/SocketModeReceiverOptions.md index 50c10f4f6..02e5e3ebe 100644 --- a/docs/english/reference/interfaces/SocketModeReceiverOptions.md +++ b/docs/english/reference/interfaces/SocketModeReceiverOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SocketModeReceiverOptions" +--- + [@slack/bolt](../index.md) / SocketModeReceiverOptions # Interface: SocketModeReceiverOptions diff --git a/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md index dc91e485f..efd5419f5 100644 --- a/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md +++ b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SocketModeReceiverProcessEventErrorHandlerArgs" +--- + [@slack/bolt](../index.md) / SocketModeReceiverProcessEventErrorHandlerArgs # Interface: SocketModeReceiverProcessEventErrorHandlerArgs diff --git a/docs/english/reference/interfaces/StaticSelectAction.md b/docs/english/reference/interfaces/StaticSelectAction.md index 6e68cb030..94416118e 100644 --- a/docs/english/reference/interfaces/StaticSelectAction.md +++ b/docs/english/reference/interfaces/StaticSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "StaticSelectAction" +--- + [@slack/bolt](../index.md) / StaticSelectAction # Interface: StaticSelectAction diff --git a/docs/english/reference/interfaces/TimepickerAction.md b/docs/english/reference/interfaces/TimepickerAction.md index 25e5b5afe..ab2c64040 100644 --- a/docs/english/reference/interfaces/TimepickerAction.md +++ b/docs/english/reference/interfaces/TimepickerAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "TimepickerAction" +--- + [@slack/bolt](../index.md) / TimepickerAction # Interface: TimepickerAction diff --git a/docs/english/reference/interfaces/UploadedFile.md b/docs/english/reference/interfaces/UploadedFile.md index 1df5ebad6..6e17ebad2 100644 --- a/docs/english/reference/interfaces/UploadedFile.md +++ b/docs/english/reference/interfaces/UploadedFile.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "UploadedFile" +--- + [@slack/bolt](../index.md) / UploadedFile # Interface: UploadedFile diff --git a/docs/english/reference/interfaces/UsersSelectAction.md b/docs/english/reference/interfaces/UsersSelectAction.md index 184cff797..412cdefd5 100644 --- a/docs/english/reference/interfaces/UsersSelectAction.md +++ b/docs/english/reference/interfaces/UsersSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "UsersSelectAction" +--- + [@slack/bolt](../index.md) / UsersSelectAction # Interface: UsersSelectAction diff --git a/docs/english/reference/interfaces/ViewClearResponseAction.md b/docs/english/reference/interfaces/ViewClearResponseAction.md index 31d625211..e62be3ad6 100644 --- a/docs/english/reference/interfaces/ViewClearResponseAction.md +++ b/docs/english/reference/interfaces/ViewClearResponseAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewClearResponseAction" +--- + [@slack/bolt](../index.md) / ViewClearResponseAction # Interface: ViewClearResponseAction diff --git a/docs/english/reference/interfaces/ViewClosedAction.md b/docs/english/reference/interfaces/ViewClosedAction.md index aeb432379..b7e58ecb1 100644 --- a/docs/english/reference/interfaces/ViewClosedAction.md +++ b/docs/english/reference/interfaces/ViewClosedAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewClosedAction" +--- + [@slack/bolt](../index.md) / ViewClosedAction # Interface: ViewClosedAction diff --git a/docs/english/reference/interfaces/ViewConstraints.md b/docs/english/reference/interfaces/ViewConstraints.md index 88eb0543d..7ac354fa1 100644 --- a/docs/english/reference/interfaces/ViewConstraints.md +++ b/docs/english/reference/interfaces/ViewConstraints.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewConstraints" +--- + [@slack/bolt](../index.md) / ViewConstraints # Interface: ViewConstraints diff --git a/docs/english/reference/interfaces/ViewErrorsResponseAction.md b/docs/english/reference/interfaces/ViewErrorsResponseAction.md index 1f9bdf602..f705322bf 100644 --- a/docs/english/reference/interfaces/ViewErrorsResponseAction.md +++ b/docs/english/reference/interfaces/ViewErrorsResponseAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewErrorsResponseAction" +--- + [@slack/bolt](../index.md) / ViewErrorsResponseAction # Interface: ViewErrorsResponseAction diff --git a/docs/english/reference/interfaces/ViewOutput.md b/docs/english/reference/interfaces/ViewOutput.md index 64b18d82d..a9902431f 100644 --- a/docs/english/reference/interfaces/ViewOutput.md +++ b/docs/english/reference/interfaces/ViewOutput.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewOutput" +--- + [@slack/bolt](../index.md) / ViewOutput # Interface: ViewOutput diff --git a/docs/english/reference/interfaces/ViewPushResponseAction.md b/docs/english/reference/interfaces/ViewPushResponseAction.md index a79e758aa..6115a846a 100644 --- a/docs/english/reference/interfaces/ViewPushResponseAction.md +++ b/docs/english/reference/interfaces/ViewPushResponseAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewPushResponseAction" +--- + [@slack/bolt](../index.md) / ViewPushResponseAction # Interface: ViewPushResponseAction diff --git a/docs/english/reference/interfaces/ViewResponseUrl.md b/docs/english/reference/interfaces/ViewResponseUrl.md index dc975976b..2fed3b01d 100644 --- a/docs/english/reference/interfaces/ViewResponseUrl.md +++ b/docs/english/reference/interfaces/ViewResponseUrl.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewResponseUrl" +--- + [@slack/bolt](../index.md) / ViewResponseUrl # Interface: ViewResponseUrl diff --git a/docs/english/reference/interfaces/ViewStateSelectedOption.md b/docs/english/reference/interfaces/ViewStateSelectedOption.md index 371a71b6d..15becc873 100644 --- a/docs/english/reference/interfaces/ViewStateSelectedOption.md +++ b/docs/english/reference/interfaces/ViewStateSelectedOption.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewStateSelectedOption" +--- + [@slack/bolt](../index.md) / ViewStateSelectedOption # Interface: ViewStateSelectedOption diff --git a/docs/english/reference/interfaces/ViewStateValue.md b/docs/english/reference/interfaces/ViewStateValue.md index 6c4f8c818..a31ba86cb 100644 --- a/docs/english/reference/interfaces/ViewStateValue.md +++ b/docs/english/reference/interfaces/ViewStateValue.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewStateValue" +--- + [@slack/bolt](../index.md) / ViewStateValue # Interface: ViewStateValue diff --git a/docs/english/reference/interfaces/ViewSubmitAction.md b/docs/english/reference/interfaces/ViewSubmitAction.md index 9405a9ed4..7e0c2ecc4 100644 --- a/docs/english/reference/interfaces/ViewSubmitAction.md +++ b/docs/english/reference/interfaces/ViewSubmitAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewSubmitAction" +--- + [@slack/bolt](../index.md) / ViewSubmitAction # Interface: ViewSubmitAction diff --git a/docs/english/reference/interfaces/ViewUpdateResponseAction.md b/docs/english/reference/interfaces/ViewUpdateResponseAction.md index 121b868b8..075c31119 100644 --- a/docs/english/reference/interfaces/ViewUpdateResponseAction.md +++ b/docs/english/reference/interfaces/ViewUpdateResponseAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewUpdateResponseAction" +--- + [@slack/bolt](../index.md) / ViewUpdateResponseAction # Interface: ViewUpdateResponseAction diff --git a/docs/english/reference/type-aliases/AckFn.md b/docs/english/reference/type-aliases/AckFn.md index c22fcf0a9..4369935a6 100644 --- a/docs/english/reference/type-aliases/AckFn.md +++ b/docs/english/reference/type-aliases/AckFn.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AckFn" +--- + [@slack/bolt](../index.md) / AckFn # Type Alias: AckFn\ diff --git a/docs/english/reference/type-aliases/AnyMiddlewareArgs.md b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md index 90e266af7..fc30eaba2 100644 --- a/docs/english/reference/type-aliases/AnyMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AnyMiddlewareArgs" +--- + [@slack/bolt](../index.md) / AnyMiddlewareArgs # Type Alias: AnyMiddlewareArgs diff --git a/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md index 215f5e9c0..474d6eed5 100644 --- a/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AssistantThreadContextChangedMiddleware" +--- + [@slack/bolt](../index.md) / AssistantThreadContextChangedMiddleware # Type Alias: AssistantThreadContextChangedMiddleware diff --git a/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md index 3bd77d149..9f8cb363b 100644 --- a/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AssistantThreadStartedMiddleware" +--- + [@slack/bolt](../index.md) / AssistantThreadStartedMiddleware # Type Alias: AssistantThreadStartedMiddleware diff --git a/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md index 01ddd3bee..5276a8aed 100644 --- a/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "AssistantUserMessageMiddleware" +--- + [@slack/bolt](../index.md) / AssistantUserMessageMiddleware # Type Alias: AssistantUserMessageMiddleware diff --git a/docs/english/reference/type-aliases/Authorize.md b/docs/english/reference/type-aliases/Authorize.md index 121129bc8..c678bb25c 100644 --- a/docs/english/reference/type-aliases/Authorize.md +++ b/docs/english/reference/type-aliases/Authorize.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "Authorize" +--- + [@slack/bolt](../index.md) / Authorize # Type Alias: Authorize\ diff --git a/docs/english/reference/type-aliases/BlockButtonAction.md b/docs/english/reference/type-aliases/BlockButtonAction.md index 81c6de821..552bf65d2 100644 --- a/docs/english/reference/type-aliases/BlockButtonAction.md +++ b/docs/english/reference/type-aliases/BlockButtonAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockButtonAction" +--- + [@slack/bolt](../index.md) / BlockButtonAction # Type Alias: BlockButtonAction diff --git a/docs/english/reference/type-aliases/BlockChannelsSelectAction.md b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md index f98ef1c58..0ea663af7 100644 --- a/docs/english/reference/type-aliases/BlockChannelsSelectAction.md +++ b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockChannelsSelectAction" +--- + [@slack/bolt](../index.md) / BlockChannelsSelectAction # Type Alias: BlockChannelsSelectAction diff --git a/docs/english/reference/type-aliases/BlockCheckboxesAction.md b/docs/english/reference/type-aliases/BlockCheckboxesAction.md index 18ffdcbb9..16612ac32 100644 --- a/docs/english/reference/type-aliases/BlockCheckboxesAction.md +++ b/docs/english/reference/type-aliases/BlockCheckboxesAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockCheckboxesAction" +--- + [@slack/bolt](../index.md) / BlockCheckboxesAction # Type Alias: BlockCheckboxesAction diff --git a/docs/english/reference/type-aliases/BlockConversationsSelectAction.md b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md index 8b8724aef..218bea421 100644 --- a/docs/english/reference/type-aliases/BlockConversationsSelectAction.md +++ b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockConversationsSelectAction" +--- + [@slack/bolt](../index.md) / BlockConversationsSelectAction # Type Alias: BlockConversationsSelectAction diff --git a/docs/english/reference/type-aliases/BlockDatepickerAction.md b/docs/english/reference/type-aliases/BlockDatepickerAction.md index fd3c9e728..2acc56404 100644 --- a/docs/english/reference/type-aliases/BlockDatepickerAction.md +++ b/docs/english/reference/type-aliases/BlockDatepickerAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockDatepickerAction" +--- + [@slack/bolt](../index.md) / BlockDatepickerAction # Type Alias: BlockDatepickerAction diff --git a/docs/english/reference/type-aliases/BlockElementAction.md b/docs/english/reference/type-aliases/BlockElementAction.md index f29f5c71d..bacefa646 100644 --- a/docs/english/reference/type-aliases/BlockElementAction.md +++ b/docs/english/reference/type-aliases/BlockElementAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockElementAction" +--- + [@slack/bolt](../index.md) / BlockElementAction # Type Alias: BlockElementAction diff --git a/docs/english/reference/type-aliases/BlockExternalSelectAction.md b/docs/english/reference/type-aliases/BlockExternalSelectAction.md index 5d95aeebd..60528f079 100644 --- a/docs/english/reference/type-aliases/BlockExternalSelectAction.md +++ b/docs/english/reference/type-aliases/BlockExternalSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockExternalSelectAction" +--- + [@slack/bolt](../index.md) / BlockExternalSelectAction # Type Alias: BlockExternalSelectAction diff --git a/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md index 81da19224..63a92078a 100644 --- a/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md +++ b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockFeedbackButtonsAction" +--- + [@slack/bolt](../index.md) / BlockFeedbackButtonsAction # Type Alias: BlockFeedbackButtonsAction diff --git a/docs/english/reference/type-aliases/BlockIconButtonAction.md b/docs/english/reference/type-aliases/BlockIconButtonAction.md index 9e08724ce..e15f45753 100644 --- a/docs/english/reference/type-aliases/BlockIconButtonAction.md +++ b/docs/english/reference/type-aliases/BlockIconButtonAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockIconButtonAction" +--- + [@slack/bolt](../index.md) / BlockIconButtonAction # Type Alias: BlockIconButtonAction diff --git a/docs/english/reference/type-aliases/BlockOverflowAction.md b/docs/english/reference/type-aliases/BlockOverflowAction.md index d03935713..5555ecb62 100644 --- a/docs/english/reference/type-aliases/BlockOverflowAction.md +++ b/docs/english/reference/type-aliases/BlockOverflowAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockOverflowAction" +--- + [@slack/bolt](../index.md) / BlockOverflowAction # Type Alias: BlockOverflowAction diff --git a/docs/english/reference/type-aliases/BlockPlainTextInputAction.md b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md index dcf8647c4..3f11cf40f 100644 --- a/docs/english/reference/type-aliases/BlockPlainTextInputAction.md +++ b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockPlainTextInputAction" +--- + [@slack/bolt](../index.md) / BlockPlainTextInputAction # Type Alias: BlockPlainTextInputAction diff --git a/docs/english/reference/type-aliases/BlockRadioButtonsAction.md b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md index 555864561..ac7968ec1 100644 --- a/docs/english/reference/type-aliases/BlockRadioButtonsAction.md +++ b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockRadioButtonsAction" +--- + [@slack/bolt](../index.md) / BlockRadioButtonsAction # Type Alias: BlockRadioButtonsAction diff --git a/docs/english/reference/type-aliases/BlockStaticSelectAction.md b/docs/english/reference/type-aliases/BlockStaticSelectAction.md index 70908b0ce..d0346fd4a 100644 --- a/docs/english/reference/type-aliases/BlockStaticSelectAction.md +++ b/docs/english/reference/type-aliases/BlockStaticSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockStaticSelectAction" +--- + [@slack/bolt](../index.md) / BlockStaticSelectAction # Type Alias: BlockStaticSelectAction diff --git a/docs/english/reference/type-aliases/BlockTimepickerAction.md b/docs/english/reference/type-aliases/BlockTimepickerAction.md index a98feff71..2f723c0fa 100644 --- a/docs/english/reference/type-aliases/BlockTimepickerAction.md +++ b/docs/english/reference/type-aliases/BlockTimepickerAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockTimepickerAction" +--- + [@slack/bolt](../index.md) / BlockTimepickerAction # Type Alias: BlockTimepickerAction diff --git a/docs/english/reference/type-aliases/BlockUsersSelectAction.md b/docs/english/reference/type-aliases/BlockUsersSelectAction.md index 4562148be..0ad950fdb 100644 --- a/docs/english/reference/type-aliases/BlockUsersSelectAction.md +++ b/docs/english/reference/type-aliases/BlockUsersSelectAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "BlockUsersSelectAction" +--- + [@slack/bolt](../index.md) / BlockUsersSelectAction # Type Alias: BlockUsersSelectAction diff --git a/docs/english/reference/type-aliases/EventFromType.md b/docs/english/reference/type-aliases/EventFromType.md index d4286598a..7fdb55c59 100644 --- a/docs/english/reference/type-aliases/EventFromType.md +++ b/docs/english/reference/type-aliases/EventFromType.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "EventFromType" +--- + [@slack/bolt](../index.md) / EventFromType # Type Alias: EventFromType\ diff --git a/docs/english/reference/type-aliases/EventTypePattern.md b/docs/english/reference/type-aliases/EventTypePattern.md index fb30bf1f8..813ad3674 100644 --- a/docs/english/reference/type-aliases/EventTypePattern.md +++ b/docs/english/reference/type-aliases/EventTypePattern.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "EventTypePattern" +--- + [@slack/bolt](../index.md) / EventTypePattern # Type Alias: EventTypePattern diff --git a/docs/english/reference/type-aliases/FunctionInputs.md b/docs/english/reference/type-aliases/FunctionInputs.md index 53ba1bd84..8ba159e9d 100644 --- a/docs/english/reference/type-aliases/FunctionInputs.md +++ b/docs/english/reference/type-aliases/FunctionInputs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "FunctionInputs" +--- + [@slack/bolt](../index.md) / FunctionInputs # Type Alias: FunctionInputs diff --git a/docs/english/reference/type-aliases/InteractiveAction.md b/docs/english/reference/type-aliases/InteractiveAction.md index 34c17e017..610c3b51e 100644 --- a/docs/english/reference/type-aliases/InteractiveAction.md +++ b/docs/english/reference/type-aliases/InteractiveAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "InteractiveAction" +--- + [@slack/bolt](../index.md) / InteractiveAction # Type Alias: InteractiveAction diff --git a/docs/english/reference/type-aliases/InteractiveButtonClick.md b/docs/english/reference/type-aliases/InteractiveButtonClick.md index 184698dac..fdc2e3e38 100644 --- a/docs/english/reference/type-aliases/InteractiveButtonClick.md +++ b/docs/english/reference/type-aliases/InteractiveButtonClick.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "InteractiveButtonClick" +--- + [@slack/bolt](../index.md) / InteractiveButtonClick # Type Alias: InteractiveButtonClick diff --git a/docs/english/reference/type-aliases/InteractiveMenuSelect.md b/docs/english/reference/type-aliases/InteractiveMenuSelect.md index 8cfb676fc..6c170b295 100644 --- a/docs/english/reference/type-aliases/InteractiveMenuSelect.md +++ b/docs/english/reference/type-aliases/InteractiveMenuSelect.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "InteractiveMenuSelect" +--- + [@slack/bolt](../index.md) / InteractiveMenuSelect # Type Alias: InteractiveMenuSelect diff --git a/docs/english/reference/type-aliases/KnownEventFromType.md b/docs/english/reference/type-aliases/KnownEventFromType.md index eeca8729e..02f5f6746 100644 --- a/docs/english/reference/type-aliases/KnownEventFromType.md +++ b/docs/english/reference/type-aliases/KnownEventFromType.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "KnownEventFromType" +--- + [@slack/bolt](../index.md) / KnownEventFromType # Type Alias: KnownEventFromType\ diff --git a/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md b/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md index 171865442..806e33520 100644 --- a/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md +++ b/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "KnownOptionsPayloadFromType" +--- + [@slack/bolt](../index.md) / KnownOptionsPayloadFromType # Type Alias: KnownOptionsPayloadFromType\ diff --git a/docs/english/reference/type-aliases/Middleware.md b/docs/english/reference/type-aliases/Middleware.md index 6c0966e38..df06694c2 100644 --- a/docs/english/reference/type-aliases/Middleware.md +++ b/docs/english/reference/type-aliases/Middleware.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "Middleware" +--- + [@slack/bolt](../index.md) / Middleware # Type Alias: Middleware\ diff --git a/docs/english/reference/type-aliases/NextFn.md b/docs/english/reference/type-aliases/NextFn.md index f75332159..fe9471cc7 100644 --- a/docs/english/reference/type-aliases/NextFn.md +++ b/docs/english/reference/type-aliases/NextFn.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "NextFn" +--- + [@slack/bolt](../index.md) / NextFn # Type Alias: NextFn diff --git a/docs/english/reference/type-aliases/OptionsPayloadFromType.md b/docs/english/reference/type-aliases/OptionsPayloadFromType.md index 677c39952..ed0ce5483 100644 --- a/docs/english/reference/type-aliases/OptionsPayloadFromType.md +++ b/docs/english/reference/type-aliases/OptionsPayloadFromType.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "OptionsPayloadFromType" +--- + [@slack/bolt](../index.md) / OptionsPayloadFromType # Type Alias: OptionsPayloadFromType\ diff --git a/docs/english/reference/type-aliases/OptionsSource.md b/docs/english/reference/type-aliases/OptionsSource.md index 1724e99d3..25b9e5b11 100644 --- a/docs/english/reference/type-aliases/OptionsSource.md +++ b/docs/english/reference/type-aliases/OptionsSource.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "OptionsSource" +--- + [@slack/bolt](../index.md) / OptionsSource # Type Alias: OptionsSource diff --git a/docs/english/reference/type-aliases/RespondArguments.md b/docs/english/reference/type-aliases/RespondArguments.md index 9182e05f2..cefd188a0 100644 --- a/docs/english/reference/type-aliases/RespondArguments.md +++ b/docs/english/reference/type-aliases/RespondArguments.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "RespondArguments" +--- + [@slack/bolt](../index.md) / RespondArguments # Type Alias: RespondArguments diff --git a/docs/english/reference/type-aliases/RespondFn.md b/docs/english/reference/type-aliases/RespondFn.md index 5993b9946..119a46ad7 100644 --- a/docs/english/reference/type-aliases/RespondFn.md +++ b/docs/english/reference/type-aliases/RespondFn.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "RespondFn" +--- + [@slack/bolt](../index.md) / RespondFn # Type Alias: RespondFn diff --git a/docs/english/reference/type-aliases/SayArguments.md b/docs/english/reference/type-aliases/SayArguments.md index 6b21b7a1d..e3cda7f58 100644 --- a/docs/english/reference/type-aliases/SayArguments.md +++ b/docs/english/reference/type-aliases/SayArguments.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SayArguments" +--- + [@slack/bolt](../index.md) / SayArguments # Type Alias: SayArguments diff --git a/docs/english/reference/type-aliases/SayFn.md b/docs/english/reference/type-aliases/SayFn.md index cfaaff0b7..4df9c39ea 100644 --- a/docs/english/reference/type-aliases/SayFn.md +++ b/docs/english/reference/type-aliases/SayFn.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SayFn" +--- + [@slack/bolt](../index.md) / SayFn # Type Alias: SayFn diff --git a/docs/english/reference/type-aliases/SayStreamArguments.md b/docs/english/reference/type-aliases/SayStreamArguments.md index a08ff5693..ec767f9ae 100644 --- a/docs/english/reference/type-aliases/SayStreamArguments.md +++ b/docs/english/reference/type-aliases/SayStreamArguments.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SayStreamArguments" +--- + [@slack/bolt](../index.md) / SayStreamArguments # Type Alias: SayStreamArguments diff --git a/docs/english/reference/type-aliases/SayStreamFn.md b/docs/english/reference/type-aliases/SayStreamFn.md index 7a1488052..ece201db4 100644 --- a/docs/english/reference/type-aliases/SayStreamFn.md +++ b/docs/english/reference/type-aliases/SayStreamFn.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SayStreamFn" +--- + [@slack/bolt](../index.md) / SayStreamFn # Type Alias: SayStreamFn diff --git a/docs/english/reference/type-aliases/SetStatusArguments.md b/docs/english/reference/type-aliases/SetStatusArguments.md index a670f0c35..c2e6162f0 100644 --- a/docs/english/reference/type-aliases/SetStatusArguments.md +++ b/docs/english/reference/type-aliases/SetStatusArguments.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SetStatusArguments" +--- + [@slack/bolt](../index.md) / SetStatusArguments # Type Alias: SetStatusArguments diff --git a/docs/english/reference/type-aliases/SetStatusFn.md b/docs/english/reference/type-aliases/SetStatusFn.md index eb72dc5ff..e48b2368e 100644 --- a/docs/english/reference/type-aliases/SetStatusFn.md +++ b/docs/english/reference/type-aliases/SetStatusFn.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SetStatusFn" +--- + [@slack/bolt](../index.md) / SetStatusFn # Type Alias: SetStatusFn diff --git a/docs/english/reference/type-aliases/SlackAction.md b/docs/english/reference/type-aliases/SlackAction.md index 23401a7e6..e4c1bea5c 100644 --- a/docs/english/reference/type-aliases/SlackAction.md +++ b/docs/english/reference/type-aliases/SlackAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackAction" +--- + [@slack/bolt](../index.md) / SlackAction # Type Alias: SlackAction diff --git a/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md index a96455fe5..1da771740 100644 --- a/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackActionMiddlewareArgs" +--- + [@slack/bolt](../index.md) / SlackActionMiddlewareArgs # Type Alias: SlackActionMiddlewareArgs\ diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md index af19d9913..42436cf96 100644 --- a/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackEventMiddlewareArgs" +--- + [@slack/bolt](../index.md) / SlackEventMiddlewareArgs # Type Alias: SlackEventMiddlewareArgs\ diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md index 7ebaf3368..22268fc23 100644 --- a/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackEventMiddlewareArgsOptions" +--- + [@slack/bolt](../index.md) / SlackEventMiddlewareArgsOptions # Type Alias: SlackEventMiddlewareArgsOptions diff --git a/docs/english/reference/type-aliases/SlackOptions.md b/docs/english/reference/type-aliases/SlackOptions.md index 59596dc3e..a8ccf6229 100644 --- a/docs/english/reference/type-aliases/SlackOptions.md +++ b/docs/english/reference/type-aliases/SlackOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackOptions" +--- + [@slack/bolt](../index.md) / SlackOptions # Type Alias: SlackOptions diff --git a/docs/english/reference/type-aliases/SlackShortcut.md b/docs/english/reference/type-aliases/SlackShortcut.md index 99450cdda..7b813c344 100644 --- a/docs/english/reference/type-aliases/SlackShortcut.md +++ b/docs/english/reference/type-aliases/SlackShortcut.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackShortcut" +--- + [@slack/bolt](../index.md) / SlackShortcut # Type Alias: SlackShortcut diff --git a/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md index b3be60bde..4fdcfd9dd 100644 --- a/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackShortcutMiddlewareArgs" +--- + [@slack/bolt](../index.md) / SlackShortcutMiddlewareArgs # Type Alias: SlackShortcutMiddlewareArgs\ diff --git a/docs/english/reference/type-aliases/SlackViewAction.md b/docs/english/reference/type-aliases/SlackViewAction.md index 5e4006316..e891e9807 100644 --- a/docs/english/reference/type-aliases/SlackViewAction.md +++ b/docs/english/reference/type-aliases/SlackViewAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "SlackViewAction" +--- + [@slack/bolt](../index.md) / SlackViewAction # Type Alias: SlackViewAction diff --git a/docs/english/reference/type-aliases/StringIndexed.md b/docs/english/reference/type-aliases/StringIndexed.md index 4a1063c04..2b26fb134 100644 --- a/docs/english/reference/type-aliases/StringIndexed.md +++ b/docs/english/reference/type-aliases/StringIndexed.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "StringIndexed" +--- + [@slack/bolt](../index.md) / StringIndexed # Type Alias: StringIndexed diff --git a/docs/english/reference/type-aliases/ViewResponseAction.md b/docs/english/reference/type-aliases/ViewResponseAction.md index a43f1c95a..afcd10c4b 100644 --- a/docs/english/reference/type-aliases/ViewResponseAction.md +++ b/docs/english/reference/type-aliases/ViewResponseAction.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ViewResponseAction" +--- + [@slack/bolt](../index.md) / ViewResponseAction # Type Alias: ViewResponseAction diff --git a/docs/english/reference/type-aliases/XOR.md b/docs/english/reference/type-aliases/XOR.md index 302eb0adb..8c08b6ff7 100644 --- a/docs/english/reference/type-aliases/XOR.md +++ b/docs/english/reference/type-aliases/XOR.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "XOR" +--- + [@slack/bolt](../index.md) / XOR # Type Alias: XOR\ diff --git a/docs/english/reference/variables/autoAcknowledge.md b/docs/english/reference/variables/autoAcknowledge.md index 38b64d1f9..4a3f91770 100644 --- a/docs/english/reference/variables/autoAcknowledge.md +++ b/docs/english/reference/variables/autoAcknowledge.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "autoAcknowledge" +--- + [@slack/bolt](../index.md) / autoAcknowledge # Variable: autoAcknowledge diff --git a/docs/english/reference/variables/contextBuiltinKeys.md b/docs/english/reference/variables/contextBuiltinKeys.md index f7961e3c7..618915618 100644 --- a/docs/english/reference/variables/contextBuiltinKeys.md +++ b/docs/english/reference/variables/contextBuiltinKeys.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "contextBuiltinKeys" +--- + [@slack/bolt](../index.md) / contextBuiltinKeys # Variable: contextBuiltinKeys diff --git a/docs/english/reference/variables/directMention.md b/docs/english/reference/variables/directMention.md index eed713abe..1eb6bea2c 100644 --- a/docs/english/reference/variables/directMention.md +++ b/docs/english/reference/variables/directMention.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "directMention" +--- + [@slack/bolt](../index.md) / directMention # Variable: directMention diff --git a/docs/english/reference/variables/ignoreSelf.md b/docs/english/reference/variables/ignoreSelf.md index d5581dab0..f27e3ccbb 100644 --- a/docs/english/reference/variables/ignoreSelf.md +++ b/docs/english/reference/variables/ignoreSelf.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "ignoreSelf" +--- + [@slack/bolt](../index.md) / ignoreSelf # Variable: ignoreSelf diff --git a/docs/english/reference/variables/onlyActions.md b/docs/english/reference/variables/onlyActions.md index 18497dd93..6af839f71 100644 --- a/docs/english/reference/variables/onlyActions.md +++ b/docs/english/reference/variables/onlyActions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "onlyActions" +--- + [@slack/bolt](../index.md) / onlyActions # Variable: onlyActions diff --git a/docs/english/reference/variables/onlyCommands.md b/docs/english/reference/variables/onlyCommands.md index 7f49c6a10..39e388d7c 100644 --- a/docs/english/reference/variables/onlyCommands.md +++ b/docs/english/reference/variables/onlyCommands.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "onlyCommands" +--- + [@slack/bolt](../index.md) / onlyCommands # Variable: onlyCommands diff --git a/docs/english/reference/variables/onlyEvents.md b/docs/english/reference/variables/onlyEvents.md index 90fadf6ee..920c803c6 100644 --- a/docs/english/reference/variables/onlyEvents.md +++ b/docs/english/reference/variables/onlyEvents.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "onlyEvents" +--- + [@slack/bolt](../index.md) / onlyEvents # Variable: onlyEvents diff --git a/docs/english/reference/variables/onlyOptions.md b/docs/english/reference/variables/onlyOptions.md index 2dfb3f9a4..5d3b6e708 100644 --- a/docs/english/reference/variables/onlyOptions.md +++ b/docs/english/reference/variables/onlyOptions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "onlyOptions" +--- + [@slack/bolt](../index.md) / onlyOptions # Variable: onlyOptions diff --git a/docs/english/reference/variables/onlyShortcuts.md b/docs/english/reference/variables/onlyShortcuts.md index b789eaa31..5fa297c0f 100644 --- a/docs/english/reference/variables/onlyShortcuts.md +++ b/docs/english/reference/variables/onlyShortcuts.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "onlyShortcuts" +--- + [@slack/bolt](../index.md) / onlyShortcuts # Variable: onlyShortcuts diff --git a/docs/english/reference/variables/onlyViewActions.md b/docs/english/reference/variables/onlyViewActions.md index e63bec8ff..ddfe04b93 100644 --- a/docs/english/reference/variables/onlyViewActions.md +++ b/docs/english/reference/variables/onlyViewActions.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "onlyViewActions" +--- + [@slack/bolt](../index.md) / onlyViewActions # Variable: onlyViewActions diff --git a/package.json b/package.json index 9c2e616b5..770c24db1 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "build": "npm run build:clean && tsc", "build:clean": "shx rm -rf ./dist ./coverage", "changeset": "npx @changesets/cli", - "docs": "npx typedoc --plugin typedoc-plugin-markdown", + "docs": "npx typedoc", "lint": "npx @biomejs/biome check docs src test examples", "lint:fix": "npx @biomejs/biome check --write docs src test examples", "prepare": "npm run build", diff --git a/typedoc-plugin-sidebar-labels.mjs b/typedoc-plugin-sidebar-labels.mjs new file mode 100644 index 000000000..50509dbab --- /dev/null +++ b/typedoc-plugin-sidebar-labels.mjs @@ -0,0 +1,26 @@ +// @ts-check +import { MarkdownPageEvent } from 'typedoc-plugin-markdown'; + +/** + * Local TypeDoc plugin: stamp a `sidebar_label` frontmatter onto every generated + * page equal to the reflection's name. + * + * Why: typedoc-plugin-markdown prints a breadcrumb line before the page's H1, so + * Docusaurus cannot infer a content title and falls back to the doc id's last + * segment. For most pages the segment is the export name ("App"), but for the + * `index.md` of a module/namespace it is literally "index" — which then becomes + * the label of the auto-generated sidebar category (e.g. HTTPModuleFunctions + * rendered as "index"). Emitting an explicit sidebar_label removes the reliance + * on that fallback and keeps category and leaf labels stable across regeneration. + * + * @param {import('typedoc').Application} app + */ +export function load(app) { + app.renderer.on(MarkdownPageEvent.END, (page) => { + const label = page.model?.name; + if (!label) { + return; + } + page.contents = `---\nsidebar_label: ${JSON.stringify(label)}\n---\n\n${page.contents ?? ''}`; + }); +} diff --git a/typedoc.json b/typedoc.json index a1fa9a88c..f45f28fa7 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,7 +1,7 @@ { "$schema": "https://typedoc.org/schema.json", "entryPoints": ["src/index.ts"], - "plugin": ["typedoc-plugin-markdown"], + "plugin": ["typedoc-plugin-markdown", "./typedoc-plugin-sidebar-labels.mjs"], "outputs": [ { "name": "markdown", From c2db202f70db583b10350e5b17fd529b7756a3d4 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Thu, 27 Aug 2026 08:57:18 -0700 Subject: [PATCH 4/7] go --- docs/english/reference/index.md | 1 + typedoc-plugin-sidebar-labels.mjs | 13 +++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/english/reference/index.md b/docs/english/reference/index.md index 987f31985..c49a17756 100644 --- a/docs/english/reference/index.md +++ b/docs/english/reference/index.md @@ -1,5 +1,6 @@ --- sidebar_label: "@slack/bolt" +sidebar_position: 0 --- # @slack/bolt v5.0.0 diff --git a/typedoc-plugin-sidebar-labels.mjs b/typedoc-plugin-sidebar-labels.mjs index 50509dbab..738440baa 100644 --- a/typedoc-plugin-sidebar-labels.mjs +++ b/typedoc-plugin-sidebar-labels.mjs @@ -17,10 +17,19 @@ import { MarkdownPageEvent } from 'typedoc-plugin-markdown'; */ export function load(app) { app.renderer.on(MarkdownPageEvent.END, (page) => { - const label = page.model?.name; + const model = /** @type {any} */ (page.model); + const label = model?.name; if (!label) { return; } - page.contents = `---\nsidebar_label: ${JSON.stringify(label)}\n---\n\n${page.contents ?? ''}`; + const frontmatter = [`sidebar_label: ${JSON.stringify(label)}`]; + // The project root page (reference/index.md) is emitted as a standalone + // sidebar item rather than a category link, so it otherwise sorts + // alphabetically as "index" — landing between "functions" and + // "interfaces". Pin it to the top of the Reference section. + if (typeof model.isProject === 'function' && model.isProject()) { + frontmatter.push('sidebar_position: 0'); + } + page.contents = `---\n${frontmatter.join('\n')}\n---\n\n${page.contents ?? ''}`; }); } From 4f57034dbffba6a49f2fafed329afe119f22955e Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Thu, 27 Aug 2026 10:03:58 -0700 Subject: [PATCH 5/7] go --- .../HTTPModuleFunctions/functions/bufferIncomingMessage.md | 6 ------ .../HTTPModuleFunctions/functions/buildContentResponse.md | 6 ------ .../HTTPModuleFunctions/functions/buildNoBodyResponse.md | 6 ------ .../HTTPModuleFunctions/functions/buildSSLCheckResponse.md | 6 ------ .../functions/buildUrlVerificationResponse.md | 6 ------ .../functions/defaultAsyncDispatchErrorHandler.md | 6 ------ .../functions/defaultDispatchErrorHandler.md | 6 ------ .../functions/defaultProcessEventErrorHandler.md | 6 ------ .../functions/defaultUnhandledRequestHandler.md | 6 ------ .../functions/extractRetryNumFromHTTPRequest.md | 6 ------ .../functions/extractRetryReasonFromHTTPRequest.md | 6 ------ .../namespaces/HTTPModuleFunctions/functions/getHeader.md | 6 ------ .../functions/isBufferedIncomingMessage.md | 6 ------ .../functions/parseAndVerifyHTTPRequest.md | 6 ------ .../HTTPModuleFunctions/functions/parseHTTPRequestBody.md | 6 ------ .../reference/bolt/namespaces/HTTPModuleFunctions/index.md | 6 ------ .../interfaces/ReceiverDispatchErrorHandlerArgs.md | 6 ------ .../interfaces/ReceiverProcessEventErrorHandlerArgs.md | 6 ------ .../interfaces/ReceiverUnhandledRequestHandlerArgs.md | 6 ------ .../interfaces/RequestVerificationOptions.md | 6 ------ docs/english/reference/classes/App.md | 6 ------ docs/english/reference/classes/AppInitializationError.md | 6 ------ docs/english/reference/classes/Assistant.md | 6 ------ .../reference/classes/AssistantInitializationError.md | 6 ------ .../reference/classes/AssistantMissingPropertyError.md | 6 ------ docs/english/reference/classes/AuthorizationError.md | 6 ------ docs/english/reference/classes/AwsLambdaReceiver.md | 6 ------ .../reference/classes/ContextMissingPropertyError.md | 6 ------ .../reference/classes/CustomFunctionCompleteFailError.md | 6 ------ .../reference/classes/CustomFunctionCompleteSuccessError.md | 6 ------ .../reference/classes/CustomFunctionInitializationError.md | 6 ------ .../reference/classes/CustomRouteInitializationError.md | 6 ------ docs/english/reference/classes/ExpressReceiver.md | 6 ------ docs/english/reference/classes/HTTPReceiver.md | 6 ------ .../reference/classes/HTTPReceiverDeferredRequestError.md | 6 ------ docs/english/reference/classes/HTTPResponseAck.md | 6 ------ .../english/reference/classes/InvalidCustomPropertyError.md | 6 ------ docs/english/reference/classes/MemoryStore.md | 6 ------ docs/english/reference/classes/MultipleListenerError.md | 6 ------ docs/english/reference/classes/ReceiverAuthenticityError.md | 6 ------ .../reference/classes/ReceiverInconsistentStateError.md | 6 ------ docs/english/reference/classes/ReceiverMultipleAckError.md | 6 ------ docs/english/reference/classes/RespondError.md | 6 ------ docs/english/reference/classes/SocketModeReceiver.md | 6 ------ docs/english/reference/classes/UnknownError.md | 6 ------ docs/english/reference/enumerations/ErrorCode.md | 6 ------ docs/english/reference/functions/asCodedError.md | 6 ------ docs/english/reference/functions/buildReceiverRoutes.md | 6 ------ .../reference/functions/defaultProcessEventErrorHandler.md | 6 ------ docs/english/reference/functions/isCodedError.md | 6 ------ docs/english/reference/functions/isFulfilled.md | 6 ------ docs/english/reference/functions/isRejected.md | 6 ------ .../functions/isSlackEventMiddlewareArgsOptions.md | 6 ------ docs/english/reference/functions/isValidSlackRequest.md | 6 ------ docs/english/reference/functions/matchCommandName.md | 6 ------ docs/english/reference/functions/matchConstraints.md | 6 ------ docs/english/reference/functions/matchEventType.md | 6 ------ docs/english/reference/functions/matchMessage.md | 6 ------ docs/english/reference/functions/subtype.md | 6 ------ docs/english/reference/functions/verifySlackRequest.md | 6 ------ docs/english/reference/index.md | 5 ----- docs/english/reference/interfaces/ActionConstraints.md | 6 ------ docs/english/reference/interfaces/AllMiddlewareArgs.md | 6 ------ docs/english/reference/interfaces/AppOptions.md | 6 ------ docs/english/reference/interfaces/AssistantConfig.md | 6 ------ docs/english/reference/interfaces/AuthorizeResult.md | 6 ------ docs/english/reference/interfaces/AuthorizeSourceData.md | 6 ------ .../reference/interfaces/AwsLambdaReceiverOptions.md | 6 ------ docs/english/reference/interfaces/BaseSlackEvent.md | 6 ------ docs/english/reference/interfaces/BasicElementAction.md | 6 ------ docs/english/reference/interfaces/BasicOptionsPayload.md | 6 ------ docs/english/reference/interfaces/BlockAction.md | 6 ------ docs/english/reference/interfaces/BlockOptions.md | 6 ------ docs/english/reference/interfaces/BlockSuggestion.md | 6 ------ .../english/reference/interfaces/BufferedIncomingMessage.md | 6 ------ docs/english/reference/interfaces/ButtonAction.md | 6 ------ docs/english/reference/interfaces/ButtonClick.md | 6 ------ docs/english/reference/interfaces/ChannelsSelectAction.md | 6 ------ docs/english/reference/interfaces/CheckboxesAction.md | 6 ------ docs/english/reference/interfaces/CodedError.md | 6 ------ docs/english/reference/interfaces/Context.md | 6 ------ docs/english/reference/interfaces/ConversationStore.md | 6 ------ .../reference/interfaces/ConversationsSelectAction.md | 6 ------ docs/english/reference/interfaces/CustomRoute.md | 6 ------ docs/english/reference/interfaces/DatepickerAction.md | 6 ------ docs/english/reference/interfaces/DialogOptionGroups.md | 6 ------ docs/english/reference/interfaces/DialogOptions.md | 6 ------ docs/english/reference/interfaces/DialogSubmitAction.md | 6 ------ docs/english/reference/interfaces/DialogSuggestion.md | 6 ------ docs/english/reference/interfaces/DialogValidation.md | 6 ------ docs/english/reference/interfaces/EnvelopedEvent.md | 6 ------ docs/english/reference/interfaces/ExpressReceiverOptions.md | 6 ------ docs/english/reference/interfaces/ExternalSelectAction.md | 6 ------ docs/english/reference/interfaces/FeedbackButtonsAction.md | 6 ------ docs/english/reference/interfaces/GlobalShortcut.md | 6 ------ docs/english/reference/interfaces/HTTPReceiverOptions.md | 6 ------ docs/english/reference/interfaces/IconButtonAction.md | 6 ------ docs/english/reference/interfaces/InteractiveMessage.md | 6 ------ .../reference/interfaces/InteractiveMessageSuggestion.md | 6 ------ docs/english/reference/interfaces/MenuSelect.md | 6 ------ docs/english/reference/interfaces/MessageOptions.md | 6 ------ docs/english/reference/interfaces/MessageShortcut.md | 6 ------ .../reference/interfaces/MultiChannelsSelectAction.md | 6 ------ .../reference/interfaces/MultiConversationsSelectAction.md | 6 ------ .../reference/interfaces/MultiExternalSelectAction.md | 6 ------ .../english/reference/interfaces/MultiStaticSelectAction.md | 6 ------ docs/english/reference/interfaces/MultiUsersSelectAction.md | 6 ------ docs/english/reference/interfaces/OptionGroups.md | 6 ------ docs/english/reference/interfaces/OptionsConstraints.md | 6 ------ docs/english/reference/interfaces/OverflowAction.md | 6 ------ docs/english/reference/interfaces/PlainTextInputAction.md | 6 ------ docs/english/reference/interfaces/RadioButtonsAction.md | 6 ------ docs/english/reference/interfaces/Receiver.md | 6 ------ docs/english/reference/interfaces/ReceiverEvent.md | 6 ------ docs/english/reference/interfaces/ReceiverRoutes.md | 6 ------ docs/english/reference/interfaces/ResponseAck.md | 6 ------ docs/english/reference/interfaces/RichTextInputAction.md | 6 ------ docs/english/reference/interfaces/ShortcutConstraints.md | 6 ------ .../reference/interfaces/SlackCommandMiddlewareArgs.md | 6 ------ .../reference/interfaces/SlackOptionsMiddlewareArgs.md | 6 ------ .../english/reference/interfaces/SlackViewMiddlewareArgs.md | 6 ------ docs/english/reference/interfaces/SlashCommand.md | 6 ------ .../reference/interfaces/SocketModeReceiverOptions.md | 6 ------ .../SocketModeReceiverProcessEventErrorHandlerArgs.md | 6 ------ docs/english/reference/interfaces/StaticSelectAction.md | 6 ------ docs/english/reference/interfaces/TimepickerAction.md | 6 ------ docs/english/reference/interfaces/UploadedFile.md | 6 ------ docs/english/reference/interfaces/UsersSelectAction.md | 6 ------ .../english/reference/interfaces/ViewClearResponseAction.md | 6 ------ docs/english/reference/interfaces/ViewClosedAction.md | 6 ------ docs/english/reference/interfaces/ViewConstraints.md | 6 ------ .../reference/interfaces/ViewErrorsResponseAction.md | 6 ------ docs/english/reference/interfaces/ViewOutput.md | 6 ------ docs/english/reference/interfaces/ViewPushResponseAction.md | 6 ------ docs/english/reference/interfaces/ViewResponseUrl.md | 6 ------ .../english/reference/interfaces/ViewStateSelectedOption.md | 6 ------ docs/english/reference/interfaces/ViewStateValue.md | 6 ------ docs/english/reference/interfaces/ViewSubmitAction.md | 6 ------ .../reference/interfaces/ViewUpdateResponseAction.md | 6 ------ docs/english/reference/type-aliases/AckFn.md | 6 ------ docs/english/reference/type-aliases/AnyMiddlewareArgs.md | 6 ------ .../type-aliases/AssistantThreadContextChangedMiddleware.md | 6 ------ .../type-aliases/AssistantThreadStartedMiddleware.md | 6 ------ .../type-aliases/AssistantUserMessageMiddleware.md | 6 ------ docs/english/reference/type-aliases/Authorize.md | 6 ------ docs/english/reference/type-aliases/BlockButtonAction.md | 6 ------ .../reference/type-aliases/BlockChannelsSelectAction.md | 6 ------ .../english/reference/type-aliases/BlockCheckboxesAction.md | 6 ------ .../type-aliases/BlockConversationsSelectAction.md | 6 ------ .../english/reference/type-aliases/BlockDatepickerAction.md | 6 ------ docs/english/reference/type-aliases/BlockElementAction.md | 6 ------ .../reference/type-aliases/BlockExternalSelectAction.md | 6 ------ .../reference/type-aliases/BlockFeedbackButtonsAction.md | 6 ------ .../english/reference/type-aliases/BlockIconButtonAction.md | 6 ------ docs/english/reference/type-aliases/BlockOverflowAction.md | 6 ------ .../reference/type-aliases/BlockPlainTextInputAction.md | 6 ------ .../reference/type-aliases/BlockRadioButtonsAction.md | 6 ------ .../reference/type-aliases/BlockStaticSelectAction.md | 6 ------ .../english/reference/type-aliases/BlockTimepickerAction.md | 6 ------ .../reference/type-aliases/BlockUsersSelectAction.md | 6 ------ docs/english/reference/type-aliases/EventFromType.md | 6 ------ docs/english/reference/type-aliases/EventTypePattern.md | 6 ------ docs/english/reference/type-aliases/FunctionInputs.md | 6 ------ docs/english/reference/type-aliases/InteractiveAction.md | 6 ------ .../reference/type-aliases/InteractiveButtonClick.md | 6 ------ .../english/reference/type-aliases/InteractiveMenuSelect.md | 6 ------ docs/english/reference/type-aliases/KnownEventFromType.md | 6 ------ .../reference/type-aliases/KnownOptionsPayloadFromType.md | 6 ------ docs/english/reference/type-aliases/Middleware.md | 6 ------ docs/english/reference/type-aliases/NextFn.md | 6 ------ .../reference/type-aliases/OptionsPayloadFromType.md | 6 ------ docs/english/reference/type-aliases/OptionsSource.md | 6 ------ docs/english/reference/type-aliases/RespondArguments.md | 6 ------ docs/english/reference/type-aliases/RespondFn.md | 6 ------ docs/english/reference/type-aliases/SayArguments.md | 6 ------ docs/english/reference/type-aliases/SayFn.md | 6 ------ docs/english/reference/type-aliases/SayStreamArguments.md | 6 ------ docs/english/reference/type-aliases/SayStreamFn.md | 6 ------ docs/english/reference/type-aliases/SetStatusArguments.md | 6 ------ docs/english/reference/type-aliases/SetStatusFn.md | 6 ------ docs/english/reference/type-aliases/SlackAction.md | 6 ------ .../reference/type-aliases/SlackActionMiddlewareArgs.md | 6 ------ .../reference/type-aliases/SlackEventMiddlewareArgs.md | 6 ------ .../type-aliases/SlackEventMiddlewareArgsOptions.md | 6 ------ docs/english/reference/type-aliases/SlackOptions.md | 6 ------ docs/english/reference/type-aliases/SlackShortcut.md | 6 ------ .../reference/type-aliases/SlackShortcutMiddlewareArgs.md | 6 ------ docs/english/reference/type-aliases/SlackViewAction.md | 6 ------ docs/english/reference/type-aliases/StringIndexed.md | 6 ------ docs/english/reference/type-aliases/ViewResponseAction.md | 6 ------ docs/english/reference/type-aliases/XOR.md | 6 ------ docs/english/reference/variables/autoAcknowledge.md | 6 ------ docs/english/reference/variables/contextBuiltinKeys.md | 6 ------ docs/english/reference/variables/directMention.md | 6 ------ docs/english/reference/variables/ignoreSelf.md | 6 ------ docs/english/reference/variables/onlyActions.md | 6 ------ docs/english/reference/variables/onlyCommands.md | 6 ------ docs/english/reference/variables/onlyEvents.md | 6 ------ docs/english/reference/variables/onlyOptions.md | 6 ------ docs/english/reference/variables/onlyShortcuts.md | 6 ------ docs/english/reference/variables/onlyViewActions.md | 6 ------ typedoc.json | 3 ++- 202 files changed, 2 insertions(+), 1206 deletions(-) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md index 99131a1d0..378fb3888 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "bufferIncomingMessage" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / bufferIncomingMessage - # Function: bufferIncomingMessage() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md index 6083f855a..82c3cb153 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "buildContentResponse" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildContentResponse - # Function: buildContentResponse() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md index 70ce9c6c3..eb4ce500f 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "buildNoBodyResponse" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildNoBodyResponse - # Function: buildNoBodyResponse() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md index 1481869b2..a37b130ba 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "buildSSLCheckResponse" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildSSLCheckResponse - # Function: buildSSLCheckResponse() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md index e9f8ba528..c9ec752ee 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "buildUrlVerificationResponse" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / buildUrlVerificationResponse - # Function: buildUrlVerificationResponse() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md index fde0509ee..3d93f7836 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "defaultAsyncDispatchErrorHandler" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultAsyncDispatchErrorHandler - # Function: defaultAsyncDispatchErrorHandler() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md index 3b2ea8beb..bab8b103f 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "defaultDispatchErrorHandler" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultDispatchErrorHandler - # Function: defaultDispatchErrorHandler() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md index c27a50251..7fa55d5b2 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "defaultProcessEventErrorHandler" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultProcessEventErrorHandler - # Function: defaultProcessEventErrorHandler() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md index 887e5a69d..ab3f364ca 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "defaultUnhandledRequestHandler" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / defaultUnhandledRequestHandler - # Function: defaultUnhandledRequestHandler() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md index e5e774560..ff19be35e 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "extractRetryNumFromHTTPRequest" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / extractRetryNumFromHTTPRequest - # Function: extractRetryNumFromHTTPRequest() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md index 5a4cc4331..23fcbce4b 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "extractRetryReasonFromHTTPRequest" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / extractRetryReasonFromHTTPRequest - # Function: extractRetryReasonFromHTTPRequest() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md index 0c7d069c5..bf0261521 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "getHeader" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / getHeader - # Function: getHeader() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md index d9cd9bc51..32e5d8ce2 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "isBufferedIncomingMessage" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / isBufferedIncomingMessage - # Function: isBufferedIncomingMessage() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md index 644ed9b90..4da6860e4 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "parseAndVerifyHTTPRequest" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / parseAndVerifyHTTPRequest - # Function: parseAndVerifyHTTPRequest() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md index 7f3bd7741..a5f5e6980 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "parseHTTPRequestBody" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / parseHTTPRequestBody - # Function: parseHTTPRequestBody() ```ts diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md index 7623510a1..ad14f471d 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "HTTPModuleFunctions" ---- - -[@slack/bolt](../../../index.md) / HTTPModuleFunctions - # HTTPModuleFunctions ## Interfaces diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md index 53e229032..535d9f358 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverDispatchErrorHandlerArgs" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverDispatchErrorHandlerArgs - # Interface: ReceiverDispatchErrorHandlerArgs Defined in: [src/receivers/HTTPModuleFunctions.ts:236](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L236) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md index 40ee3a1c1..977d72bc8 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverProcessEventErrorHandlerArgs" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverProcessEventErrorHandlerArgs - # Interface: ReceiverProcessEventErrorHandlerArgs Defined in: [src/receivers/HTTPModuleFunctions.ts:245](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L245) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md index 8affb6488..4aa1cc19a 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverUnhandledRequestHandlerArgs" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / ReceiverUnhandledRequestHandlerArgs - # Interface: ReceiverUnhandledRequestHandlerArgs Defined in: [src/receivers/HTTPModuleFunctions.ts:257](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L257) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md index 279027935..f479f87c4 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "RequestVerificationOptions" ---- - -[@slack/bolt](../../../../index.md) / [HTTPModuleFunctions](../index.md) / RequestVerificationOptions - # Interface: RequestVerificationOptions Defined in: [src/receivers/HTTPModuleFunctions.ts:228](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L228) diff --git a/docs/english/reference/classes/App.md b/docs/english/reference/classes/App.md index b487b5fe3..4fe7df5be 100644 --- a/docs/english/reference/classes/App.md +++ b/docs/english/reference/classes/App.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "App" ---- - -[@slack/bolt](../index.md) / App - # Class: App\ Defined in: [src/App.ts:233](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L233) diff --git a/docs/english/reference/classes/AppInitializationError.md b/docs/english/reference/classes/AppInitializationError.md index 26ef1be9d..fe16c7d39 100644 --- a/docs/english/reference/classes/AppInitializationError.md +++ b/docs/english/reference/classes/AppInitializationError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AppInitializationError" ---- - -[@slack/bolt](../index.md) / AppInitializationError - # Class: AppInitializationError Defined in: [src/errors.ts:72](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L72) diff --git a/docs/english/reference/classes/Assistant.md b/docs/english/reference/classes/Assistant.md index 4fe945981..db8168b91 100644 --- a/docs/english/reference/classes/Assistant.md +++ b/docs/english/reference/classes/Assistant.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "Assistant" ---- - -[@slack/bolt](../index.md) / Assistant - # Class: Assistant Defined in: [src/Assistant.ts:99](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L99) diff --git a/docs/english/reference/classes/AssistantInitializationError.md b/docs/english/reference/classes/AssistantInitializationError.md index 528a4a125..9e3563cf9 100644 --- a/docs/english/reference/classes/AssistantInitializationError.md +++ b/docs/english/reference/classes/AssistantInitializationError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AssistantInitializationError" ---- - -[@slack/bolt](../index.md) / AssistantInitializationError - # Class: AssistantInitializationError Defined in: [src/errors.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L76) diff --git a/docs/english/reference/classes/AssistantMissingPropertyError.md b/docs/english/reference/classes/AssistantMissingPropertyError.md index ecc74f1ae..e2fb14bec 100644 --- a/docs/english/reference/classes/AssistantMissingPropertyError.md +++ b/docs/english/reference/classes/AssistantMissingPropertyError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AssistantMissingPropertyError" ---- - -[@slack/bolt](../index.md) / AssistantMissingPropertyError - # Class: AssistantMissingPropertyError Defined in: [src/errors.ts:80](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L80) diff --git a/docs/english/reference/classes/AuthorizationError.md b/docs/english/reference/classes/AuthorizationError.md index b4a3162fa..fb4745c2b 100644 --- a/docs/english/reference/classes/AuthorizationError.md +++ b/docs/english/reference/classes/AuthorizationError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AuthorizationError" ---- - -[@slack/bolt](../index.md) / AuthorizationError - # Class: AuthorizationError Defined in: [src/errors.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L84) diff --git a/docs/english/reference/classes/AwsLambdaReceiver.md b/docs/english/reference/classes/AwsLambdaReceiver.md index 860f841d1..4d85c1f66 100644 --- a/docs/english/reference/classes/AwsLambdaReceiver.md +++ b/docs/english/reference/classes/AwsLambdaReceiver.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AwsLambdaReceiver" ---- - -[@slack/bolt](../index.md) / AwsLambdaReceiver - # Class: AwsLambdaReceiver Defined in: [src/receivers/AwsLambdaReceiver.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L131) diff --git a/docs/english/reference/classes/ContextMissingPropertyError.md b/docs/english/reference/classes/ContextMissingPropertyError.md index 3d18b146d..103b9a09d 100644 --- a/docs/english/reference/classes/ContextMissingPropertyError.md +++ b/docs/english/reference/classes/ContextMissingPropertyError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ContextMissingPropertyError" ---- - -[@slack/bolt](../index.md) / ContextMissingPropertyError - # Class: ContextMissingPropertyError Defined in: [src/errors.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L96) diff --git a/docs/english/reference/classes/CustomFunctionCompleteFailError.md b/docs/english/reference/classes/CustomFunctionCompleteFailError.md index 11bd3006b..862b3e15d 100644 --- a/docs/english/reference/classes/CustomFunctionCompleteFailError.md +++ b/docs/english/reference/classes/CustomFunctionCompleteFailError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "CustomFunctionCompleteFailError" ---- - -[@slack/bolt](../index.md) / CustomFunctionCompleteFailError - # Class: CustomFunctionCompleteFailError Defined in: [src/errors.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L177) diff --git a/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md index ba0be2292..c508de1e5 100644 --- a/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md +++ b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "CustomFunctionCompleteSuccessError" ---- - -[@slack/bolt](../index.md) / CustomFunctionCompleteSuccessError - # Class: CustomFunctionCompleteSuccessError Defined in: [src/errors.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L173) diff --git a/docs/english/reference/classes/CustomFunctionInitializationError.md b/docs/english/reference/classes/CustomFunctionInitializationError.md index 407762cda..55d3eed1c 100644 --- a/docs/english/reference/classes/CustomFunctionInitializationError.md +++ b/docs/english/reference/classes/CustomFunctionInitializationError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "CustomFunctionInitializationError" ---- - -[@slack/bolt](../index.md) / CustomFunctionInitializationError - # Class: CustomFunctionInitializationError Defined in: [src/errors.ts:169](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L169) diff --git a/docs/english/reference/classes/CustomRouteInitializationError.md b/docs/english/reference/classes/CustomRouteInitializationError.md index 34c98c46b..02a9fd4be 100644 --- a/docs/english/reference/classes/CustomRouteInitializationError.md +++ b/docs/english/reference/classes/CustomRouteInitializationError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "CustomRouteInitializationError" ---- - -[@slack/bolt](../index.md) / CustomRouteInitializationError - # Class: CustomRouteInitializationError Defined in: [src/errors.ts:111](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L111) diff --git a/docs/english/reference/classes/ExpressReceiver.md b/docs/english/reference/classes/ExpressReceiver.md index 02b299845..dcd51daf1 100644 --- a/docs/english/reference/classes/ExpressReceiver.md +++ b/docs/english/reference/classes/ExpressReceiver.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ExpressReceiver" ---- - -[@slack/bolt](../index.md) / ExpressReceiver - # Class: ExpressReceiver Defined in: [src/receivers/ExpressReceiver.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L145) diff --git a/docs/english/reference/classes/HTTPReceiver.md b/docs/english/reference/classes/HTTPReceiver.md index d0a6de504..b13901eb8 100644 --- a/docs/english/reference/classes/HTTPReceiver.md +++ b/docs/english/reference/classes/HTTPReceiver.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "HTTPReceiver" ---- - -[@slack/bolt](../index.md) / HTTPReceiver - # Class: HTTPReceiver Defined in: [src/receivers/HTTPReceiver.ts:128](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L128) diff --git a/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md index 8f890500c..b3c03f628 100644 --- a/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md +++ b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "HTTPReceiverDeferredRequestError" ---- - -[@slack/bolt](../index.md) / HTTPReceiverDeferredRequestError - # Class: HTTPReceiverDeferredRequestError Defined in: [src/errors.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L131) diff --git a/docs/english/reference/classes/HTTPResponseAck.md b/docs/english/reference/classes/HTTPResponseAck.md index e334c3328..00c98d4c5 100644 --- a/docs/english/reference/classes/HTTPResponseAck.md +++ b/docs/english/reference/classes/HTTPResponseAck.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "HTTPResponseAck" ---- - -[@slack/bolt](../index.md) / HTTPResponseAck - # Class: HTTPResponseAck Defined in: [src/receivers/HTTPResponseAck.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPResponseAck.ts#L21) diff --git a/docs/english/reference/classes/InvalidCustomPropertyError.md b/docs/english/reference/classes/InvalidCustomPropertyError.md index 8961c46e3..b37f52411 100644 --- a/docs/english/reference/classes/InvalidCustomPropertyError.md +++ b/docs/english/reference/classes/InvalidCustomPropertyError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "InvalidCustomPropertyError" ---- - -[@slack/bolt](../index.md) / InvalidCustomPropertyError - # Class: InvalidCustomPropertyError Defined in: [src/errors.ts:107](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L107) diff --git a/docs/english/reference/classes/MemoryStore.md b/docs/english/reference/classes/MemoryStore.md index a168f640e..4189e826d 100644 --- a/docs/english/reference/classes/MemoryStore.md +++ b/docs/english/reference/classes/MemoryStore.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MemoryStore" ---- - -[@slack/bolt](../index.md) / MemoryStore - # Class: MemoryStore\ Defined in: [src/conversation-store.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L21) diff --git a/docs/english/reference/classes/MultipleListenerError.md b/docs/english/reference/classes/MultipleListenerError.md index e5e890dde..4f77c7435 100644 --- a/docs/english/reference/classes/MultipleListenerError.md +++ b/docs/english/reference/classes/MultipleListenerError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MultipleListenerError" ---- - -[@slack/bolt](../index.md) / MultipleListenerError - # Class: MultipleListenerError Defined in: [src/errors.ts:156](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L156) diff --git a/docs/english/reference/classes/ReceiverAuthenticityError.md b/docs/english/reference/classes/ReceiverAuthenticityError.md index 4e6740e32..faa3c5712 100644 --- a/docs/english/reference/classes/ReceiverAuthenticityError.md +++ b/docs/english/reference/classes/ReceiverAuthenticityError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverAuthenticityError" ---- - -[@slack/bolt](../index.md) / ReceiverAuthenticityError - # Class: ReceiverAuthenticityError Defined in: [src/errors.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L123) diff --git a/docs/english/reference/classes/ReceiverInconsistentStateError.md b/docs/english/reference/classes/ReceiverInconsistentStateError.md index c901f5bcd..f92dae127 100644 --- a/docs/english/reference/classes/ReceiverInconsistentStateError.md +++ b/docs/english/reference/classes/ReceiverInconsistentStateError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverInconsistentStateError" ---- - -[@slack/bolt](../index.md) / ReceiverInconsistentStateError - # Class: ReceiverInconsistentStateError Defined in: [src/errors.ts:127](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L127) diff --git a/docs/english/reference/classes/ReceiverMultipleAckError.md b/docs/english/reference/classes/ReceiverMultipleAckError.md index 69832a8c5..c465c271b 100644 --- a/docs/english/reference/classes/ReceiverMultipleAckError.md +++ b/docs/english/reference/classes/ReceiverMultipleAckError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverMultipleAckError" ---- - -[@slack/bolt](../index.md) / ReceiverMultipleAckError - # Class: ReceiverMultipleAckError Defined in: [src/errors.ts:115](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L115) diff --git a/docs/english/reference/classes/RespondError.md b/docs/english/reference/classes/RespondError.md index fecfa59bd..5c6ea48e3 100644 --- a/docs/english/reference/classes/RespondError.md +++ b/docs/english/reference/classes/RespondError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "RespondError" ---- - -[@slack/bolt](../index.md) / RespondError - # Class: RespondError Defined in: [src/errors.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L145) diff --git a/docs/english/reference/classes/SocketModeReceiver.md b/docs/english/reference/classes/SocketModeReceiver.md index 2ee99bb83..89da2e69b 100644 --- a/docs/english/reference/classes/SocketModeReceiver.md +++ b/docs/english/reference/classes/SocketModeReceiver.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SocketModeReceiver" ---- - -[@slack/bolt](../index.md) / SocketModeReceiver - # Class: SocketModeReceiver Defined in: [src/receivers/SocketModeReceiver.ts:83](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L83) diff --git a/docs/english/reference/classes/UnknownError.md b/docs/english/reference/classes/UnknownError.md index 10d705a1f..9dc8655d7 100644 --- a/docs/english/reference/classes/UnknownError.md +++ b/docs/english/reference/classes/UnknownError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "UnknownError" ---- - -[@slack/bolt](../index.md) / UnknownError - # Class: UnknownError Defined in: [src/errors.ts:52](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L52) diff --git a/docs/english/reference/enumerations/ErrorCode.md b/docs/english/reference/enumerations/ErrorCode.md index 68d30fc1c..be3136eab 100644 --- a/docs/english/reference/enumerations/ErrorCode.md +++ b/docs/english/reference/enumerations/ErrorCode.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ErrorCode" ---- - -[@slack/bolt](../index.md) / ErrorCode - # Enumeration: ErrorCode Defined in: [src/errors.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L18) diff --git a/docs/english/reference/functions/asCodedError.md b/docs/english/reference/functions/asCodedError.md index bbd0f6d88..1f0302f4a 100644 --- a/docs/english/reference/functions/asCodedError.md +++ b/docs/english/reference/functions/asCodedError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "asCodedError" ---- - -[@slack/bolt](../index.md) / asCodedError - # Function: asCodedError() ```ts diff --git a/docs/english/reference/functions/buildReceiverRoutes.md b/docs/english/reference/functions/buildReceiverRoutes.md index 58e24ee04..1a81e510a 100644 --- a/docs/english/reference/functions/buildReceiverRoutes.md +++ b/docs/english/reference/functions/buildReceiverRoutes.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "buildReceiverRoutes" ---- - -[@slack/bolt](../index.md) / buildReceiverRoutes - # Function: buildReceiverRoutes() ```ts diff --git a/docs/english/reference/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/functions/defaultProcessEventErrorHandler.md index 939b119fc..bda79e81d 100644 --- a/docs/english/reference/functions/defaultProcessEventErrorHandler.md +++ b/docs/english/reference/functions/defaultProcessEventErrorHandler.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "defaultProcessEventErrorHandler" ---- - -[@slack/bolt](../index.md) / defaultProcessEventErrorHandler - # Function: defaultProcessEventErrorHandler() ```ts diff --git a/docs/english/reference/functions/isCodedError.md b/docs/english/reference/functions/isCodedError.md index 8fd5ebfb2..208654657 100644 --- a/docs/english/reference/functions/isCodedError.md +++ b/docs/english/reference/functions/isCodedError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "isCodedError" ---- - -[@slack/bolt](../index.md) / isCodedError - # Function: isCodedError() ```ts diff --git a/docs/english/reference/functions/isFulfilled.md b/docs/english/reference/functions/isFulfilled.md index d88cbfad5..664ca89db 100644 --- a/docs/english/reference/functions/isFulfilled.md +++ b/docs/english/reference/functions/isFulfilled.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "isFulfilled" ---- - -[@slack/bolt](../index.md) / isFulfilled - # Function: isFulfilled() ```ts diff --git a/docs/english/reference/functions/isRejected.md b/docs/english/reference/functions/isRejected.md index 9fe9cc5c2..57584ec10 100644 --- a/docs/english/reference/functions/isRejected.md +++ b/docs/english/reference/functions/isRejected.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "isRejected" ---- - -[@slack/bolt](../index.md) / isRejected - # Function: isRejected() ```ts diff --git a/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md index 8bb5b69d2..dd16e5fd1 100644 --- a/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md +++ b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "isSlackEventMiddlewareArgsOptions" ---- - -[@slack/bolt](../index.md) / isSlackEventMiddlewareArgsOptions - # Function: isSlackEventMiddlewareArgsOptions() ```ts diff --git a/docs/english/reference/functions/isValidSlackRequest.md b/docs/english/reference/functions/isValidSlackRequest.md index 191c48ba7..6ea3d13a5 100644 --- a/docs/english/reference/functions/isValidSlackRequest.md +++ b/docs/english/reference/functions/isValidSlackRequest.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "isValidSlackRequest" ---- - -[@slack/bolt](../index.md) / isValidSlackRequest - # Function: isValidSlackRequest() ```ts diff --git a/docs/english/reference/functions/matchCommandName.md b/docs/english/reference/functions/matchCommandName.md index b9a2f75f6..5c6fe7b44 100644 --- a/docs/english/reference/functions/matchCommandName.md +++ b/docs/english/reference/functions/matchCommandName.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "matchCommandName" ---- - -[@slack/bolt](../index.md) / matchCommandName - # Function: matchCommandName() ```ts diff --git a/docs/english/reference/functions/matchConstraints.md b/docs/english/reference/functions/matchConstraints.md index f50ba8378..99ba205b0 100644 --- a/docs/english/reference/functions/matchConstraints.md +++ b/docs/english/reference/functions/matchConstraints.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "matchConstraints" ---- - -[@slack/bolt](../index.md) / matchConstraints - # Function: matchConstraints() ```ts diff --git a/docs/english/reference/functions/matchEventType.md b/docs/english/reference/functions/matchEventType.md index 493ddf504..5ac692711 100644 --- a/docs/english/reference/functions/matchEventType.md +++ b/docs/english/reference/functions/matchEventType.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "matchEventType" ---- - -[@slack/bolt](../index.md) / matchEventType - # Function: matchEventType() ```ts diff --git a/docs/english/reference/functions/matchMessage.md b/docs/english/reference/functions/matchMessage.md index 360a54594..4e35189ac 100644 --- a/docs/english/reference/functions/matchMessage.md +++ b/docs/english/reference/functions/matchMessage.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "matchMessage" ---- - -[@slack/bolt](../index.md) / matchMessage - # Function: matchMessage() ```ts diff --git a/docs/english/reference/functions/subtype.md b/docs/english/reference/functions/subtype.md index 26362c585..8187087cf 100644 --- a/docs/english/reference/functions/subtype.md +++ b/docs/english/reference/functions/subtype.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "subtype" ---- - -[@slack/bolt](../index.md) / subtype - # Function: subtype() ```ts diff --git a/docs/english/reference/functions/verifySlackRequest.md b/docs/english/reference/functions/verifySlackRequest.md index 24ed7b8aa..60d844d32 100644 --- a/docs/english/reference/functions/verifySlackRequest.md +++ b/docs/english/reference/functions/verifySlackRequest.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "verifySlackRequest" ---- - -[@slack/bolt](../index.md) / verifySlackRequest - # Function: verifySlackRequest() ```ts diff --git a/docs/english/reference/index.md b/docs/english/reference/index.md index c49a17756..5a293b146 100644 --- a/docs/english/reference/index.md +++ b/docs/english/reference/index.md @@ -1,8 +1,3 @@ ---- -sidebar_label: "@slack/bolt" -sidebar_position: 0 ---- - # @slack/bolt v5.0.0 ## Namespaces diff --git a/docs/english/reference/interfaces/ActionConstraints.md b/docs/english/reference/interfaces/ActionConstraints.md index 3882ac964..1c850f1f4 100644 --- a/docs/english/reference/interfaces/ActionConstraints.md +++ b/docs/english/reference/interfaces/ActionConstraints.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ActionConstraints" ---- - -[@slack/bolt](../index.md) / ActionConstraints - # Interface: ActionConstraints\ Defined in: [src/types/actions/index.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L28) diff --git a/docs/english/reference/interfaces/AllMiddlewareArgs.md b/docs/english/reference/interfaces/AllMiddlewareArgs.md index 10535c881..c44bb96f7 100644 --- a/docs/english/reference/interfaces/AllMiddlewareArgs.md +++ b/docs/english/reference/interfaces/AllMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AllMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / AllMiddlewareArgs - # Interface: AllMiddlewareArgs\ Defined in: [src/types/middleware.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L20) diff --git a/docs/english/reference/interfaces/AppOptions.md b/docs/english/reference/interfaces/AppOptions.md index 3a4b64896..52becbe1d 100644 --- a/docs/english/reference/interfaces/AppOptions.md +++ b/docs/english/reference/interfaces/AppOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AppOptions" ---- - -[@slack/bolt](../index.md) / AppOptions - # Interface: AppOptions Defined in: [src/App.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L122) diff --git a/docs/english/reference/interfaces/AssistantConfig.md b/docs/english/reference/interfaces/AssistantConfig.md index 5aa5e4dac..640e78988 100644 --- a/docs/english/reference/interfaces/AssistantConfig.md +++ b/docs/english/reference/interfaces/AssistantConfig.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AssistantConfig" ---- - -[@slack/bolt](../index.md) / AssistantConfig - # Interface: AssistantConfig Defined in: [src/Assistant.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L21) diff --git a/docs/english/reference/interfaces/AuthorizeResult.md b/docs/english/reference/interfaces/AuthorizeResult.md index eb97cec16..37618bfe1 100644 --- a/docs/english/reference/interfaces/AuthorizeResult.md +++ b/docs/english/reference/interfaces/AuthorizeResult.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AuthorizeResult" ---- - -[@slack/bolt](../index.md) / AuthorizeResult - # Interface: AuthorizeResult Defined in: [src/App.ts:178](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L178) diff --git a/docs/english/reference/interfaces/AuthorizeSourceData.md b/docs/english/reference/interfaces/AuthorizeSourceData.md index b8f0a8674..31a99aac3 100644 --- a/docs/english/reference/interfaces/AuthorizeSourceData.md +++ b/docs/english/reference/interfaces/AuthorizeSourceData.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AuthorizeSourceData" ---- - -[@slack/bolt](../index.md) / AuthorizeSourceData - # Interface: AuthorizeSourceData\ Defined in: [src/App.ts:169](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L169) diff --git a/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md index 3f60833e8..846e0bc3a 100644 --- a/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md +++ b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AwsLambdaReceiverOptions" ---- - -[@slack/bolt](../index.md) / AwsLambdaReceiverOptions - # Interface: AwsLambdaReceiverOptions Defined in: [src/receivers/AwsLambdaReceiver.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L84) diff --git a/docs/english/reference/interfaces/BaseSlackEvent.md b/docs/english/reference/interfaces/BaseSlackEvent.md index 3e97fcb36..64112c478 100644 --- a/docs/english/reference/interfaces/BaseSlackEvent.md +++ b/docs/english/reference/interfaces/BaseSlackEvent.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BaseSlackEvent" ---- - -[@slack/bolt](../index.md) / BaseSlackEvent - # Interface: BaseSlackEvent\ Defined in: [src/types/events/index.ts:68](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L68) diff --git a/docs/english/reference/interfaces/BasicElementAction.md b/docs/english/reference/interfaces/BasicElementAction.md index c002fcff6..48c708a0f 100644 --- a/docs/english/reference/interfaces/BasicElementAction.md +++ b/docs/english/reference/interfaces/BasicElementAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BasicElementAction" ---- - -[@slack/bolt](../index.md) / BasicElementAction - # Interface: BasicElementAction\ Defined in: [src/types/actions/block-action.ts:39](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L39) diff --git a/docs/english/reference/interfaces/BasicOptionsPayload.md b/docs/english/reference/interfaces/BasicOptionsPayload.md index 600145c82..cb8907d3f 100644 --- a/docs/english/reference/interfaces/BasicOptionsPayload.md +++ b/docs/english/reference/interfaces/BasicOptionsPayload.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BasicOptionsPayload" ---- - -[@slack/bolt](../index.md) / BasicOptionsPayload - # Interface: BasicOptionsPayload\ Defined in: [src/types/options/index.ts:33](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L33) diff --git a/docs/english/reference/interfaces/BlockAction.md b/docs/english/reference/interfaces/BlockAction.md index c77632532..345e624a7 100644 --- a/docs/english/reference/interfaces/BlockAction.md +++ b/docs/english/reference/interfaces/BlockAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockAction" ---- - -[@slack/bolt](../index.md) / BlockAction - # Interface: BlockAction\ Defined in: [src/types/actions/block-action.ts:249](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L249) diff --git a/docs/english/reference/interfaces/BlockOptions.md b/docs/english/reference/interfaces/BlockOptions.md index fed7b7062..c335dd833 100644 --- a/docs/english/reference/interfaces/BlockOptions.md +++ b/docs/english/reference/interfaces/BlockOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockOptions" ---- - -[@slack/bolt](../index.md) / BlockOptions - # Interface: BlockOptions Defined in: [src/types/options/index.ts:160](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L160) diff --git a/docs/english/reference/interfaces/BlockSuggestion.md b/docs/english/reference/interfaces/BlockSuggestion.md index dcadec998..879f4614f 100644 --- a/docs/english/reference/interfaces/BlockSuggestion.md +++ b/docs/english/reference/interfaces/BlockSuggestion.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockSuggestion" ---- - -[@slack/bolt](../index.md) / BlockSuggestion - # Interface: BlockSuggestion Defined in: [src/types/options/index.ts:45](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L45) diff --git a/docs/english/reference/interfaces/BufferedIncomingMessage.md b/docs/english/reference/interfaces/BufferedIncomingMessage.md index 157876070..8113245c1 100644 --- a/docs/english/reference/interfaces/BufferedIncomingMessage.md +++ b/docs/english/reference/interfaces/BufferedIncomingMessage.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BufferedIncomingMessage" ---- - -[@slack/bolt](../index.md) / BufferedIncomingMessage - # Interface: BufferedIncomingMessage Defined in: [src/receivers/BufferedIncomingMessage.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/receivers/BufferedIncomingMessage.ts#L5) diff --git a/docs/english/reference/interfaces/ButtonAction.md b/docs/english/reference/interfaces/ButtonAction.md index a8929a41b..e42ab0beb 100644 --- a/docs/english/reference/interfaces/ButtonAction.md +++ b/docs/english/reference/interfaces/ButtonAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ButtonAction" ---- - -[@slack/bolt](../index.md) / ButtonAction - # Interface: ButtonAction Defined in: [src/types/actions/block-action.ts:49](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L49) diff --git a/docs/english/reference/interfaces/ButtonClick.md b/docs/english/reference/interfaces/ButtonClick.md index e1b0e504f..e2b577965 100644 --- a/docs/english/reference/interfaces/ButtonClick.md +++ b/docs/english/reference/interfaces/ButtonClick.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ButtonClick" ---- - -[@slack/bolt](../index.md) / ButtonClick - # Interface: ButtonClick Defined in: [src/types/actions/interactive-message.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L10) diff --git a/docs/english/reference/interfaces/ChannelsSelectAction.md b/docs/english/reference/interfaces/ChannelsSelectAction.md index 7bbb9a239..9ba8eddf6 100644 --- a/docs/english/reference/interfaces/ChannelsSelectAction.md +++ b/docs/english/reference/interfaces/ChannelsSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ChannelsSelectAction" ---- - -[@slack/bolt](../index.md) / ChannelsSelectAction - # Interface: ChannelsSelectAction Defined in: [src/types/actions/block-action.ts:142](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L142) diff --git a/docs/english/reference/interfaces/CheckboxesAction.md b/docs/english/reference/interfaces/CheckboxesAction.md index 4b58d27c8..e38c9a503 100644 --- a/docs/english/reference/interfaces/CheckboxesAction.md +++ b/docs/english/reference/interfaces/CheckboxesAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "CheckboxesAction" ---- - -[@slack/bolt](../index.md) / CheckboxesAction - # Interface: CheckboxesAction Defined in: [src/types/actions/block-action.ts:224](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L224) diff --git a/docs/english/reference/interfaces/CodedError.md b/docs/english/reference/interfaces/CodedError.md index 57517d477..2dca48717 100644 --- a/docs/english/reference/interfaces/CodedError.md +++ b/docs/english/reference/interfaces/CodedError.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "CodedError" ---- - -[@slack/bolt](../index.md) / CodedError - # Interface: CodedError Defined in: [src/errors.ts:4](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L4) diff --git a/docs/english/reference/interfaces/Context.md b/docs/english/reference/interfaces/Context.md index f117bda97..7a74744bc 100644 --- a/docs/english/reference/interfaces/Context.md +++ b/docs/english/reference/interfaces/Context.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "Context" ---- - -[@slack/bolt](../index.md) / Context - # Interface: Context Defined in: [src/types/middleware.ts:37](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L37) diff --git a/docs/english/reference/interfaces/ConversationStore.md b/docs/english/reference/interfaces/ConversationStore.md index eb97b254c..86713241a 100644 --- a/docs/english/reference/interfaces/ConversationStore.md +++ b/docs/english/reference/interfaces/ConversationStore.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ConversationStore" ---- - -[@slack/bolt](../index.md) / ConversationStore - # Interface: ConversationStore\ Defined in: [src/conversation-store.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L8) diff --git a/docs/english/reference/interfaces/ConversationsSelectAction.md b/docs/english/reference/interfaces/ConversationsSelectAction.md index 44beae51b..6f4f2c2c2 100644 --- a/docs/english/reference/interfaces/ConversationsSelectAction.md +++ b/docs/english/reference/interfaces/ConversationsSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ConversationsSelectAction" ---- - -[@slack/bolt](../index.md) / ConversationsSelectAction - # Interface: ConversationsSelectAction Defined in: [src/types/actions/block-action.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L122) diff --git a/docs/english/reference/interfaces/CustomRoute.md b/docs/english/reference/interfaces/CustomRoute.md index cc2368e29..0787d53d1 100644 --- a/docs/english/reference/interfaces/CustomRoute.md +++ b/docs/english/reference/interfaces/CustomRoute.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "CustomRoute" ---- - -[@slack/bolt](../index.md) / CustomRoute - # Interface: CustomRoute Defined in: [src/receivers/custom-routes.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L5) diff --git a/docs/english/reference/interfaces/DatepickerAction.md b/docs/english/reference/interfaces/DatepickerAction.md index ac065e934..2810b0ab8 100644 --- a/docs/english/reference/interfaces/DatepickerAction.md +++ b/docs/english/reference/interfaces/DatepickerAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "DatepickerAction" ---- - -[@slack/bolt](../index.md) / DatepickerAction - # Interface: DatepickerAction Defined in: [src/types/actions/block-action.ts:195](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L195) diff --git a/docs/english/reference/interfaces/DialogOptionGroups.md b/docs/english/reference/interfaces/DialogOptionGroups.md index 98db3fba7..f6c8f9b3a 100644 --- a/docs/english/reference/interfaces/DialogOptionGroups.md +++ b/docs/english/reference/interfaces/DialogOptionGroups.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "DialogOptionGroups" ---- - -[@slack/bolt](../index.md) / DialogOptionGroups - # Interface: DialogOptionGroups\ Defined in: [src/types/options/index.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L177) diff --git a/docs/english/reference/interfaces/DialogOptions.md b/docs/english/reference/interfaces/DialogOptions.md index 07b82057c..4ae7eef00 100644 --- a/docs/english/reference/interfaces/DialogOptions.md +++ b/docs/english/reference/interfaces/DialogOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "DialogOptions" ---- - -[@slack/bolt](../index.md) / DialogOptions - # Interface: DialogOptions Defined in: [src/types/options/index.ts:166](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L166) diff --git a/docs/english/reference/interfaces/DialogSubmitAction.md b/docs/english/reference/interfaces/DialogSubmitAction.md index 97d0342c1..4e3f03fbf 100644 --- a/docs/english/reference/interfaces/DialogSubmitAction.md +++ b/docs/english/reference/interfaces/DialogSubmitAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "DialogSubmitAction" ---- - -[@slack/bolt](../index.md) / DialogSubmitAction - # Interface: DialogSubmitAction Defined in: [src/types/actions/dialog-action.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L6) diff --git a/docs/english/reference/interfaces/DialogSuggestion.md b/docs/english/reference/interfaces/DialogSuggestion.md index 7af283859..4c059ff0f 100644 --- a/docs/english/reference/interfaces/DialogSuggestion.md +++ b/docs/english/reference/interfaces/DialogSuggestion.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "DialogSuggestion" ---- - -[@slack/bolt](../index.md) / DialogSuggestion - # Interface: DialogSuggestion Defined in: [src/types/options/index.ts:118](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L118) diff --git a/docs/english/reference/interfaces/DialogValidation.md b/docs/english/reference/interfaces/DialogValidation.md index d539812ea..a1a244329 100644 --- a/docs/english/reference/interfaces/DialogValidation.md +++ b/docs/english/reference/interfaces/DialogValidation.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "DialogValidation" ---- - -[@slack/bolt](../index.md) / DialogValidation - # Interface: DialogValidation Defined in: [src/types/actions/dialog-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L42) diff --git a/docs/english/reference/interfaces/EnvelopedEvent.md b/docs/english/reference/interfaces/EnvelopedEvent.md index d95085439..276869bd2 100644 --- a/docs/english/reference/interfaces/EnvelopedEvent.md +++ b/docs/english/reference/interfaces/EnvelopedEvent.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "EnvelopedEvent" ---- - -[@slack/bolt](../index.md) / EnvelopedEvent - # Interface: EnvelopedEvent\ Defined in: [src/types/events/index.ts:79](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L79) diff --git a/docs/english/reference/interfaces/ExpressReceiverOptions.md b/docs/english/reference/interfaces/ExpressReceiverOptions.md index af1df00ef..64bfc8679 100644 --- a/docs/english/reference/interfaces/ExpressReceiverOptions.md +++ b/docs/english/reference/interfaces/ExpressReceiverOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ExpressReceiverOptions" ---- - -[@slack/bolt](../index.md) / ExpressReceiverOptions - # Interface: ExpressReceiverOptions Defined in: [src/receivers/ExpressReceiver.ts:92](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L92) diff --git a/docs/english/reference/interfaces/ExternalSelectAction.md b/docs/english/reference/interfaces/ExternalSelectAction.md index f798c2478..2747efede 100644 --- a/docs/english/reference/interfaces/ExternalSelectAction.md +++ b/docs/english/reference/interfaces/ExternalSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ExternalSelectAction" ---- - -[@slack/bolt](../index.md) / ExternalSelectAction - # Interface: ExternalSelectAction Defined in: [src/types/actions/block-action.ts:162](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L162) diff --git a/docs/english/reference/interfaces/FeedbackButtonsAction.md b/docs/english/reference/interfaces/FeedbackButtonsAction.md index b17814237..06edd39fd 100644 --- a/docs/english/reference/interfaces/FeedbackButtonsAction.md +++ b/docs/english/reference/interfaces/FeedbackButtonsAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "FeedbackButtonsAction" ---- - -[@slack/bolt](../index.md) / FeedbackButtonsAction - # Interface: FeedbackButtonsAction Defined in: [src/types/actions/block-action.ts:59](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L59) diff --git a/docs/english/reference/interfaces/GlobalShortcut.md b/docs/english/reference/interfaces/GlobalShortcut.md index 683b3cad1..013f12e7f 100644 --- a/docs/english/reference/interfaces/GlobalShortcut.md +++ b/docs/english/reference/interfaces/GlobalShortcut.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "GlobalShortcut" ---- - -[@slack/bolt](../index.md) / GlobalShortcut - # Interface: GlobalShortcut Defined in: [src/types/shortcuts/global-shortcut.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L7) diff --git a/docs/english/reference/interfaces/HTTPReceiverOptions.md b/docs/english/reference/interfaces/HTTPReceiverOptions.md index fff1e2e87..ff02ed65e 100644 --- a/docs/english/reference/interfaces/HTTPReceiverOptions.md +++ b/docs/english/reference/interfaces/HTTPReceiverOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "HTTPReceiverOptions" ---- - -[@slack/bolt](../index.md) / HTTPReceiverOptions - # Interface: HTTPReceiverOptions Defined in: [src/receivers/HTTPReceiver.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L76) diff --git a/docs/english/reference/interfaces/IconButtonAction.md b/docs/english/reference/interfaces/IconButtonAction.md index 5abdfa25d..c1068ec0b 100644 --- a/docs/english/reference/interfaces/IconButtonAction.md +++ b/docs/english/reference/interfaces/IconButtonAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "IconButtonAction" ---- - -[@slack/bolt](../index.md) / IconButtonAction - # Interface: IconButtonAction Defined in: [src/types/actions/block-action.ts:67](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L67) diff --git a/docs/english/reference/interfaces/InteractiveMessage.md b/docs/english/reference/interfaces/InteractiveMessage.md index 6891791a8..77dd7a0e2 100644 --- a/docs/english/reference/interfaces/InteractiveMessage.md +++ b/docs/english/reference/interfaces/InteractiveMessage.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "InteractiveMessage" ---- - -[@slack/bolt](../index.md) / InteractiveMessage - # Interface: InteractiveMessage\ Defined in: [src/types/actions/interactive-message.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L32) diff --git a/docs/english/reference/interfaces/InteractiveMessageSuggestion.md b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md index aff2818fc..3a27e3974 100644 --- a/docs/english/reference/interfaces/InteractiveMessageSuggestion.md +++ b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "InteractiveMessageSuggestion" ---- - -[@slack/bolt](../index.md) / InteractiveMessageSuggestion - # Interface: InteractiveMessageSuggestion Defined in: [src/types/options/index.ts:82](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L82) diff --git a/docs/english/reference/interfaces/MenuSelect.md b/docs/english/reference/interfaces/MenuSelect.md index c51c22845..182d1bb04 100644 --- a/docs/english/reference/interfaces/MenuSelect.md +++ b/docs/english/reference/interfaces/MenuSelect.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MenuSelect" ---- - -[@slack/bolt](../index.md) / MenuSelect - # Interface: MenuSelect Defined in: [src/types/actions/interactive-message.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L19) diff --git a/docs/english/reference/interfaces/MessageOptions.md b/docs/english/reference/interfaces/MessageOptions.md index e67b9850b..8f4c2ac1d 100644 --- a/docs/english/reference/interfaces/MessageOptions.md +++ b/docs/english/reference/interfaces/MessageOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MessageOptions" ---- - -[@slack/bolt](../index.md) / MessageOptions - # Interface: MessageOptions Defined in: [src/types/options/index.ts:163](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L163) diff --git a/docs/english/reference/interfaces/MessageShortcut.md b/docs/english/reference/interfaces/MessageShortcut.md index 4ded0a82f..390cdd130 100644 --- a/docs/english/reference/interfaces/MessageShortcut.md +++ b/docs/english/reference/interfaces/MessageShortcut.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MessageShortcut" ---- - -[@slack/bolt](../index.md) / MessageShortcut - # Interface: MessageShortcut Defined in: [src/types/shortcuts/message-shortcut.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L7) diff --git a/docs/english/reference/interfaces/MultiChannelsSelectAction.md b/docs/english/reference/interfaces/MultiChannelsSelectAction.md index 9afd346db..1ee7be3b6 100644 --- a/docs/english/reference/interfaces/MultiChannelsSelectAction.md +++ b/docs/english/reference/interfaces/MultiChannelsSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MultiChannelsSelectAction" ---- - -[@slack/bolt](../index.md) / MultiChannelsSelectAction - # Interface: MultiChannelsSelectAction Defined in: [src/types/actions/block-action.ts:152](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L152) diff --git a/docs/english/reference/interfaces/MultiConversationsSelectAction.md b/docs/english/reference/interfaces/MultiConversationsSelectAction.md index 1f91f3abc..3f56b7b43 100644 --- a/docs/english/reference/interfaces/MultiConversationsSelectAction.md +++ b/docs/english/reference/interfaces/MultiConversationsSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MultiConversationsSelectAction" ---- - -[@slack/bolt](../index.md) / MultiConversationsSelectAction - # Interface: MultiConversationsSelectAction Defined in: [src/types/actions/block-action.ts:132](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L132) diff --git a/docs/english/reference/interfaces/MultiExternalSelectAction.md b/docs/english/reference/interfaces/MultiExternalSelectAction.md index 0ccb76a4d..1d106f674 100644 --- a/docs/english/reference/interfaces/MultiExternalSelectAction.md +++ b/docs/english/reference/interfaces/MultiExternalSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MultiExternalSelectAction" ---- - -[@slack/bolt](../index.md) / MultiExternalSelectAction - # Interface: MultiExternalSelectAction Defined in: [src/types/actions/block-action.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L173) diff --git a/docs/english/reference/interfaces/MultiStaticSelectAction.md b/docs/english/reference/interfaces/MultiStaticSelectAction.md index 49c99d2b4..cd3192914 100644 --- a/docs/english/reference/interfaces/MultiStaticSelectAction.md +++ b/docs/english/reference/interfaces/MultiStaticSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MultiStaticSelectAction" ---- - -[@slack/bolt](../index.md) / MultiStaticSelectAction - # Interface: MultiStaticSelectAction Defined in: [src/types/actions/block-action.ts:89](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L89) diff --git a/docs/english/reference/interfaces/MultiUsersSelectAction.md b/docs/english/reference/interfaces/MultiUsersSelectAction.md index cdd10633d..7dc007e2f 100644 --- a/docs/english/reference/interfaces/MultiUsersSelectAction.md +++ b/docs/english/reference/interfaces/MultiUsersSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "MultiUsersSelectAction" ---- - -[@slack/bolt](../index.md) / MultiUsersSelectAction - # Interface: MultiUsersSelectAction Defined in: [src/types/actions/block-action.ts:112](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L112) diff --git a/docs/english/reference/interfaces/OptionGroups.md b/docs/english/reference/interfaces/OptionGroups.md index 4865b4e4e..9479a26fd 100644 --- a/docs/english/reference/interfaces/OptionGroups.md +++ b/docs/english/reference/interfaces/OptionGroups.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "OptionGroups" ---- - -[@slack/bolt](../index.md) / OptionGroups - # Interface: OptionGroups\ Defined in: [src/types/options/index.ts:172](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L172) diff --git a/docs/english/reference/interfaces/OptionsConstraints.md b/docs/english/reference/interfaces/OptionsConstraints.md index fdca23f86..90dc04266 100644 --- a/docs/english/reference/interfaces/OptionsConstraints.md +++ b/docs/english/reference/interfaces/OptionsConstraints.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "OptionsConstraints" ---- - -[@slack/bolt](../index.md) / OptionsConstraints - # Interface: OptionsConstraints\ Defined in: [src/types/options/index.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L18) diff --git a/docs/english/reference/interfaces/OverflowAction.md b/docs/english/reference/interfaces/OverflowAction.md index 4b2dbb204..cca08ace2 100644 --- a/docs/english/reference/interfaces/OverflowAction.md +++ b/docs/english/reference/interfaces/OverflowAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "OverflowAction" ---- - -[@slack/bolt](../index.md) / OverflowAction - # Interface: OverflowAction Defined in: [src/types/actions/block-action.ts:184](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L184) diff --git a/docs/english/reference/interfaces/PlainTextInputAction.md b/docs/english/reference/interfaces/PlainTextInputAction.md index 2e2d31a15..eec16e8c3 100644 --- a/docs/english/reference/interfaces/PlainTextInputAction.md +++ b/docs/english/reference/interfaces/PlainTextInputAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "PlainTextInputAction" ---- - -[@slack/bolt](../index.md) / PlainTextInputAction - # Interface: PlainTextInputAction Defined in: [src/types/actions/block-action.ts:233](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L233) diff --git a/docs/english/reference/interfaces/RadioButtonsAction.md b/docs/english/reference/interfaces/RadioButtonsAction.md index 022edb9bf..8f51a4a56 100644 --- a/docs/english/reference/interfaces/RadioButtonsAction.md +++ b/docs/english/reference/interfaces/RadioButtonsAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "RadioButtonsAction" ---- - -[@slack/bolt](../index.md) / RadioButtonsAction - # Interface: RadioButtonsAction Defined in: [src/types/actions/block-action.ts:215](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L215) diff --git a/docs/english/reference/interfaces/Receiver.md b/docs/english/reference/interfaces/Receiver.md index 0f4a5466b..417efc055 100644 --- a/docs/english/reference/interfaces/Receiver.md +++ b/docs/english/reference/interfaces/Receiver.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "Receiver" ---- - -[@slack/bolt](../index.md) / Receiver - # Interface: Receiver Defined in: [src/types/receiver.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L26) diff --git a/docs/english/reference/interfaces/ReceiverEvent.md b/docs/english/reference/interfaces/ReceiverEvent.md index 3b0b92b98..2d6609c07 100644 --- a/docs/english/reference/interfaces/ReceiverEvent.md +++ b/docs/english/reference/interfaces/ReceiverEvent.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverEvent" ---- - -[@slack/bolt](../index.md) / ReceiverEvent - # Interface: ReceiverEvent Defined in: [src/types/receiver.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L5) diff --git a/docs/english/reference/interfaces/ReceiverRoutes.md b/docs/english/reference/interfaces/ReceiverRoutes.md index 24eafc006..90515c0ba 100644 --- a/docs/english/reference/interfaces/ReceiverRoutes.md +++ b/docs/english/reference/interfaces/ReceiverRoutes.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ReceiverRoutes" ---- - -[@slack/bolt](../index.md) / ReceiverRoutes - # Interface: ReceiverRoutes Defined in: [src/receivers/custom-routes.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L11) diff --git a/docs/english/reference/interfaces/ResponseAck.md b/docs/english/reference/interfaces/ResponseAck.md index f9c6c13b7..d5f13fd0f 100644 --- a/docs/english/reference/interfaces/ResponseAck.md +++ b/docs/english/reference/interfaces/ResponseAck.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ResponseAck" ---- - -[@slack/bolt](../index.md) / ResponseAck - # Interface: ResponseAck Defined in: [src/types/receiver.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L34) diff --git a/docs/english/reference/interfaces/RichTextInputAction.md b/docs/english/reference/interfaces/RichTextInputAction.md index c9bfc12bb..f5ab882db 100644 --- a/docs/english/reference/interfaces/RichTextInputAction.md +++ b/docs/english/reference/interfaces/RichTextInputAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "RichTextInputAction" ---- - -[@slack/bolt](../index.md) / RichTextInputAction - # Interface: RichTextInputAction Defined in: [src/types/actions/block-action.ts:240](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L240) diff --git a/docs/english/reference/interfaces/ShortcutConstraints.md b/docs/english/reference/interfaces/ShortcutConstraints.md index 727525448..822259ab4 100644 --- a/docs/english/reference/interfaces/ShortcutConstraints.md +++ b/docs/english/reference/interfaces/ShortcutConstraints.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ShortcutConstraints" ---- - -[@slack/bolt](../index.md) / ShortcutConstraints - # Interface: ShortcutConstraints\ Defined in: [src/types/shortcuts/index.ts:14](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/index.ts#L14) diff --git a/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md index 0fb4e7286..abd90534a 100644 --- a/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackCommandMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / SlackCommandMiddlewareArgs - # Interface: SlackCommandMiddlewareArgs Defined in: [src/types/command/index.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L6) diff --git a/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md index 49576721a..73623d99f 100644 --- a/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackOptionsMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / SlackOptionsMiddlewareArgs - # Interface: SlackOptionsMiddlewareArgs\ Defined in: [src/types/options/index.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L8) diff --git a/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md index dbb22fd6b..09a02b5f2 100644 --- a/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackViewMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / SlackViewMiddlewareArgs - # Interface: SlackViewMiddlewareArgs\ Defined in: [src/types/view/index.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L19) diff --git a/docs/english/reference/interfaces/SlashCommand.md b/docs/english/reference/interfaces/SlashCommand.md index 9892a5dfb..709c8c12d 100644 --- a/docs/english/reference/interfaces/SlashCommand.md +++ b/docs/english/reference/interfaces/SlashCommand.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlashCommand" ---- - -[@slack/bolt](../index.md) / SlashCommand - # Interface: SlashCommand Defined in: [src/types/command/index.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L20) diff --git a/docs/english/reference/interfaces/SocketModeReceiverOptions.md b/docs/english/reference/interfaces/SocketModeReceiverOptions.md index 02e5e3ebe..7a3e9402b 100644 --- a/docs/english/reference/interfaces/SocketModeReceiverOptions.md +++ b/docs/english/reference/interfaces/SocketModeReceiverOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SocketModeReceiverOptions" ---- - -[@slack/bolt](../index.md) / SocketModeReceiverOptions - # Interface: SocketModeReceiverOptions Defined in: [src/receivers/SocketModeReceiver.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L31) diff --git a/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md index efd5419f5..9033057a7 100644 --- a/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md +++ b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SocketModeReceiverProcessEventErrorHandlerArgs" ---- - -[@slack/bolt](../index.md) / SocketModeReceiverProcessEventErrorHandlerArgs - # Interface: SocketModeReceiverProcessEventErrorHandlerArgs Defined in: [src/receivers/SocketModeFunctions.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeFunctions.ts#L24) diff --git a/docs/english/reference/interfaces/StaticSelectAction.md b/docs/english/reference/interfaces/StaticSelectAction.md index 94416118e..9b82de6c6 100644 --- a/docs/english/reference/interfaces/StaticSelectAction.md +++ b/docs/english/reference/interfaces/StaticSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "StaticSelectAction" ---- - -[@slack/bolt](../index.md) / StaticSelectAction - # Interface: StaticSelectAction Defined in: [src/types/actions/block-action.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L76) diff --git a/docs/english/reference/interfaces/TimepickerAction.md b/docs/english/reference/interfaces/TimepickerAction.md index ab2c64040..5b65427e3 100644 --- a/docs/english/reference/interfaces/TimepickerAction.md +++ b/docs/english/reference/interfaces/TimepickerAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "TimepickerAction" ---- - -[@slack/bolt](../index.md) / TimepickerAction - # Interface: TimepickerAction Defined in: [src/types/actions/block-action.ts:205](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L205) diff --git a/docs/english/reference/interfaces/UploadedFile.md b/docs/english/reference/interfaces/UploadedFile.md index 6e17ebad2..6e65c6939 100644 --- a/docs/english/reference/interfaces/UploadedFile.md +++ b/docs/english/reference/interfaces/UploadedFile.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "UploadedFile" ---- - -[@slack/bolt](../index.md) / UploadedFile - # Interface: UploadedFile Defined in: [src/types/view/index.ts:109](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L109) diff --git a/docs/english/reference/interfaces/UsersSelectAction.md b/docs/english/reference/interfaces/UsersSelectAction.md index 412cdefd5..ebfeadf84 100644 --- a/docs/english/reference/interfaces/UsersSelectAction.md +++ b/docs/english/reference/interfaces/UsersSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "UsersSelectAction" ---- - -[@slack/bolt](../index.md) / UsersSelectAction - # Interface: UsersSelectAction Defined in: [src/types/actions/block-action.ts:102](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L102) diff --git a/docs/english/reference/interfaces/ViewClearResponseAction.md b/docs/english/reference/interfaces/ViewClearResponseAction.md index e62be3ad6..01624d5aa 100644 --- a/docs/english/reference/interfaces/ViewClearResponseAction.md +++ b/docs/english/reference/interfaces/ViewClearResponseAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewClearResponseAction" ---- - -[@slack/bolt](../index.md) / ViewClearResponseAction - # Interface: ViewClearResponseAction Defined in: [src/types/view/index.ts:298](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L298) diff --git a/docs/english/reference/interfaces/ViewClosedAction.md b/docs/english/reference/interfaces/ViewClosedAction.md index b7e58ecb1..d8128435f 100644 --- a/docs/english/reference/interfaces/ViewClosedAction.md +++ b/docs/english/reference/interfaces/ViewClosedAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewClosedAction" ---- - -[@slack/bolt](../index.md) / ViewClosedAction - # Interface: ViewClosedAction Defined in: [src/types/view/index.ts:78](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L78) diff --git a/docs/english/reference/interfaces/ViewConstraints.md b/docs/english/reference/interfaces/ViewConstraints.md index 7ac354fa1..63d3d5682 100644 --- a/docs/english/reference/interfaces/ViewConstraints.md +++ b/docs/english/reference/interfaces/ViewConstraints.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewConstraints" ---- - -[@slack/bolt](../index.md) / ViewConstraints - # Interface: ViewConstraints Defined in: [src/types/view/index.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L11) diff --git a/docs/english/reference/interfaces/ViewErrorsResponseAction.md b/docs/english/reference/interfaces/ViewErrorsResponseAction.md index f705322bf..eb50467f8 100644 --- a/docs/english/reference/interfaces/ViewErrorsResponseAction.md +++ b/docs/english/reference/interfaces/ViewErrorsResponseAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewErrorsResponseAction" ---- - -[@slack/bolt](../index.md) / ViewErrorsResponseAction - # Interface: ViewErrorsResponseAction Defined in: [src/types/view/index.ts:302](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L302) diff --git a/docs/english/reference/interfaces/ViewOutput.md b/docs/english/reference/interfaces/ViewOutput.md index a9902431f..facf65e8f 100644 --- a/docs/english/reference/interfaces/ViewOutput.md +++ b/docs/english/reference/interfaces/ViewOutput.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewOutput" ---- - -[@slack/bolt](../index.md) / ViewOutput - # Interface: ViewOutput Defined in: [src/types/view/index.ts:254](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L254) diff --git a/docs/english/reference/interfaces/ViewPushResponseAction.md b/docs/english/reference/interfaces/ViewPushResponseAction.md index 6115a846a..0230d2902 100644 --- a/docs/english/reference/interfaces/ViewPushResponseAction.md +++ b/docs/english/reference/interfaces/ViewPushResponseAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewPushResponseAction" ---- - -[@slack/bolt](../index.md) / ViewPushResponseAction - # Interface: ViewPushResponseAction Defined in: [src/types/view/index.ts:293](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L293) diff --git a/docs/english/reference/interfaces/ViewResponseUrl.md b/docs/english/reference/interfaces/ViewResponseUrl.md index 2fed3b01d..3ff4740f3 100644 --- a/docs/english/reference/interfaces/ViewResponseUrl.md +++ b/docs/english/reference/interfaces/ViewResponseUrl.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewResponseUrl" ---- - -[@slack/bolt](../index.md) / ViewResponseUrl - # Interface: ViewResponseUrl Defined in: [src/types/view/index.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L34) diff --git a/docs/english/reference/interfaces/ViewStateSelectedOption.md b/docs/english/reference/interfaces/ViewStateSelectedOption.md index 15becc873..e9815d44f 100644 --- a/docs/english/reference/interfaces/ViewStateSelectedOption.md +++ b/docs/english/reference/interfaces/ViewStateSelectedOption.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewStateSelectedOption" ---- - -[@slack/bolt](../index.md) / ViewStateSelectedOption - # Interface: ViewStateSelectedOption Defined in: [src/types/view/index.ts:103](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L103) diff --git a/docs/english/reference/interfaces/ViewStateValue.md b/docs/english/reference/interfaces/ViewStateValue.md index a31ba86cb..7862e16fd 100644 --- a/docs/english/reference/interfaces/ViewStateValue.md +++ b/docs/english/reference/interfaces/ViewStateValue.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewStateValue" ---- - -[@slack/bolt](../index.md) / ViewStateValue - # Interface: ViewStateValue Defined in: [src/types/view/index.ts:236](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L236) diff --git a/docs/english/reference/interfaces/ViewSubmitAction.md b/docs/english/reference/interfaces/ViewSubmitAction.md index 7e0c2ecc4..8f14bfc48 100644 --- a/docs/english/reference/interfaces/ViewSubmitAction.md +++ b/docs/english/reference/interfaces/ViewSubmitAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewSubmitAction" ---- - -[@slack/bolt](../index.md) / ViewSubmitAction - # Interface: ViewSubmitAction Defined in: [src/types/view/index.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L47) diff --git a/docs/english/reference/interfaces/ViewUpdateResponseAction.md b/docs/english/reference/interfaces/ViewUpdateResponseAction.md index 075c31119..a70fcb896 100644 --- a/docs/english/reference/interfaces/ViewUpdateResponseAction.md +++ b/docs/english/reference/interfaces/ViewUpdateResponseAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewUpdateResponseAction" ---- - -[@slack/bolt](../index.md) / ViewUpdateResponseAction - # Interface: ViewUpdateResponseAction Defined in: [src/types/view/index.ts:288](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L288) diff --git a/docs/english/reference/type-aliases/AckFn.md b/docs/english/reference/type-aliases/AckFn.md index 4369935a6..c7ffc2889 100644 --- a/docs/english/reference/type-aliases/AckFn.md +++ b/docs/english/reference/type-aliases/AckFn.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AckFn" ---- - -[@slack/bolt](../index.md) / AckFn - # Type Alias: AckFn\ ```ts diff --git a/docs/english/reference/type-aliases/AnyMiddlewareArgs.md b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md index fc30eaba2..d65c2b0eb 100644 --- a/docs/english/reference/type-aliases/AnyMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AnyMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / AnyMiddlewareArgs - # Type Alias: AnyMiddlewareArgs ```ts diff --git a/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md index 474d6eed5..f78ed7184 100644 --- a/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AssistantThreadContextChangedMiddleware" ---- - -[@slack/bolt](../index.md) / AssistantThreadContextChangedMiddleware - # Type Alias: AssistantThreadContextChangedMiddleware ```ts diff --git a/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md index 9f8cb363b..00cd00081 100644 --- a/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AssistantThreadStartedMiddleware" ---- - -[@slack/bolt](../index.md) / AssistantThreadStartedMiddleware - # Type Alias: AssistantThreadStartedMiddleware ```ts diff --git a/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md index 5276a8aed..ce1dca35b 100644 --- a/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "AssistantUserMessageMiddleware" ---- - -[@slack/bolt](../index.md) / AssistantUserMessageMiddleware - # Type Alias: AssistantUserMessageMiddleware ```ts diff --git a/docs/english/reference/type-aliases/Authorize.md b/docs/english/reference/type-aliases/Authorize.md index c678bb25c..88660d9be 100644 --- a/docs/english/reference/type-aliases/Authorize.md +++ b/docs/english/reference/type-aliases/Authorize.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "Authorize" ---- - -[@slack/bolt](../index.md) / Authorize - # Type Alias: Authorize\ ```ts diff --git a/docs/english/reference/type-aliases/BlockButtonAction.md b/docs/english/reference/type-aliases/BlockButtonAction.md index 552bf65d2..494cfe761 100644 --- a/docs/english/reference/type-aliases/BlockButtonAction.md +++ b/docs/english/reference/type-aliases/BlockButtonAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockButtonAction" ---- - -[@slack/bolt](../index.md) / BlockButtonAction - # Type Alias: BlockButtonAction ```ts diff --git a/docs/english/reference/type-aliases/BlockChannelsSelectAction.md b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md index 0ea663af7..1f8a0252d 100644 --- a/docs/english/reference/type-aliases/BlockChannelsSelectAction.md +++ b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockChannelsSelectAction" ---- - -[@slack/bolt](../index.md) / BlockChannelsSelectAction - # Type Alias: BlockChannelsSelectAction ```ts diff --git a/docs/english/reference/type-aliases/BlockCheckboxesAction.md b/docs/english/reference/type-aliases/BlockCheckboxesAction.md index 16612ac32..ab8f570c6 100644 --- a/docs/english/reference/type-aliases/BlockCheckboxesAction.md +++ b/docs/english/reference/type-aliases/BlockCheckboxesAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockCheckboxesAction" ---- - -[@slack/bolt](../index.md) / BlockCheckboxesAction - # Type Alias: BlockCheckboxesAction ```ts diff --git a/docs/english/reference/type-aliases/BlockConversationsSelectAction.md b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md index 218bea421..3249caf9b 100644 --- a/docs/english/reference/type-aliases/BlockConversationsSelectAction.md +++ b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockConversationsSelectAction" ---- - -[@slack/bolt](../index.md) / BlockConversationsSelectAction - # Type Alias: BlockConversationsSelectAction ```ts diff --git a/docs/english/reference/type-aliases/BlockDatepickerAction.md b/docs/english/reference/type-aliases/BlockDatepickerAction.md index 2acc56404..e651a4534 100644 --- a/docs/english/reference/type-aliases/BlockDatepickerAction.md +++ b/docs/english/reference/type-aliases/BlockDatepickerAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockDatepickerAction" ---- - -[@slack/bolt](../index.md) / BlockDatepickerAction - # Type Alias: BlockDatepickerAction ```ts diff --git a/docs/english/reference/type-aliases/BlockElementAction.md b/docs/english/reference/type-aliases/BlockElementAction.md index bacefa646..79dd93d3a 100644 --- a/docs/english/reference/type-aliases/BlockElementAction.md +++ b/docs/english/reference/type-aliases/BlockElementAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockElementAction" ---- - -[@slack/bolt](../index.md) / BlockElementAction - # Type Alias: BlockElementAction ```ts diff --git a/docs/english/reference/type-aliases/BlockExternalSelectAction.md b/docs/english/reference/type-aliases/BlockExternalSelectAction.md index 60528f079..da42b4d9b 100644 --- a/docs/english/reference/type-aliases/BlockExternalSelectAction.md +++ b/docs/english/reference/type-aliases/BlockExternalSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockExternalSelectAction" ---- - -[@slack/bolt](../index.md) / BlockExternalSelectAction - # Type Alias: BlockExternalSelectAction ```ts diff --git a/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md index 63a92078a..85c3cb8f2 100644 --- a/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md +++ b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockFeedbackButtonsAction" ---- - -[@slack/bolt](../index.md) / BlockFeedbackButtonsAction - # Type Alias: BlockFeedbackButtonsAction ```ts diff --git a/docs/english/reference/type-aliases/BlockIconButtonAction.md b/docs/english/reference/type-aliases/BlockIconButtonAction.md index e15f45753..886440fd6 100644 --- a/docs/english/reference/type-aliases/BlockIconButtonAction.md +++ b/docs/english/reference/type-aliases/BlockIconButtonAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockIconButtonAction" ---- - -[@slack/bolt](../index.md) / BlockIconButtonAction - # Type Alias: BlockIconButtonAction ```ts diff --git a/docs/english/reference/type-aliases/BlockOverflowAction.md b/docs/english/reference/type-aliases/BlockOverflowAction.md index 5555ecb62..8f0df1f6d 100644 --- a/docs/english/reference/type-aliases/BlockOverflowAction.md +++ b/docs/english/reference/type-aliases/BlockOverflowAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockOverflowAction" ---- - -[@slack/bolt](../index.md) / BlockOverflowAction - # Type Alias: BlockOverflowAction ```ts diff --git a/docs/english/reference/type-aliases/BlockPlainTextInputAction.md b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md index 3f11cf40f..e1669bbfd 100644 --- a/docs/english/reference/type-aliases/BlockPlainTextInputAction.md +++ b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockPlainTextInputAction" ---- - -[@slack/bolt](../index.md) / BlockPlainTextInputAction - # Type Alias: BlockPlainTextInputAction ```ts diff --git a/docs/english/reference/type-aliases/BlockRadioButtonsAction.md b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md index ac7968ec1..69f16ca69 100644 --- a/docs/english/reference/type-aliases/BlockRadioButtonsAction.md +++ b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockRadioButtonsAction" ---- - -[@slack/bolt](../index.md) / BlockRadioButtonsAction - # Type Alias: BlockRadioButtonsAction ```ts diff --git a/docs/english/reference/type-aliases/BlockStaticSelectAction.md b/docs/english/reference/type-aliases/BlockStaticSelectAction.md index d0346fd4a..9ba7bf2fb 100644 --- a/docs/english/reference/type-aliases/BlockStaticSelectAction.md +++ b/docs/english/reference/type-aliases/BlockStaticSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockStaticSelectAction" ---- - -[@slack/bolt](../index.md) / BlockStaticSelectAction - # Type Alias: BlockStaticSelectAction ```ts diff --git a/docs/english/reference/type-aliases/BlockTimepickerAction.md b/docs/english/reference/type-aliases/BlockTimepickerAction.md index 2f723c0fa..b1f8e63fd 100644 --- a/docs/english/reference/type-aliases/BlockTimepickerAction.md +++ b/docs/english/reference/type-aliases/BlockTimepickerAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockTimepickerAction" ---- - -[@slack/bolt](../index.md) / BlockTimepickerAction - # Type Alias: BlockTimepickerAction ```ts diff --git a/docs/english/reference/type-aliases/BlockUsersSelectAction.md b/docs/english/reference/type-aliases/BlockUsersSelectAction.md index 0ad950fdb..54d63a93d 100644 --- a/docs/english/reference/type-aliases/BlockUsersSelectAction.md +++ b/docs/english/reference/type-aliases/BlockUsersSelectAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "BlockUsersSelectAction" ---- - -[@slack/bolt](../index.md) / BlockUsersSelectAction - # Type Alias: BlockUsersSelectAction ```ts diff --git a/docs/english/reference/type-aliases/EventFromType.md b/docs/english/reference/type-aliases/EventFromType.md index 7fdb55c59..e4f1f810e 100644 --- a/docs/english/reference/type-aliases/EventFromType.md +++ b/docs/english/reference/type-aliases/EventFromType.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "EventFromType" ---- - -[@slack/bolt](../index.md) / EventFromType - # Type Alias: EventFromType\ ```ts diff --git a/docs/english/reference/type-aliases/EventTypePattern.md b/docs/english/reference/type-aliases/EventTypePattern.md index 813ad3674..ec2d9dfdc 100644 --- a/docs/english/reference/type-aliases/EventTypePattern.md +++ b/docs/english/reference/type-aliases/EventTypePattern.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "EventTypePattern" ---- - -[@slack/bolt](../index.md) / EventTypePattern - # Type Alias: EventTypePattern ```ts diff --git a/docs/english/reference/type-aliases/FunctionInputs.md b/docs/english/reference/type-aliases/FunctionInputs.md index 8ba159e9d..8c6afae3a 100644 --- a/docs/english/reference/type-aliases/FunctionInputs.md +++ b/docs/english/reference/type-aliases/FunctionInputs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "FunctionInputs" ---- - -[@slack/bolt](../index.md) / FunctionInputs - # Type Alias: FunctionInputs ```ts diff --git a/docs/english/reference/type-aliases/InteractiveAction.md b/docs/english/reference/type-aliases/InteractiveAction.md index 610c3b51e..eb49d0eab 100644 --- a/docs/english/reference/type-aliases/InteractiveAction.md +++ b/docs/english/reference/type-aliases/InteractiveAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "InteractiveAction" ---- - -[@slack/bolt](../index.md) / InteractiveAction - # Type Alias: InteractiveAction ```ts diff --git a/docs/english/reference/type-aliases/InteractiveButtonClick.md b/docs/english/reference/type-aliases/InteractiveButtonClick.md index fdc2e3e38..3b4969f1c 100644 --- a/docs/english/reference/type-aliases/InteractiveButtonClick.md +++ b/docs/english/reference/type-aliases/InteractiveButtonClick.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "InteractiveButtonClick" ---- - -[@slack/bolt](../index.md) / InteractiveButtonClick - # Type Alias: InteractiveButtonClick ```ts diff --git a/docs/english/reference/type-aliases/InteractiveMenuSelect.md b/docs/english/reference/type-aliases/InteractiveMenuSelect.md index 6c170b295..805a04954 100644 --- a/docs/english/reference/type-aliases/InteractiveMenuSelect.md +++ b/docs/english/reference/type-aliases/InteractiveMenuSelect.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "InteractiveMenuSelect" ---- - -[@slack/bolt](../index.md) / InteractiveMenuSelect - # Type Alias: InteractiveMenuSelect ```ts diff --git a/docs/english/reference/type-aliases/KnownEventFromType.md b/docs/english/reference/type-aliases/KnownEventFromType.md index 02f5f6746..83e9f27e4 100644 --- a/docs/english/reference/type-aliases/KnownEventFromType.md +++ b/docs/english/reference/type-aliases/KnownEventFromType.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "KnownEventFromType" ---- - -[@slack/bolt](../index.md) / KnownEventFromType - # Type Alias: KnownEventFromType\ ```ts diff --git a/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md b/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md index 806e33520..fcf5d82a8 100644 --- a/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md +++ b/docs/english/reference/type-aliases/KnownOptionsPayloadFromType.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "KnownOptionsPayloadFromType" ---- - -[@slack/bolt](../index.md) / KnownOptionsPayloadFromType - # Type Alias: KnownOptionsPayloadFromType\ ```ts diff --git a/docs/english/reference/type-aliases/Middleware.md b/docs/english/reference/type-aliases/Middleware.md index df06694c2..a6f0173e1 100644 --- a/docs/english/reference/type-aliases/Middleware.md +++ b/docs/english/reference/type-aliases/Middleware.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "Middleware" ---- - -[@slack/bolt](../index.md) / Middleware - # Type Alias: Middleware\ ```ts diff --git a/docs/english/reference/type-aliases/NextFn.md b/docs/english/reference/type-aliases/NextFn.md index fe9471cc7..89da88d62 100644 --- a/docs/english/reference/type-aliases/NextFn.md +++ b/docs/english/reference/type-aliases/NextFn.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "NextFn" ---- - -[@slack/bolt](../index.md) / NextFn - # Type Alias: NextFn ```ts diff --git a/docs/english/reference/type-aliases/OptionsPayloadFromType.md b/docs/english/reference/type-aliases/OptionsPayloadFromType.md index ed0ce5483..7f0be5908 100644 --- a/docs/english/reference/type-aliases/OptionsPayloadFromType.md +++ b/docs/english/reference/type-aliases/OptionsPayloadFromType.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "OptionsPayloadFromType" ---- - -[@slack/bolt](../index.md) / OptionsPayloadFromType - # Type Alias: OptionsPayloadFromType\ ```ts diff --git a/docs/english/reference/type-aliases/OptionsSource.md b/docs/english/reference/type-aliases/OptionsSource.md index 25b9e5b11..ca00c3ac4 100644 --- a/docs/english/reference/type-aliases/OptionsSource.md +++ b/docs/english/reference/type-aliases/OptionsSource.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "OptionsSource" ---- - -[@slack/bolt](../index.md) / OptionsSource - # Type Alias: OptionsSource ```ts diff --git a/docs/english/reference/type-aliases/RespondArguments.md b/docs/english/reference/type-aliases/RespondArguments.md index cefd188a0..2e3da5a54 100644 --- a/docs/english/reference/type-aliases/RespondArguments.md +++ b/docs/english/reference/type-aliases/RespondArguments.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "RespondArguments" ---- - -[@slack/bolt](../index.md) / RespondArguments - # Type Alias: RespondArguments ```ts diff --git a/docs/english/reference/type-aliases/RespondFn.md b/docs/english/reference/type-aliases/RespondFn.md index 119a46ad7..b1aeb0363 100644 --- a/docs/english/reference/type-aliases/RespondFn.md +++ b/docs/english/reference/type-aliases/RespondFn.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "RespondFn" ---- - -[@slack/bolt](../index.md) / RespondFn - # Type Alias: RespondFn ```ts diff --git a/docs/english/reference/type-aliases/SayArguments.md b/docs/english/reference/type-aliases/SayArguments.md index e3cda7f58..234391cd1 100644 --- a/docs/english/reference/type-aliases/SayArguments.md +++ b/docs/english/reference/type-aliases/SayArguments.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SayArguments" ---- - -[@slack/bolt](../index.md) / SayArguments - # Type Alias: SayArguments ```ts diff --git a/docs/english/reference/type-aliases/SayFn.md b/docs/english/reference/type-aliases/SayFn.md index 4df9c39ea..9740a5fb2 100644 --- a/docs/english/reference/type-aliases/SayFn.md +++ b/docs/english/reference/type-aliases/SayFn.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SayFn" ---- - -[@slack/bolt](../index.md) / SayFn - # Type Alias: SayFn ```ts diff --git a/docs/english/reference/type-aliases/SayStreamArguments.md b/docs/english/reference/type-aliases/SayStreamArguments.md index ec767f9ae..dacc64e69 100644 --- a/docs/english/reference/type-aliases/SayStreamArguments.md +++ b/docs/english/reference/type-aliases/SayStreamArguments.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SayStreamArguments" ---- - -[@slack/bolt](../index.md) / SayStreamArguments - # Type Alias: SayStreamArguments ```ts diff --git a/docs/english/reference/type-aliases/SayStreamFn.md b/docs/english/reference/type-aliases/SayStreamFn.md index ece201db4..a2aac956d 100644 --- a/docs/english/reference/type-aliases/SayStreamFn.md +++ b/docs/english/reference/type-aliases/SayStreamFn.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SayStreamFn" ---- - -[@slack/bolt](../index.md) / SayStreamFn - # Type Alias: SayStreamFn ```ts diff --git a/docs/english/reference/type-aliases/SetStatusArguments.md b/docs/english/reference/type-aliases/SetStatusArguments.md index c2e6162f0..ff7a80a3d 100644 --- a/docs/english/reference/type-aliases/SetStatusArguments.md +++ b/docs/english/reference/type-aliases/SetStatusArguments.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SetStatusArguments" ---- - -[@slack/bolt](../index.md) / SetStatusArguments - # Type Alias: SetStatusArguments ```ts diff --git a/docs/english/reference/type-aliases/SetStatusFn.md b/docs/english/reference/type-aliases/SetStatusFn.md index e48b2368e..c5f6ac4fc 100644 --- a/docs/english/reference/type-aliases/SetStatusFn.md +++ b/docs/english/reference/type-aliases/SetStatusFn.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SetStatusFn" ---- - -[@slack/bolt](../index.md) / SetStatusFn - # Type Alias: SetStatusFn ```ts diff --git a/docs/english/reference/type-aliases/SlackAction.md b/docs/english/reference/type-aliases/SlackAction.md index e4c1bea5c..6009585cb 100644 --- a/docs/english/reference/type-aliases/SlackAction.md +++ b/docs/english/reference/type-aliases/SlackAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackAction" ---- - -[@slack/bolt](../index.md) / SlackAction - # Type Alias: SlackAction ```ts diff --git a/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md index 1da771740..82357856d 100644 --- a/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackActionMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / SlackActionMiddlewareArgs - # Type Alias: SlackActionMiddlewareArgs\ ```ts diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md index 42436cf96..790f690e4 100644 --- a/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackEventMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / SlackEventMiddlewareArgs - # Type Alias: SlackEventMiddlewareArgs\ ```ts diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md index 22268fc23..d6deb0e78 100644 --- a/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackEventMiddlewareArgsOptions" ---- - -[@slack/bolt](../index.md) / SlackEventMiddlewareArgsOptions - # Type Alias: SlackEventMiddlewareArgsOptions ```ts diff --git a/docs/english/reference/type-aliases/SlackOptions.md b/docs/english/reference/type-aliases/SlackOptions.md index a8ccf6229..93d6917a9 100644 --- a/docs/english/reference/type-aliases/SlackOptions.md +++ b/docs/english/reference/type-aliases/SlackOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackOptions" ---- - -[@slack/bolt](../index.md) / SlackOptions - # Type Alias: SlackOptions ```ts diff --git a/docs/english/reference/type-aliases/SlackShortcut.md b/docs/english/reference/type-aliases/SlackShortcut.md index 7b813c344..55901622e 100644 --- a/docs/english/reference/type-aliases/SlackShortcut.md +++ b/docs/english/reference/type-aliases/SlackShortcut.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackShortcut" ---- - -[@slack/bolt](../index.md) / SlackShortcut - # Type Alias: SlackShortcut ```ts diff --git a/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md index 4fdcfd9dd..fd4ff7f2b 100644 --- a/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackShortcutMiddlewareArgs" ---- - -[@slack/bolt](../index.md) / SlackShortcutMiddlewareArgs - # Type Alias: SlackShortcutMiddlewareArgs\ ```ts diff --git a/docs/english/reference/type-aliases/SlackViewAction.md b/docs/english/reference/type-aliases/SlackViewAction.md index e891e9807..5ec236419 100644 --- a/docs/english/reference/type-aliases/SlackViewAction.md +++ b/docs/english/reference/type-aliases/SlackViewAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "SlackViewAction" ---- - -[@slack/bolt](../index.md) / SlackViewAction - # Type Alias: SlackViewAction ```ts diff --git a/docs/english/reference/type-aliases/StringIndexed.md b/docs/english/reference/type-aliases/StringIndexed.md index 2b26fb134..8bb81676e 100644 --- a/docs/english/reference/type-aliases/StringIndexed.md +++ b/docs/english/reference/type-aliases/StringIndexed.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "StringIndexed" ---- - -[@slack/bolt](../index.md) / StringIndexed - # Type Alias: StringIndexed ```ts diff --git a/docs/english/reference/type-aliases/ViewResponseAction.md b/docs/english/reference/type-aliases/ViewResponseAction.md index afcd10c4b..ccfc99743 100644 --- a/docs/english/reference/type-aliases/ViewResponseAction.md +++ b/docs/english/reference/type-aliases/ViewResponseAction.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ViewResponseAction" ---- - -[@slack/bolt](../index.md) / ViewResponseAction - # Type Alias: ViewResponseAction ```ts diff --git a/docs/english/reference/type-aliases/XOR.md b/docs/english/reference/type-aliases/XOR.md index 8c08b6ff7..e6bc9dbe4 100644 --- a/docs/english/reference/type-aliases/XOR.md +++ b/docs/english/reference/type-aliases/XOR.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "XOR" ---- - -[@slack/bolt](../index.md) / XOR - # Type Alias: XOR\ ```ts diff --git a/docs/english/reference/variables/autoAcknowledge.md b/docs/english/reference/variables/autoAcknowledge.md index 4a3f91770..f7d5cbbf1 100644 --- a/docs/english/reference/variables/autoAcknowledge.md +++ b/docs/english/reference/variables/autoAcknowledge.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "autoAcknowledge" ---- - -[@slack/bolt](../index.md) / autoAcknowledge - # Variable: autoAcknowledge ```ts diff --git a/docs/english/reference/variables/contextBuiltinKeys.md b/docs/english/reference/variables/contextBuiltinKeys.md index 618915618..cb278901f 100644 --- a/docs/english/reference/variables/contextBuiltinKeys.md +++ b/docs/english/reference/variables/contextBuiltinKeys.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "contextBuiltinKeys" ---- - -[@slack/bolt](../index.md) / contextBuiltinKeys - # Variable: contextBuiltinKeys ```ts diff --git a/docs/english/reference/variables/directMention.md b/docs/english/reference/variables/directMention.md index 1eb6bea2c..8c66e32c6 100644 --- a/docs/english/reference/variables/directMention.md +++ b/docs/english/reference/variables/directMention.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "directMention" ---- - -[@slack/bolt](../index.md) / directMention - # Variable: directMention ```ts diff --git a/docs/english/reference/variables/ignoreSelf.md b/docs/english/reference/variables/ignoreSelf.md index f27e3ccbb..4af7902cc 100644 --- a/docs/english/reference/variables/ignoreSelf.md +++ b/docs/english/reference/variables/ignoreSelf.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "ignoreSelf" ---- - -[@slack/bolt](../index.md) / ignoreSelf - # Variable: ignoreSelf ```ts diff --git a/docs/english/reference/variables/onlyActions.md b/docs/english/reference/variables/onlyActions.md index 6af839f71..bb80b0463 100644 --- a/docs/english/reference/variables/onlyActions.md +++ b/docs/english/reference/variables/onlyActions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "onlyActions" ---- - -[@slack/bolt](../index.md) / onlyActions - # Variable: onlyActions ```ts diff --git a/docs/english/reference/variables/onlyCommands.md b/docs/english/reference/variables/onlyCommands.md index 39e388d7c..f2b4cdf37 100644 --- a/docs/english/reference/variables/onlyCommands.md +++ b/docs/english/reference/variables/onlyCommands.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "onlyCommands" ---- - -[@slack/bolt](../index.md) / onlyCommands - # Variable: onlyCommands ```ts diff --git a/docs/english/reference/variables/onlyEvents.md b/docs/english/reference/variables/onlyEvents.md index 920c803c6..a83b3cae8 100644 --- a/docs/english/reference/variables/onlyEvents.md +++ b/docs/english/reference/variables/onlyEvents.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "onlyEvents" ---- - -[@slack/bolt](../index.md) / onlyEvents - # Variable: onlyEvents ```ts diff --git a/docs/english/reference/variables/onlyOptions.md b/docs/english/reference/variables/onlyOptions.md index 5d3b6e708..c5c8db331 100644 --- a/docs/english/reference/variables/onlyOptions.md +++ b/docs/english/reference/variables/onlyOptions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "onlyOptions" ---- - -[@slack/bolt](../index.md) / onlyOptions - # Variable: onlyOptions ```ts diff --git a/docs/english/reference/variables/onlyShortcuts.md b/docs/english/reference/variables/onlyShortcuts.md index 5fa297c0f..cc09b0b9b 100644 --- a/docs/english/reference/variables/onlyShortcuts.md +++ b/docs/english/reference/variables/onlyShortcuts.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "onlyShortcuts" ---- - -[@slack/bolt](../index.md) / onlyShortcuts - # Variable: onlyShortcuts ```ts diff --git a/docs/english/reference/variables/onlyViewActions.md b/docs/english/reference/variables/onlyViewActions.md index ddfe04b93..dff5a6152 100644 --- a/docs/english/reference/variables/onlyViewActions.md +++ b/docs/english/reference/variables/onlyViewActions.md @@ -1,9 +1,3 @@ ---- -sidebar_label: "onlyViewActions" ---- - -[@slack/bolt](../index.md) / onlyViewActions - # Variable: onlyViewActions ```ts diff --git a/typedoc.json b/typedoc.json index f45f28fa7..06a389773 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,7 +1,8 @@ { "$schema": "https://typedoc.org/schema.json", "entryPoints": ["src/index.ts"], - "plugin": ["typedoc-plugin-markdown", "./typedoc-plugin-sidebar-labels.mjs"], + "plugin": ["typedoc-plugin-markdown"], + "hideBreadcrumbs": true, "outputs": [ { "name": "markdown", From d5276a4ef46fb5cc6e3d1d1f6f35714838b1a032 Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Thu, 27 Aug 2026 10:23:34 -0700 Subject: [PATCH 6/7] go --- .../namespaces/HTTPModuleFunctions/index.md | 4 +++ docs/english/reference/index.md | 5 +++ typedoc-plugin-sidebar-labels.mjs | 31 ++++++++++--------- typedoc.json | 2 +- 4 files changed, 27 insertions(+), 15 deletions(-) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md index ad14f471d..7eeab77be 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/index.md @@ -1,3 +1,7 @@ +--- +sidebar_label: "HTTPModuleFunctions" +--- + # HTTPModuleFunctions ## Interfaces diff --git a/docs/english/reference/index.md b/docs/english/reference/index.md index 5a293b146..c49a17756 100644 --- a/docs/english/reference/index.md +++ b/docs/english/reference/index.md @@ -1,3 +1,8 @@ +--- +sidebar_label: "@slack/bolt" +sidebar_position: 0 +--- + # @slack/bolt v5.0.0 ## Namespaces diff --git a/typedoc-plugin-sidebar-labels.mjs b/typedoc-plugin-sidebar-labels.mjs index 738440baa..944cfbdca 100644 --- a/typedoc-plugin-sidebar-labels.mjs +++ b/typedoc-plugin-sidebar-labels.mjs @@ -1,17 +1,19 @@ // @ts-check +import { ReflectionKind } from 'typedoc'; import { MarkdownPageEvent } from 'typedoc-plugin-markdown'; /** - * Local TypeDoc plugin: stamp a `sidebar_label` frontmatter onto every generated - * page equal to the reflection's name. + * Local TypeDoc plugin: fix the two index pages whose sidebar entry would + * otherwise be wrong. Every other page is left to the H1-derived label produced + * by `hideBreadcrumbs` + `pageTitleTemplates`. * - * Why: typedoc-plugin-markdown prints a breadcrumb line before the page's H1, so - * Docusaurus cannot infer a content title and falls back to the doc id's last - * segment. For most pages the segment is the export name ("App"), but for the - * `index.md` of a module/namespace it is literally "index" — which then becomes - * the label of the auto-generated sidebar category (e.g. HTTPModuleFunctions - * rendered as "index"). Emitting an explicit sidebar_label removes the reliance - * on that fallback and keeps category and leaf labels stable across regeneration. + * 1. The project root (reference/index.md). It renders as a standalone sidebar + * item rather than a category link, so it otherwise sorts alphabetically as + * "index" between "functions" and "interfaces". Stamp its name and pin it to + * the top of the Reference section. + * 2. Each namespace / module index (e.g. HTTPModuleFunctions/index.md). Its file + * is literally index.md, so absent an explicit label the auto-generated + * sidebar category falls back to "index". Stamp the reflection name. * * @param {import('typedoc').Application} app */ @@ -22,12 +24,13 @@ export function load(app) { if (!label) { return; } + const isProject = typeof model.isProject === 'function' && model.isProject(); + const isNamespace = typeof model.kindOf === 'function' && model.kindOf(ReflectionKind.Namespace | ReflectionKind.Module); + if (!isProject && !isNamespace) { + return; + } const frontmatter = [`sidebar_label: ${JSON.stringify(label)}`]; - // The project root page (reference/index.md) is emitted as a standalone - // sidebar item rather than a category link, so it otherwise sorts - // alphabetically as "index" — landing between "functions" and - // "interfaces". Pin it to the top of the Reference section. - if (typeof model.isProject === 'function' && model.isProject()) { + if (isProject) { frontmatter.push('sidebar_position: 0'); } page.contents = `---\n${frontmatter.join('\n')}\n---\n\n${page.contents ?? ''}`; diff --git a/typedoc.json b/typedoc.json index 06a389773..a4f400769 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,7 +1,7 @@ { "$schema": "https://typedoc.org/schema.json", "entryPoints": ["src/index.ts"], - "plugin": ["typedoc-plugin-markdown"], + "plugin": ["typedoc-plugin-markdown", "./typedoc-plugin-sidebar-labels.mjs"], "hideBreadcrumbs": true, "outputs": [ { From 94bab310a0c4b34f83f2574f1f03a7300fd3947a Mon Sep 17 00:00:00 2001 From: Luke Russell Date: Thu, 27 Aug 2026 10:27:08 -0700 Subject: [PATCH 7/7] go --- .../HTTPModuleFunctions/functions/bufferIncomingMessage.md | 2 +- .../HTTPModuleFunctions/functions/buildContentResponse.md | 2 +- .../HTTPModuleFunctions/functions/buildNoBodyResponse.md | 2 +- .../HTTPModuleFunctions/functions/buildSSLCheckResponse.md | 2 +- .../functions/buildUrlVerificationResponse.md | 2 +- .../functions/defaultAsyncDispatchErrorHandler.md | 2 +- .../functions/defaultDispatchErrorHandler.md | 2 +- .../functions/defaultProcessEventErrorHandler.md | 2 +- .../functions/defaultUnhandledRequestHandler.md | 2 +- .../functions/extractRetryNumFromHTTPRequest.md | 2 +- .../functions/extractRetryReasonFromHTTPRequest.md | 2 +- .../namespaces/HTTPModuleFunctions/functions/getHeader.md | 2 +- .../functions/isBufferedIncomingMessage.md | 2 +- .../functions/parseAndVerifyHTTPRequest.md | 2 +- .../HTTPModuleFunctions/functions/parseHTTPRequestBody.md | 2 +- .../interfaces/ReceiverDispatchErrorHandlerArgs.md | 2 +- .../interfaces/ReceiverProcessEventErrorHandlerArgs.md | 2 +- .../interfaces/ReceiverUnhandledRequestHandlerArgs.md | 2 +- .../interfaces/RequestVerificationOptions.md | 2 +- docs/english/reference/classes/App.md | 2 +- docs/english/reference/classes/AppInitializationError.md | 2 +- docs/english/reference/classes/Assistant.md | 2 +- .../reference/classes/AssistantInitializationError.md | 2 +- .../reference/classes/AssistantMissingPropertyError.md | 2 +- docs/english/reference/classes/AuthorizationError.md | 2 +- docs/english/reference/classes/AwsLambdaReceiver.md | 2 +- .../english/reference/classes/ContextMissingPropertyError.md | 2 +- .../reference/classes/CustomFunctionCompleteFailError.md | 2 +- .../reference/classes/CustomFunctionCompleteSuccessError.md | 2 +- .../reference/classes/CustomFunctionInitializationError.md | 2 +- .../reference/classes/CustomRouteInitializationError.md | 2 +- docs/english/reference/classes/ExpressReceiver.md | 2 +- docs/english/reference/classes/HTTPReceiver.md | 2 +- .../reference/classes/HTTPReceiverDeferredRequestError.md | 2 +- docs/english/reference/classes/HTTPResponseAck.md | 2 +- docs/english/reference/classes/InvalidCustomPropertyError.md | 2 +- docs/english/reference/classes/MemoryStore.md | 2 +- docs/english/reference/classes/MultipleListenerError.md | 2 +- docs/english/reference/classes/ReceiverAuthenticityError.md | 2 +- .../reference/classes/ReceiverInconsistentStateError.md | 2 +- docs/english/reference/classes/ReceiverMultipleAckError.md | 2 +- docs/english/reference/classes/RespondError.md | 2 +- docs/english/reference/classes/SocketModeReceiver.md | 2 +- docs/english/reference/classes/UnknownError.md | 2 +- docs/english/reference/enumerations/ErrorCode.md | 2 +- docs/english/reference/functions/asCodedError.md | 2 +- docs/english/reference/functions/buildReceiverRoutes.md | 2 +- .../reference/functions/defaultProcessEventErrorHandler.md | 2 +- docs/english/reference/functions/isCodedError.md | 2 +- docs/english/reference/functions/isFulfilled.md | 2 +- docs/english/reference/functions/isRejected.md | 2 +- .../reference/functions/isSlackEventMiddlewareArgsOptions.md | 2 +- docs/english/reference/functions/isValidSlackRequest.md | 2 +- docs/english/reference/functions/matchCommandName.md | 2 +- docs/english/reference/functions/matchConstraints.md | 2 +- docs/english/reference/functions/matchEventType.md | 2 +- docs/english/reference/functions/matchMessage.md | 2 +- docs/english/reference/functions/subtype.md | 2 +- docs/english/reference/functions/verifySlackRequest.md | 2 +- docs/english/reference/index.md | 2 +- docs/english/reference/interfaces/ActionConstraints.md | 2 +- docs/english/reference/interfaces/AllMiddlewareArgs.md | 2 +- docs/english/reference/interfaces/AppOptions.md | 2 +- docs/english/reference/interfaces/AssistantConfig.md | 2 +- docs/english/reference/interfaces/AuthorizeResult.md | 2 +- docs/english/reference/interfaces/AuthorizeSourceData.md | 2 +- .../english/reference/interfaces/AwsLambdaReceiverOptions.md | 2 +- docs/english/reference/interfaces/BaseSlackEvent.md | 2 +- docs/english/reference/interfaces/BasicElementAction.md | 2 +- docs/english/reference/interfaces/BasicOptionsPayload.md | 2 +- docs/english/reference/interfaces/BlockAction.md | 2 +- docs/english/reference/interfaces/BlockOptions.md | 2 +- docs/english/reference/interfaces/BlockSuggestion.md | 2 +- docs/english/reference/interfaces/BufferedIncomingMessage.md | 2 +- docs/english/reference/interfaces/ButtonAction.md | 2 +- docs/english/reference/interfaces/ButtonClick.md | 2 +- docs/english/reference/interfaces/ChannelsSelectAction.md | 2 +- docs/english/reference/interfaces/CheckboxesAction.md | 2 +- docs/english/reference/interfaces/CodedError.md | 2 +- docs/english/reference/interfaces/Context.md | 2 +- docs/english/reference/interfaces/ConversationStore.md | 2 +- .../reference/interfaces/ConversationsSelectAction.md | 2 +- docs/english/reference/interfaces/CustomRoute.md | 2 +- docs/english/reference/interfaces/DatepickerAction.md | 2 +- docs/english/reference/interfaces/DialogOptionGroups.md | 2 +- docs/english/reference/interfaces/DialogOptions.md | 2 +- docs/english/reference/interfaces/DialogSubmitAction.md | 2 +- docs/english/reference/interfaces/DialogSuggestion.md | 2 +- docs/english/reference/interfaces/DialogValidation.md | 2 +- docs/english/reference/interfaces/EnvelopedEvent.md | 2 +- docs/english/reference/interfaces/ExpressReceiverOptions.md | 2 +- docs/english/reference/interfaces/ExternalSelectAction.md | 2 +- docs/english/reference/interfaces/FeedbackButtonsAction.md | 2 +- docs/english/reference/interfaces/GlobalShortcut.md | 2 +- docs/english/reference/interfaces/HTTPReceiverOptions.md | 2 +- docs/english/reference/interfaces/IconButtonAction.md | 2 +- docs/english/reference/interfaces/InteractiveMessage.md | 2 +- .../reference/interfaces/InteractiveMessageSuggestion.md | 2 +- docs/english/reference/interfaces/MenuSelect.md | 2 +- docs/english/reference/interfaces/MessageOptions.md | 2 +- docs/english/reference/interfaces/MessageShortcut.md | 2 +- .../reference/interfaces/MultiChannelsSelectAction.md | 2 +- .../reference/interfaces/MultiConversationsSelectAction.md | 2 +- .../reference/interfaces/MultiExternalSelectAction.md | 2 +- docs/english/reference/interfaces/MultiStaticSelectAction.md | 2 +- docs/english/reference/interfaces/MultiUsersSelectAction.md | 2 +- docs/english/reference/interfaces/OptionGroups.md | 2 +- docs/english/reference/interfaces/OptionsConstraints.md | 2 +- docs/english/reference/interfaces/OverflowAction.md | 2 +- docs/english/reference/interfaces/PlainTextInputAction.md | 2 +- docs/english/reference/interfaces/RadioButtonsAction.md | 2 +- docs/english/reference/interfaces/Receiver.md | 2 +- docs/english/reference/interfaces/ReceiverEvent.md | 2 +- docs/english/reference/interfaces/ReceiverRoutes.md | 2 +- docs/english/reference/interfaces/ResponseAck.md | 2 +- docs/english/reference/interfaces/RichTextInputAction.md | 2 +- docs/english/reference/interfaces/ShortcutConstraints.md | 2 +- .../reference/interfaces/SlackCommandMiddlewareArgs.md | 2 +- .../reference/interfaces/SlackOptionsMiddlewareArgs.md | 2 +- docs/english/reference/interfaces/SlackViewMiddlewareArgs.md | 2 +- docs/english/reference/interfaces/SlashCommand.md | 2 +- .../reference/interfaces/SocketModeReceiverOptions.md | 2 +- .../SocketModeReceiverProcessEventErrorHandlerArgs.md | 2 +- docs/english/reference/interfaces/StaticSelectAction.md | 2 +- docs/english/reference/interfaces/TimepickerAction.md | 2 +- docs/english/reference/interfaces/UploadedFile.md | 2 +- docs/english/reference/interfaces/UsersSelectAction.md | 2 +- docs/english/reference/interfaces/ViewClearResponseAction.md | 2 +- docs/english/reference/interfaces/ViewClosedAction.md | 2 +- docs/english/reference/interfaces/ViewConstraints.md | 2 +- .../english/reference/interfaces/ViewErrorsResponseAction.md | 2 +- docs/english/reference/interfaces/ViewOutput.md | 2 +- docs/english/reference/interfaces/ViewPushResponseAction.md | 2 +- docs/english/reference/interfaces/ViewResponseUrl.md | 2 +- docs/english/reference/interfaces/ViewStateSelectedOption.md | 2 +- docs/english/reference/interfaces/ViewStateValue.md | 2 +- docs/english/reference/interfaces/ViewSubmitAction.md | 2 +- .../english/reference/interfaces/ViewUpdateResponseAction.md | 2 +- docs/english/reference/type-aliases/AckFn.md | 2 +- docs/english/reference/type-aliases/AnyMiddlewareArgs.md | 2 +- .../type-aliases/AssistantThreadContextChangedMiddleware.md | 2 +- .../type-aliases/AssistantThreadStartedMiddleware.md | 2 +- .../reference/type-aliases/AssistantUserMessageMiddleware.md | 2 +- docs/english/reference/type-aliases/Authorize.md | 2 +- docs/english/reference/type-aliases/BlockButtonAction.md | 2 +- .../reference/type-aliases/BlockChannelsSelectAction.md | 2 +- docs/english/reference/type-aliases/BlockCheckboxesAction.md | 2 +- .../reference/type-aliases/BlockConversationsSelectAction.md | 2 +- docs/english/reference/type-aliases/BlockDatepickerAction.md | 2 +- docs/english/reference/type-aliases/BlockElementAction.md | 2 +- .../reference/type-aliases/BlockExternalSelectAction.md | 2 +- .../reference/type-aliases/BlockFeedbackButtonsAction.md | 2 +- docs/english/reference/type-aliases/BlockIconButtonAction.md | 2 +- docs/english/reference/type-aliases/BlockOverflowAction.md | 2 +- .../reference/type-aliases/BlockPlainTextInputAction.md | 2 +- .../reference/type-aliases/BlockRadioButtonsAction.md | 2 +- .../reference/type-aliases/BlockStaticSelectAction.md | 2 +- docs/english/reference/type-aliases/BlockTimepickerAction.md | 2 +- .../english/reference/type-aliases/BlockUsersSelectAction.md | 2 +- docs/english/reference/type-aliases/EventFromType.md | 2 +- docs/english/reference/type-aliases/EventTypePattern.md | 2 +- docs/english/reference/type-aliases/FunctionInputs.md | 2 +- docs/english/reference/type-aliases/InteractiveAction.md | 2 +- .../english/reference/type-aliases/InteractiveButtonClick.md | 2 +- docs/english/reference/type-aliases/InteractiveMenuSelect.md | 2 +- docs/english/reference/type-aliases/KnownEventFromType.md | 2 +- .../reference/type-aliases/KnownOptionsPayloadFromType.md | 2 +- docs/english/reference/type-aliases/Middleware.md | 2 +- docs/english/reference/type-aliases/NextFn.md | 2 +- .../english/reference/type-aliases/OptionsPayloadFromType.md | 2 +- docs/english/reference/type-aliases/OptionsSource.md | 2 +- docs/english/reference/type-aliases/RespondArguments.md | 2 +- docs/english/reference/type-aliases/RespondFn.md | 2 +- docs/english/reference/type-aliases/SayArguments.md | 2 +- docs/english/reference/type-aliases/SayFn.md | 2 +- docs/english/reference/type-aliases/SayStreamArguments.md | 2 +- docs/english/reference/type-aliases/SayStreamFn.md | 2 +- docs/english/reference/type-aliases/SetStatusArguments.md | 2 +- docs/english/reference/type-aliases/SetStatusFn.md | 2 +- docs/english/reference/type-aliases/SlackAction.md | 2 +- .../reference/type-aliases/SlackActionMiddlewareArgs.md | 2 +- .../reference/type-aliases/SlackEventMiddlewareArgs.md | 2 +- .../type-aliases/SlackEventMiddlewareArgsOptions.md | 2 +- docs/english/reference/type-aliases/SlackOptions.md | 2 +- docs/english/reference/type-aliases/SlackShortcut.md | 2 +- .../reference/type-aliases/SlackShortcutMiddlewareArgs.md | 2 +- docs/english/reference/type-aliases/SlackViewAction.md | 2 +- docs/english/reference/type-aliases/StringIndexed.md | 2 +- docs/english/reference/type-aliases/ViewResponseAction.md | 2 +- docs/english/reference/type-aliases/XOR.md | 2 +- docs/english/reference/variables/autoAcknowledge.md | 2 +- docs/english/reference/variables/contextBuiltinKeys.md | 2 +- docs/english/reference/variables/directMention.md | 2 +- docs/english/reference/variables/ignoreSelf.md | 2 +- docs/english/reference/variables/onlyActions.md | 2 +- docs/english/reference/variables/onlyCommands.md | 2 +- docs/english/reference/variables/onlyEvents.md | 2 +- docs/english/reference/variables/onlyOptions.md | 2 +- docs/english/reference/variables/onlyShortcuts.md | 2 +- docs/english/reference/variables/onlyViewActions.md | 2 +- typedoc.json | 5 +++++ 201 files changed, 205 insertions(+), 200 deletions(-) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md index 378fb3888..f03079e7b 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/bufferIncomingMessage.md @@ -1,4 +1,4 @@ -# Function: bufferIncomingMessage() +# bufferIncomingMessage() ```ts function bufferIncomingMessage(req): Promise; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md index 82c3cb153..6962885f5 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildContentResponse.md @@ -1,4 +1,4 @@ -# Function: buildContentResponse() +# buildContentResponse() ```ts function buildContentResponse(res, body): void; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md index eb4ce500f..63a4759ff 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildNoBodyResponse.md @@ -1,4 +1,4 @@ -# Function: buildNoBodyResponse() +# buildNoBodyResponse() ```ts function buildNoBodyResponse(res, status): void; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md index a37b130ba..0ce66dc43 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildSSLCheckResponse.md @@ -1,4 +1,4 @@ -# Function: buildSSLCheckResponse() +# buildSSLCheckResponse() ```ts function buildSSLCheckResponse(res): void; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md index c9ec752ee..d3fbbedda 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/buildUrlVerificationResponse.md @@ -1,4 +1,4 @@ -# Function: buildUrlVerificationResponse() +# buildUrlVerificationResponse() ```ts function buildUrlVerificationResponse(res, body): void; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md index 3d93f7836..ba8aa6b9a 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultAsyncDispatchErrorHandler.md @@ -1,4 +1,4 @@ -# Function: defaultAsyncDispatchErrorHandler() +# defaultAsyncDispatchErrorHandler() ```ts function defaultAsyncDispatchErrorHandler(args): Promise; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md index bab8b103f..0fe344639 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultDispatchErrorHandler.md @@ -1,4 +1,4 @@ -# Function: defaultDispatchErrorHandler() +# defaultDispatchErrorHandler() ```ts function defaultDispatchErrorHandler(args): void; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md index 7fa55d5b2..a7647ab41 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultProcessEventErrorHandler.md @@ -1,4 +1,4 @@ -# Function: defaultProcessEventErrorHandler() +# defaultProcessEventErrorHandler() ```ts function defaultProcessEventErrorHandler(args): Promise; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md index ab3f364ca..989aeb4a8 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/defaultUnhandledRequestHandler.md @@ -1,4 +1,4 @@ -# Function: defaultUnhandledRequestHandler() +# defaultUnhandledRequestHandler() ```ts function defaultUnhandledRequestHandler(args): void; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md index ff19be35e..b1da34fa0 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryNumFromHTTPRequest.md @@ -1,4 +1,4 @@ -# Function: extractRetryNumFromHTTPRequest() +# extractRetryNumFromHTTPRequest() ```ts function extractRetryNumFromHTTPRequest(req): number | undefined; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md index 23fcbce4b..cb4af51cf 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/extractRetryReasonFromHTTPRequest.md @@ -1,4 +1,4 @@ -# Function: extractRetryReasonFromHTTPRequest() +# extractRetryReasonFromHTTPRequest() ```ts function extractRetryReasonFromHTTPRequest(req): string | undefined; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md index bf0261521..d9a20a4b1 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/getHeader.md @@ -1,4 +1,4 @@ -# Function: getHeader() +# getHeader() ```ts function getHeader(req, header): string; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md index 32e5d8ce2..eb6e79f50 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/isBufferedIncomingMessage.md @@ -1,4 +1,4 @@ -# Function: isBufferedIncomingMessage() +# isBufferedIncomingMessage() ```ts function isBufferedIncomingMessage(req): req is BufferedIncomingMessage; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md index 4da6860e4..8ecda3416 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseAndVerifyHTTPRequest.md @@ -1,4 +1,4 @@ -# Function: parseAndVerifyHTTPRequest() +# parseAndVerifyHTTPRequest() ```ts function parseAndVerifyHTTPRequest( diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md index a5f5e6980..37a3c2fed 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/functions/parseHTTPRequestBody.md @@ -1,4 +1,4 @@ -# Function: parseHTTPRequestBody() +# parseHTTPRequestBody() ```ts function parseHTTPRequestBody(req): any; diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md index 535d9f358..a93cfc9ae 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverDispatchErrorHandlerArgs.md @@ -1,4 +1,4 @@ -# Interface: ReceiverDispatchErrorHandlerArgs +# ReceiverDispatchErrorHandlerArgs Defined in: [src/receivers/HTTPModuleFunctions.ts:236](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L236) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md index 977d72bc8..de531afaf 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverProcessEventErrorHandlerArgs.md @@ -1,4 +1,4 @@ -# Interface: ReceiverProcessEventErrorHandlerArgs +# ReceiverProcessEventErrorHandlerArgs Defined in: [src/receivers/HTTPModuleFunctions.ts:245](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L245) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md index 4aa1cc19a..9783cd839 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/ReceiverUnhandledRequestHandlerArgs.md @@ -1,4 +1,4 @@ -# Interface: ReceiverUnhandledRequestHandlerArgs +# ReceiverUnhandledRequestHandlerArgs Defined in: [src/receivers/HTTPModuleFunctions.ts:257](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L257) diff --git a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md index f479f87c4..177ff08c3 100644 --- a/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md +++ b/docs/english/reference/bolt/namespaces/HTTPModuleFunctions/interfaces/RequestVerificationOptions.md @@ -1,4 +1,4 @@ -# Interface: RequestVerificationOptions +# RequestVerificationOptions Defined in: [src/receivers/HTTPModuleFunctions.ts:228](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPModuleFunctions.ts#L228) diff --git a/docs/english/reference/classes/App.md b/docs/english/reference/classes/App.md index 4fe7df5be..178b967fb 100644 --- a/docs/english/reference/classes/App.md +++ b/docs/english/reference/classes/App.md @@ -1,4 +1,4 @@ -# Class: App\ +# App\ Defined in: [src/App.ts:233](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L233) diff --git a/docs/english/reference/classes/AppInitializationError.md b/docs/english/reference/classes/AppInitializationError.md index fe16c7d39..f76e3df83 100644 --- a/docs/english/reference/classes/AppInitializationError.md +++ b/docs/english/reference/classes/AppInitializationError.md @@ -1,4 +1,4 @@ -# Class: AppInitializationError +# AppInitializationError Defined in: [src/errors.ts:72](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L72) diff --git a/docs/english/reference/classes/Assistant.md b/docs/english/reference/classes/Assistant.md index db8168b91..0624d29d3 100644 --- a/docs/english/reference/classes/Assistant.md +++ b/docs/english/reference/classes/Assistant.md @@ -1,4 +1,4 @@ -# Class: Assistant +# Assistant Defined in: [src/Assistant.ts:99](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L99) diff --git a/docs/english/reference/classes/AssistantInitializationError.md b/docs/english/reference/classes/AssistantInitializationError.md index 9e3563cf9..5d6e43568 100644 --- a/docs/english/reference/classes/AssistantInitializationError.md +++ b/docs/english/reference/classes/AssistantInitializationError.md @@ -1,4 +1,4 @@ -# Class: AssistantInitializationError +# AssistantInitializationError Defined in: [src/errors.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L76) diff --git a/docs/english/reference/classes/AssistantMissingPropertyError.md b/docs/english/reference/classes/AssistantMissingPropertyError.md index e2fb14bec..698c1537e 100644 --- a/docs/english/reference/classes/AssistantMissingPropertyError.md +++ b/docs/english/reference/classes/AssistantMissingPropertyError.md @@ -1,4 +1,4 @@ -# Class: AssistantMissingPropertyError +# AssistantMissingPropertyError Defined in: [src/errors.ts:80](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L80) diff --git a/docs/english/reference/classes/AuthorizationError.md b/docs/english/reference/classes/AuthorizationError.md index fb4745c2b..9362c4ad4 100644 --- a/docs/english/reference/classes/AuthorizationError.md +++ b/docs/english/reference/classes/AuthorizationError.md @@ -1,4 +1,4 @@ -# Class: AuthorizationError +# AuthorizationError Defined in: [src/errors.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L84) diff --git a/docs/english/reference/classes/AwsLambdaReceiver.md b/docs/english/reference/classes/AwsLambdaReceiver.md index 4d85c1f66..63770101d 100644 --- a/docs/english/reference/classes/AwsLambdaReceiver.md +++ b/docs/english/reference/classes/AwsLambdaReceiver.md @@ -1,4 +1,4 @@ -# Class: AwsLambdaReceiver +# AwsLambdaReceiver Defined in: [src/receivers/AwsLambdaReceiver.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L131) diff --git a/docs/english/reference/classes/ContextMissingPropertyError.md b/docs/english/reference/classes/ContextMissingPropertyError.md index 103b9a09d..b7e7a0ca0 100644 --- a/docs/english/reference/classes/ContextMissingPropertyError.md +++ b/docs/english/reference/classes/ContextMissingPropertyError.md @@ -1,4 +1,4 @@ -# Class: ContextMissingPropertyError +# ContextMissingPropertyError Defined in: [src/errors.ts:96](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L96) diff --git a/docs/english/reference/classes/CustomFunctionCompleteFailError.md b/docs/english/reference/classes/CustomFunctionCompleteFailError.md index 862b3e15d..f19820409 100644 --- a/docs/english/reference/classes/CustomFunctionCompleteFailError.md +++ b/docs/english/reference/classes/CustomFunctionCompleteFailError.md @@ -1,4 +1,4 @@ -# Class: CustomFunctionCompleteFailError +# CustomFunctionCompleteFailError Defined in: [src/errors.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L177) diff --git a/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md index c508de1e5..fed90698f 100644 --- a/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md +++ b/docs/english/reference/classes/CustomFunctionCompleteSuccessError.md @@ -1,4 +1,4 @@ -# Class: CustomFunctionCompleteSuccessError +# CustomFunctionCompleteSuccessError Defined in: [src/errors.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L173) diff --git a/docs/english/reference/classes/CustomFunctionInitializationError.md b/docs/english/reference/classes/CustomFunctionInitializationError.md index 55d3eed1c..12532b8a1 100644 --- a/docs/english/reference/classes/CustomFunctionInitializationError.md +++ b/docs/english/reference/classes/CustomFunctionInitializationError.md @@ -1,4 +1,4 @@ -# Class: CustomFunctionInitializationError +# CustomFunctionInitializationError Defined in: [src/errors.ts:169](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L169) diff --git a/docs/english/reference/classes/CustomRouteInitializationError.md b/docs/english/reference/classes/CustomRouteInitializationError.md index 02a9fd4be..f72d6e17a 100644 --- a/docs/english/reference/classes/CustomRouteInitializationError.md +++ b/docs/english/reference/classes/CustomRouteInitializationError.md @@ -1,4 +1,4 @@ -# Class: CustomRouteInitializationError +# CustomRouteInitializationError Defined in: [src/errors.ts:111](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L111) diff --git a/docs/english/reference/classes/ExpressReceiver.md b/docs/english/reference/classes/ExpressReceiver.md index dcd51daf1..ba3bd43bd 100644 --- a/docs/english/reference/classes/ExpressReceiver.md +++ b/docs/english/reference/classes/ExpressReceiver.md @@ -1,4 +1,4 @@ -# Class: ExpressReceiver +# ExpressReceiver Defined in: [src/receivers/ExpressReceiver.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L145) diff --git a/docs/english/reference/classes/HTTPReceiver.md b/docs/english/reference/classes/HTTPReceiver.md index b13901eb8..9403754d9 100644 --- a/docs/english/reference/classes/HTTPReceiver.md +++ b/docs/english/reference/classes/HTTPReceiver.md @@ -1,4 +1,4 @@ -# Class: HTTPReceiver +# HTTPReceiver Defined in: [src/receivers/HTTPReceiver.ts:128](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L128) diff --git a/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md index b3c03f628..8b3f00b33 100644 --- a/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md +++ b/docs/english/reference/classes/HTTPReceiverDeferredRequestError.md @@ -1,4 +1,4 @@ -# Class: HTTPReceiverDeferredRequestError +# HTTPReceiverDeferredRequestError Defined in: [src/errors.ts:131](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L131) diff --git a/docs/english/reference/classes/HTTPResponseAck.md b/docs/english/reference/classes/HTTPResponseAck.md index 00c98d4c5..3c0f8d0d5 100644 --- a/docs/english/reference/classes/HTTPResponseAck.md +++ b/docs/english/reference/classes/HTTPResponseAck.md @@ -1,4 +1,4 @@ -# Class: HTTPResponseAck +# HTTPResponseAck Defined in: [src/receivers/HTTPResponseAck.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPResponseAck.ts#L21) diff --git a/docs/english/reference/classes/InvalidCustomPropertyError.md b/docs/english/reference/classes/InvalidCustomPropertyError.md index b37f52411..1821969bf 100644 --- a/docs/english/reference/classes/InvalidCustomPropertyError.md +++ b/docs/english/reference/classes/InvalidCustomPropertyError.md @@ -1,4 +1,4 @@ -# Class: InvalidCustomPropertyError +# InvalidCustomPropertyError Defined in: [src/errors.ts:107](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L107) diff --git a/docs/english/reference/classes/MemoryStore.md b/docs/english/reference/classes/MemoryStore.md index 4189e826d..4c93b7e9f 100644 --- a/docs/english/reference/classes/MemoryStore.md +++ b/docs/english/reference/classes/MemoryStore.md @@ -1,4 +1,4 @@ -# Class: MemoryStore\ +# MemoryStore\ Defined in: [src/conversation-store.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L21) diff --git a/docs/english/reference/classes/MultipleListenerError.md b/docs/english/reference/classes/MultipleListenerError.md index 4f77c7435..5ff64a75c 100644 --- a/docs/english/reference/classes/MultipleListenerError.md +++ b/docs/english/reference/classes/MultipleListenerError.md @@ -1,4 +1,4 @@ -# Class: MultipleListenerError +# MultipleListenerError Defined in: [src/errors.ts:156](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L156) diff --git a/docs/english/reference/classes/ReceiverAuthenticityError.md b/docs/english/reference/classes/ReceiverAuthenticityError.md index faa3c5712..cd00cf856 100644 --- a/docs/english/reference/classes/ReceiverAuthenticityError.md +++ b/docs/english/reference/classes/ReceiverAuthenticityError.md @@ -1,4 +1,4 @@ -# Class: ReceiverAuthenticityError +# ReceiverAuthenticityError Defined in: [src/errors.ts:123](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L123) diff --git a/docs/english/reference/classes/ReceiverInconsistentStateError.md b/docs/english/reference/classes/ReceiverInconsistentStateError.md index f92dae127..ddf04c48a 100644 --- a/docs/english/reference/classes/ReceiverInconsistentStateError.md +++ b/docs/english/reference/classes/ReceiverInconsistentStateError.md @@ -1,4 +1,4 @@ -# Class: ReceiverInconsistentStateError +# ReceiverInconsistentStateError Defined in: [src/errors.ts:127](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L127) diff --git a/docs/english/reference/classes/ReceiverMultipleAckError.md b/docs/english/reference/classes/ReceiverMultipleAckError.md index c465c271b..dfaaa3425 100644 --- a/docs/english/reference/classes/ReceiverMultipleAckError.md +++ b/docs/english/reference/classes/ReceiverMultipleAckError.md @@ -1,4 +1,4 @@ -# Class: ReceiverMultipleAckError +# ReceiverMultipleAckError Defined in: [src/errors.ts:115](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L115) diff --git a/docs/english/reference/classes/RespondError.md b/docs/english/reference/classes/RespondError.md index 5c6ea48e3..997962de9 100644 --- a/docs/english/reference/classes/RespondError.md +++ b/docs/english/reference/classes/RespondError.md @@ -1,4 +1,4 @@ -# Class: RespondError +# RespondError Defined in: [src/errors.ts:145](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L145) diff --git a/docs/english/reference/classes/SocketModeReceiver.md b/docs/english/reference/classes/SocketModeReceiver.md index 89da2e69b..61b1c9ff9 100644 --- a/docs/english/reference/classes/SocketModeReceiver.md +++ b/docs/english/reference/classes/SocketModeReceiver.md @@ -1,4 +1,4 @@ -# Class: SocketModeReceiver +# SocketModeReceiver Defined in: [src/receivers/SocketModeReceiver.ts:83](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L83) diff --git a/docs/english/reference/classes/UnknownError.md b/docs/english/reference/classes/UnknownError.md index 9dc8655d7..939b076ce 100644 --- a/docs/english/reference/classes/UnknownError.md +++ b/docs/english/reference/classes/UnknownError.md @@ -1,4 +1,4 @@ -# Class: UnknownError +# UnknownError Defined in: [src/errors.ts:52](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L52) diff --git a/docs/english/reference/enumerations/ErrorCode.md b/docs/english/reference/enumerations/ErrorCode.md index be3136eab..6e82fba2f 100644 --- a/docs/english/reference/enumerations/ErrorCode.md +++ b/docs/english/reference/enumerations/ErrorCode.md @@ -1,4 +1,4 @@ -# Enumeration: ErrorCode +# ErrorCode Defined in: [src/errors.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L18) diff --git a/docs/english/reference/functions/asCodedError.md b/docs/english/reference/functions/asCodedError.md index 1f0302f4a..4e712106d 100644 --- a/docs/english/reference/functions/asCodedError.md +++ b/docs/english/reference/functions/asCodedError.md @@ -1,4 +1,4 @@ -# Function: asCodedError() +# asCodedError() ```ts function asCodedError(error): CodedError; diff --git a/docs/english/reference/functions/buildReceiverRoutes.md b/docs/english/reference/functions/buildReceiverRoutes.md index 1a81e510a..fb2915dd3 100644 --- a/docs/english/reference/functions/buildReceiverRoutes.md +++ b/docs/english/reference/functions/buildReceiverRoutes.md @@ -1,4 +1,4 @@ -# Function: buildReceiverRoutes() +# buildReceiverRoutes() ```ts function buildReceiverRoutes(customRoutes): ReceiverRoutes; diff --git a/docs/english/reference/functions/defaultProcessEventErrorHandler.md b/docs/english/reference/functions/defaultProcessEventErrorHandler.md index bda79e81d..21a2592ad 100644 --- a/docs/english/reference/functions/defaultProcessEventErrorHandler.md +++ b/docs/english/reference/functions/defaultProcessEventErrorHandler.md @@ -1,4 +1,4 @@ -# Function: defaultProcessEventErrorHandler() +# defaultProcessEventErrorHandler() ```ts function defaultProcessEventErrorHandler(args): Promise; diff --git a/docs/english/reference/functions/isCodedError.md b/docs/english/reference/functions/isCodedError.md index 208654657..77d4426cf 100644 --- a/docs/english/reference/functions/isCodedError.md +++ b/docs/english/reference/functions/isCodedError.md @@ -1,4 +1,4 @@ -# Function: isCodedError() +# isCodedError() ```ts function isCodedError(err): err is CodedError; diff --git a/docs/english/reference/functions/isFulfilled.md b/docs/english/reference/functions/isFulfilled.md index 664ca89db..2d2a4e3ff 100644 --- a/docs/english/reference/functions/isFulfilled.md +++ b/docs/english/reference/functions/isFulfilled.md @@ -1,4 +1,4 @@ -# Function: isFulfilled() +# isFulfilled() ```ts function isFulfilled(p): p is PromiseFulfilledResult; diff --git a/docs/english/reference/functions/isRejected.md b/docs/english/reference/functions/isRejected.md index 57584ec10..6a737a887 100644 --- a/docs/english/reference/functions/isRejected.md +++ b/docs/english/reference/functions/isRejected.md @@ -1,4 +1,4 @@ -# Function: isRejected() +# isRejected() ```ts function isRejected(p): p is PromiseRejectedResult; diff --git a/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md index dd16e5fd1..00519346c 100644 --- a/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md +++ b/docs/english/reference/functions/isSlackEventMiddlewareArgsOptions.md @@ -1,4 +1,4 @@ -# Function: isSlackEventMiddlewareArgsOptions() +# isSlackEventMiddlewareArgsOptions() ```ts function isSlackEventMiddlewareArgsOptions(optionOrListener): optionOrListener is SlackEventMiddlewareArgsOptions; diff --git a/docs/english/reference/functions/isValidSlackRequest.md b/docs/english/reference/functions/isValidSlackRequest.md index 6ea3d13a5..d79de69a0 100644 --- a/docs/english/reference/functions/isValidSlackRequest.md +++ b/docs/english/reference/functions/isValidSlackRequest.md @@ -1,4 +1,4 @@ -# Function: isValidSlackRequest() +# isValidSlackRequest() ```ts function isValidSlackRequest(options): boolean; diff --git a/docs/english/reference/functions/matchCommandName.md b/docs/english/reference/functions/matchCommandName.md index 5c6fe7b44..68d615740 100644 --- a/docs/english/reference/functions/matchCommandName.md +++ b/docs/english/reference/functions/matchCommandName.md @@ -1,4 +1,4 @@ -# Function: matchCommandName() +# matchCommandName() ```ts function matchCommandName(pattern): Middleware; diff --git a/docs/english/reference/functions/matchConstraints.md b/docs/english/reference/functions/matchConstraints.md index 99ba205b0..71a076720 100644 --- a/docs/english/reference/functions/matchConstraints.md +++ b/docs/english/reference/functions/matchConstraints.md @@ -1,4 +1,4 @@ -# Function: matchConstraints() +# matchConstraints() ```ts function matchConstraints(constraints): Middleware< diff --git a/docs/english/reference/functions/matchEventType.md b/docs/english/reference/functions/matchEventType.md index 5ac692711..d0e9eec85 100644 --- a/docs/english/reference/functions/matchEventType.md +++ b/docs/english/reference/functions/matchEventType.md @@ -1,4 +1,4 @@ -# Function: matchEventType() +# matchEventType() ```ts function matchEventType(pattern): Middleware; diff --git a/docs/english/reference/functions/matchMessage.md b/docs/english/reference/functions/matchMessage.md index 4e35189ac..9664f58a0 100644 --- a/docs/english/reference/functions/matchMessage.md +++ b/docs/english/reference/functions/matchMessage.md @@ -1,4 +1,4 @@ -# Function: matchMessage() +# matchMessage() ```ts function matchMessage(pattern): Middleware>; diff --git a/docs/english/reference/functions/subtype.md b/docs/english/reference/functions/subtype.md index 8187087cf..b34cba4d4 100644 --- a/docs/english/reference/functions/subtype.md +++ b/docs/english/reference/functions/subtype.md @@ -1,4 +1,4 @@ -# Function: subtype() +# subtype() ```ts function subtype(subtype1): Middleware>; diff --git a/docs/english/reference/functions/verifySlackRequest.md b/docs/english/reference/functions/verifySlackRequest.md index 60d844d32..9f5cea224 100644 --- a/docs/english/reference/functions/verifySlackRequest.md +++ b/docs/english/reference/functions/verifySlackRequest.md @@ -1,4 +1,4 @@ -# Function: verifySlackRequest() +# verifySlackRequest() ```ts function verifySlackRequest(options): void; diff --git a/docs/english/reference/index.md b/docs/english/reference/index.md index c49a17756..05a9996c4 100644 --- a/docs/english/reference/index.md +++ b/docs/english/reference/index.md @@ -3,7 +3,7 @@ sidebar_label: "@slack/bolt" sidebar_position: 0 --- -# @slack/bolt v5.0.0 +# @slack/bolt ## Namespaces diff --git a/docs/english/reference/interfaces/ActionConstraints.md b/docs/english/reference/interfaces/ActionConstraints.md index 1c850f1f4..d72c4549b 100644 --- a/docs/english/reference/interfaces/ActionConstraints.md +++ b/docs/english/reference/interfaces/ActionConstraints.md @@ -1,4 +1,4 @@ -# Interface: ActionConstraints\ +# ActionConstraints\ Defined in: [src/types/actions/index.ts:28](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/index.ts#L28) diff --git a/docs/english/reference/interfaces/AllMiddlewareArgs.md b/docs/english/reference/interfaces/AllMiddlewareArgs.md index c44bb96f7..5bebcb371 100644 --- a/docs/english/reference/interfaces/AllMiddlewareArgs.md +++ b/docs/english/reference/interfaces/AllMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Interface: AllMiddlewareArgs\ +# AllMiddlewareArgs\ Defined in: [src/types/middleware.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L20) diff --git a/docs/english/reference/interfaces/AppOptions.md b/docs/english/reference/interfaces/AppOptions.md index 52becbe1d..33eb755f0 100644 --- a/docs/english/reference/interfaces/AppOptions.md +++ b/docs/english/reference/interfaces/AppOptions.md @@ -1,4 +1,4 @@ -# Interface: AppOptions +# AppOptions Defined in: [src/App.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L122) diff --git a/docs/english/reference/interfaces/AssistantConfig.md b/docs/english/reference/interfaces/AssistantConfig.md index 640e78988..1946e426c 100644 --- a/docs/english/reference/interfaces/AssistantConfig.md +++ b/docs/english/reference/interfaces/AssistantConfig.md @@ -1,4 +1,4 @@ -# Interface: AssistantConfig +# AssistantConfig Defined in: [src/Assistant.ts:21](https://github.com/slackapi/bolt-js/blob/main/src/Assistant.ts#L21) diff --git a/docs/english/reference/interfaces/AuthorizeResult.md b/docs/english/reference/interfaces/AuthorizeResult.md index 37618bfe1..5b41d3b9d 100644 --- a/docs/english/reference/interfaces/AuthorizeResult.md +++ b/docs/english/reference/interfaces/AuthorizeResult.md @@ -1,4 +1,4 @@ -# Interface: AuthorizeResult +# AuthorizeResult Defined in: [src/App.ts:178](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L178) diff --git a/docs/english/reference/interfaces/AuthorizeSourceData.md b/docs/english/reference/interfaces/AuthorizeSourceData.md index 31a99aac3..339838f45 100644 --- a/docs/english/reference/interfaces/AuthorizeSourceData.md +++ b/docs/english/reference/interfaces/AuthorizeSourceData.md @@ -1,4 +1,4 @@ -# Interface: AuthorizeSourceData\ +# AuthorizeSourceData\ Defined in: [src/App.ts:169](https://github.com/slackapi/bolt-js/blob/main/src/App.ts#L169) diff --git a/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md index 846e0bc3a..dfa35447f 100644 --- a/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md +++ b/docs/english/reference/interfaces/AwsLambdaReceiverOptions.md @@ -1,4 +1,4 @@ -# Interface: AwsLambdaReceiverOptions +# AwsLambdaReceiverOptions Defined in: [src/receivers/AwsLambdaReceiver.ts:84](https://github.com/slackapi/bolt-js/blob/main/src/receivers/AwsLambdaReceiver.ts#L84) diff --git a/docs/english/reference/interfaces/BaseSlackEvent.md b/docs/english/reference/interfaces/BaseSlackEvent.md index 64112c478..8c30f12c5 100644 --- a/docs/english/reference/interfaces/BaseSlackEvent.md +++ b/docs/english/reference/interfaces/BaseSlackEvent.md @@ -1,4 +1,4 @@ -# Interface: BaseSlackEvent\ +# BaseSlackEvent\ Defined in: [src/types/events/index.ts:68](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L68) diff --git a/docs/english/reference/interfaces/BasicElementAction.md b/docs/english/reference/interfaces/BasicElementAction.md index 48c708a0f..0678c84c4 100644 --- a/docs/english/reference/interfaces/BasicElementAction.md +++ b/docs/english/reference/interfaces/BasicElementAction.md @@ -1,4 +1,4 @@ -# Interface: BasicElementAction\ +# BasicElementAction\ Defined in: [src/types/actions/block-action.ts:39](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L39) diff --git a/docs/english/reference/interfaces/BasicOptionsPayload.md b/docs/english/reference/interfaces/BasicOptionsPayload.md index cb8907d3f..5fdf1f5fd 100644 --- a/docs/english/reference/interfaces/BasicOptionsPayload.md +++ b/docs/english/reference/interfaces/BasicOptionsPayload.md @@ -1,4 +1,4 @@ -# Interface: BasicOptionsPayload\ +# BasicOptionsPayload\ Defined in: [src/types/options/index.ts:33](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L33) diff --git a/docs/english/reference/interfaces/BlockAction.md b/docs/english/reference/interfaces/BlockAction.md index 345e624a7..57000e454 100644 --- a/docs/english/reference/interfaces/BlockAction.md +++ b/docs/english/reference/interfaces/BlockAction.md @@ -1,4 +1,4 @@ -# Interface: BlockAction\ +# BlockAction\ Defined in: [src/types/actions/block-action.ts:249](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L249) diff --git a/docs/english/reference/interfaces/BlockOptions.md b/docs/english/reference/interfaces/BlockOptions.md index c335dd833..3f4ee06cd 100644 --- a/docs/english/reference/interfaces/BlockOptions.md +++ b/docs/english/reference/interfaces/BlockOptions.md @@ -1,4 +1,4 @@ -# Interface: BlockOptions +# BlockOptions Defined in: [src/types/options/index.ts:160](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L160) diff --git a/docs/english/reference/interfaces/BlockSuggestion.md b/docs/english/reference/interfaces/BlockSuggestion.md index 879f4614f..2ac2497a8 100644 --- a/docs/english/reference/interfaces/BlockSuggestion.md +++ b/docs/english/reference/interfaces/BlockSuggestion.md @@ -1,4 +1,4 @@ -# Interface: BlockSuggestion +# BlockSuggestion Defined in: [src/types/options/index.ts:45](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L45) diff --git a/docs/english/reference/interfaces/BufferedIncomingMessage.md b/docs/english/reference/interfaces/BufferedIncomingMessage.md index 8113245c1..1a6f571a5 100644 --- a/docs/english/reference/interfaces/BufferedIncomingMessage.md +++ b/docs/english/reference/interfaces/BufferedIncomingMessage.md @@ -1,4 +1,4 @@ -# Interface: BufferedIncomingMessage +# BufferedIncomingMessage Defined in: [src/receivers/BufferedIncomingMessage.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/receivers/BufferedIncomingMessage.ts#L5) diff --git a/docs/english/reference/interfaces/ButtonAction.md b/docs/english/reference/interfaces/ButtonAction.md index e42ab0beb..64cfb4a5e 100644 --- a/docs/english/reference/interfaces/ButtonAction.md +++ b/docs/english/reference/interfaces/ButtonAction.md @@ -1,4 +1,4 @@ -# Interface: ButtonAction +# ButtonAction Defined in: [src/types/actions/block-action.ts:49](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L49) diff --git a/docs/english/reference/interfaces/ButtonClick.md b/docs/english/reference/interfaces/ButtonClick.md index e2b577965..77daf4aea 100644 --- a/docs/english/reference/interfaces/ButtonClick.md +++ b/docs/english/reference/interfaces/ButtonClick.md @@ -1,4 +1,4 @@ -# Interface: ButtonClick +# ButtonClick Defined in: [src/types/actions/interactive-message.ts:10](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L10) diff --git a/docs/english/reference/interfaces/ChannelsSelectAction.md b/docs/english/reference/interfaces/ChannelsSelectAction.md index 9ba8eddf6..24c2c122b 100644 --- a/docs/english/reference/interfaces/ChannelsSelectAction.md +++ b/docs/english/reference/interfaces/ChannelsSelectAction.md @@ -1,4 +1,4 @@ -# Interface: ChannelsSelectAction +# ChannelsSelectAction Defined in: [src/types/actions/block-action.ts:142](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L142) diff --git a/docs/english/reference/interfaces/CheckboxesAction.md b/docs/english/reference/interfaces/CheckboxesAction.md index e38c9a503..0af7186d3 100644 --- a/docs/english/reference/interfaces/CheckboxesAction.md +++ b/docs/english/reference/interfaces/CheckboxesAction.md @@ -1,4 +1,4 @@ -# Interface: CheckboxesAction +# CheckboxesAction Defined in: [src/types/actions/block-action.ts:224](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L224) diff --git a/docs/english/reference/interfaces/CodedError.md b/docs/english/reference/interfaces/CodedError.md index 2dca48717..409c657e7 100644 --- a/docs/english/reference/interfaces/CodedError.md +++ b/docs/english/reference/interfaces/CodedError.md @@ -1,4 +1,4 @@ -# Interface: CodedError +# CodedError Defined in: [src/errors.ts:4](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts#L4) diff --git a/docs/english/reference/interfaces/Context.md b/docs/english/reference/interfaces/Context.md index 7a74744bc..577052917 100644 --- a/docs/english/reference/interfaces/Context.md +++ b/docs/english/reference/interfaces/Context.md @@ -1,4 +1,4 @@ -# Interface: Context +# Context Defined in: [src/types/middleware.ts:37](https://github.com/slackapi/bolt-js/blob/main/src/types/middleware.ts#L37) diff --git a/docs/english/reference/interfaces/ConversationStore.md b/docs/english/reference/interfaces/ConversationStore.md index 86713241a..125dc91b3 100644 --- a/docs/english/reference/interfaces/ConversationStore.md +++ b/docs/english/reference/interfaces/ConversationStore.md @@ -1,4 +1,4 @@ -# Interface: ConversationStore\ +# ConversationStore\ Defined in: [src/conversation-store.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/conversation-store.ts#L8) diff --git a/docs/english/reference/interfaces/ConversationsSelectAction.md b/docs/english/reference/interfaces/ConversationsSelectAction.md index 6f4f2c2c2..5c26c3ffe 100644 --- a/docs/english/reference/interfaces/ConversationsSelectAction.md +++ b/docs/english/reference/interfaces/ConversationsSelectAction.md @@ -1,4 +1,4 @@ -# Interface: ConversationsSelectAction +# ConversationsSelectAction Defined in: [src/types/actions/block-action.ts:122](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L122) diff --git a/docs/english/reference/interfaces/CustomRoute.md b/docs/english/reference/interfaces/CustomRoute.md index 0787d53d1..9198b99b3 100644 --- a/docs/english/reference/interfaces/CustomRoute.md +++ b/docs/english/reference/interfaces/CustomRoute.md @@ -1,4 +1,4 @@ -# Interface: CustomRoute +# CustomRoute Defined in: [src/receivers/custom-routes.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L5) diff --git a/docs/english/reference/interfaces/DatepickerAction.md b/docs/english/reference/interfaces/DatepickerAction.md index 2810b0ab8..5b5e5b833 100644 --- a/docs/english/reference/interfaces/DatepickerAction.md +++ b/docs/english/reference/interfaces/DatepickerAction.md @@ -1,4 +1,4 @@ -# Interface: DatepickerAction +# DatepickerAction Defined in: [src/types/actions/block-action.ts:195](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L195) diff --git a/docs/english/reference/interfaces/DialogOptionGroups.md b/docs/english/reference/interfaces/DialogOptionGroups.md index f6c8f9b3a..b61613760 100644 --- a/docs/english/reference/interfaces/DialogOptionGroups.md +++ b/docs/english/reference/interfaces/DialogOptionGroups.md @@ -1,4 +1,4 @@ -# Interface: DialogOptionGroups\ +# DialogOptionGroups\ Defined in: [src/types/options/index.ts:177](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L177) diff --git a/docs/english/reference/interfaces/DialogOptions.md b/docs/english/reference/interfaces/DialogOptions.md index 4ae7eef00..8bf8692df 100644 --- a/docs/english/reference/interfaces/DialogOptions.md +++ b/docs/english/reference/interfaces/DialogOptions.md @@ -1,4 +1,4 @@ -# Interface: DialogOptions +# DialogOptions Defined in: [src/types/options/index.ts:166](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L166) diff --git a/docs/english/reference/interfaces/DialogSubmitAction.md b/docs/english/reference/interfaces/DialogSubmitAction.md index 4e3f03fbf..b6286bbb0 100644 --- a/docs/english/reference/interfaces/DialogSubmitAction.md +++ b/docs/english/reference/interfaces/DialogSubmitAction.md @@ -1,4 +1,4 @@ -# Interface: DialogSubmitAction +# DialogSubmitAction Defined in: [src/types/actions/dialog-action.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L6) diff --git a/docs/english/reference/interfaces/DialogSuggestion.md b/docs/english/reference/interfaces/DialogSuggestion.md index 4c059ff0f..fb8eefccb 100644 --- a/docs/english/reference/interfaces/DialogSuggestion.md +++ b/docs/english/reference/interfaces/DialogSuggestion.md @@ -1,4 +1,4 @@ -# Interface: DialogSuggestion +# DialogSuggestion Defined in: [src/types/options/index.ts:118](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L118) diff --git a/docs/english/reference/interfaces/DialogValidation.md b/docs/english/reference/interfaces/DialogValidation.md index a1a244329..3a7501526 100644 --- a/docs/english/reference/interfaces/DialogValidation.md +++ b/docs/english/reference/interfaces/DialogValidation.md @@ -1,4 +1,4 @@ -# Interface: DialogValidation +# DialogValidation Defined in: [src/types/actions/dialog-action.ts:42](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/dialog-action.ts#L42) diff --git a/docs/english/reference/interfaces/EnvelopedEvent.md b/docs/english/reference/interfaces/EnvelopedEvent.md index 276869bd2..449f10162 100644 --- a/docs/english/reference/interfaces/EnvelopedEvent.md +++ b/docs/english/reference/interfaces/EnvelopedEvent.md @@ -1,4 +1,4 @@ -# Interface: EnvelopedEvent\ +# EnvelopedEvent\ Defined in: [src/types/events/index.ts:79](https://github.com/slackapi/bolt-js/blob/main/src/types/events/index.ts#L79) diff --git a/docs/english/reference/interfaces/ExpressReceiverOptions.md b/docs/english/reference/interfaces/ExpressReceiverOptions.md index 64bfc8679..30a41cc0a 100644 --- a/docs/english/reference/interfaces/ExpressReceiverOptions.md +++ b/docs/english/reference/interfaces/ExpressReceiverOptions.md @@ -1,4 +1,4 @@ -# Interface: ExpressReceiverOptions +# ExpressReceiverOptions Defined in: [src/receivers/ExpressReceiver.ts:92](https://github.com/slackapi/bolt-js/blob/main/src/receivers/ExpressReceiver.ts#L92) diff --git a/docs/english/reference/interfaces/ExternalSelectAction.md b/docs/english/reference/interfaces/ExternalSelectAction.md index 2747efede..d61a8cd6a 100644 --- a/docs/english/reference/interfaces/ExternalSelectAction.md +++ b/docs/english/reference/interfaces/ExternalSelectAction.md @@ -1,4 +1,4 @@ -# Interface: ExternalSelectAction +# ExternalSelectAction Defined in: [src/types/actions/block-action.ts:162](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L162) diff --git a/docs/english/reference/interfaces/FeedbackButtonsAction.md b/docs/english/reference/interfaces/FeedbackButtonsAction.md index 06edd39fd..7f04f848b 100644 --- a/docs/english/reference/interfaces/FeedbackButtonsAction.md +++ b/docs/english/reference/interfaces/FeedbackButtonsAction.md @@ -1,4 +1,4 @@ -# Interface: FeedbackButtonsAction +# FeedbackButtonsAction Defined in: [src/types/actions/block-action.ts:59](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L59) diff --git a/docs/english/reference/interfaces/GlobalShortcut.md b/docs/english/reference/interfaces/GlobalShortcut.md index 013f12e7f..8b6414bbb 100644 --- a/docs/english/reference/interfaces/GlobalShortcut.md +++ b/docs/english/reference/interfaces/GlobalShortcut.md @@ -1,4 +1,4 @@ -# Interface: GlobalShortcut +# GlobalShortcut Defined in: [src/types/shortcuts/global-shortcut.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/global-shortcut.ts#L7) diff --git a/docs/english/reference/interfaces/HTTPReceiverOptions.md b/docs/english/reference/interfaces/HTTPReceiverOptions.md index ff02ed65e..70f1e4840 100644 --- a/docs/english/reference/interfaces/HTTPReceiverOptions.md +++ b/docs/english/reference/interfaces/HTTPReceiverOptions.md @@ -1,4 +1,4 @@ -# Interface: HTTPReceiverOptions +# HTTPReceiverOptions Defined in: [src/receivers/HTTPReceiver.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/receivers/HTTPReceiver.ts#L76) diff --git a/docs/english/reference/interfaces/IconButtonAction.md b/docs/english/reference/interfaces/IconButtonAction.md index c1068ec0b..381fa4c39 100644 --- a/docs/english/reference/interfaces/IconButtonAction.md +++ b/docs/english/reference/interfaces/IconButtonAction.md @@ -1,4 +1,4 @@ -# Interface: IconButtonAction +# IconButtonAction Defined in: [src/types/actions/block-action.ts:67](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L67) diff --git a/docs/english/reference/interfaces/InteractiveMessage.md b/docs/english/reference/interfaces/InteractiveMessage.md index 77dd7a0e2..fce6beebe 100644 --- a/docs/english/reference/interfaces/InteractiveMessage.md +++ b/docs/english/reference/interfaces/InteractiveMessage.md @@ -1,4 +1,4 @@ -# Interface: InteractiveMessage\ +# InteractiveMessage\ Defined in: [src/types/actions/interactive-message.ts:32](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L32) diff --git a/docs/english/reference/interfaces/InteractiveMessageSuggestion.md b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md index 3a27e3974..89873a51b 100644 --- a/docs/english/reference/interfaces/InteractiveMessageSuggestion.md +++ b/docs/english/reference/interfaces/InteractiveMessageSuggestion.md @@ -1,4 +1,4 @@ -# Interface: InteractiveMessageSuggestion +# InteractiveMessageSuggestion Defined in: [src/types/options/index.ts:82](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L82) diff --git a/docs/english/reference/interfaces/MenuSelect.md b/docs/english/reference/interfaces/MenuSelect.md index 182d1bb04..01ae95872 100644 --- a/docs/english/reference/interfaces/MenuSelect.md +++ b/docs/english/reference/interfaces/MenuSelect.md @@ -1,4 +1,4 @@ -# Interface: MenuSelect +# MenuSelect Defined in: [src/types/actions/interactive-message.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/interactive-message.ts#L19) diff --git a/docs/english/reference/interfaces/MessageOptions.md b/docs/english/reference/interfaces/MessageOptions.md index 8f4c2ac1d..84c9c0f88 100644 --- a/docs/english/reference/interfaces/MessageOptions.md +++ b/docs/english/reference/interfaces/MessageOptions.md @@ -1,4 +1,4 @@ -# Interface: MessageOptions +# MessageOptions Defined in: [src/types/options/index.ts:163](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L163) diff --git a/docs/english/reference/interfaces/MessageShortcut.md b/docs/english/reference/interfaces/MessageShortcut.md index 390cdd130..166fc501a 100644 --- a/docs/english/reference/interfaces/MessageShortcut.md +++ b/docs/english/reference/interfaces/MessageShortcut.md @@ -1,4 +1,4 @@ -# Interface: MessageShortcut +# MessageShortcut Defined in: [src/types/shortcuts/message-shortcut.ts:7](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/message-shortcut.ts#L7) diff --git a/docs/english/reference/interfaces/MultiChannelsSelectAction.md b/docs/english/reference/interfaces/MultiChannelsSelectAction.md index 1ee7be3b6..b383abc21 100644 --- a/docs/english/reference/interfaces/MultiChannelsSelectAction.md +++ b/docs/english/reference/interfaces/MultiChannelsSelectAction.md @@ -1,4 +1,4 @@ -# Interface: MultiChannelsSelectAction +# MultiChannelsSelectAction Defined in: [src/types/actions/block-action.ts:152](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L152) diff --git a/docs/english/reference/interfaces/MultiConversationsSelectAction.md b/docs/english/reference/interfaces/MultiConversationsSelectAction.md index 3f56b7b43..8ab365158 100644 --- a/docs/english/reference/interfaces/MultiConversationsSelectAction.md +++ b/docs/english/reference/interfaces/MultiConversationsSelectAction.md @@ -1,4 +1,4 @@ -# Interface: MultiConversationsSelectAction +# MultiConversationsSelectAction Defined in: [src/types/actions/block-action.ts:132](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L132) diff --git a/docs/english/reference/interfaces/MultiExternalSelectAction.md b/docs/english/reference/interfaces/MultiExternalSelectAction.md index 1d106f674..071cd5b26 100644 --- a/docs/english/reference/interfaces/MultiExternalSelectAction.md +++ b/docs/english/reference/interfaces/MultiExternalSelectAction.md @@ -1,4 +1,4 @@ -# Interface: MultiExternalSelectAction +# MultiExternalSelectAction Defined in: [src/types/actions/block-action.ts:173](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L173) diff --git a/docs/english/reference/interfaces/MultiStaticSelectAction.md b/docs/english/reference/interfaces/MultiStaticSelectAction.md index cd3192914..dd34c5475 100644 --- a/docs/english/reference/interfaces/MultiStaticSelectAction.md +++ b/docs/english/reference/interfaces/MultiStaticSelectAction.md @@ -1,4 +1,4 @@ -# Interface: MultiStaticSelectAction +# MultiStaticSelectAction Defined in: [src/types/actions/block-action.ts:89](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L89) diff --git a/docs/english/reference/interfaces/MultiUsersSelectAction.md b/docs/english/reference/interfaces/MultiUsersSelectAction.md index 7dc007e2f..e18adbb3b 100644 --- a/docs/english/reference/interfaces/MultiUsersSelectAction.md +++ b/docs/english/reference/interfaces/MultiUsersSelectAction.md @@ -1,4 +1,4 @@ -# Interface: MultiUsersSelectAction +# MultiUsersSelectAction Defined in: [src/types/actions/block-action.ts:112](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L112) diff --git a/docs/english/reference/interfaces/OptionGroups.md b/docs/english/reference/interfaces/OptionGroups.md index 9479a26fd..cdab202b4 100644 --- a/docs/english/reference/interfaces/OptionGroups.md +++ b/docs/english/reference/interfaces/OptionGroups.md @@ -1,4 +1,4 @@ -# Interface: OptionGroups\ +# OptionGroups\ Defined in: [src/types/options/index.ts:172](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L172) diff --git a/docs/english/reference/interfaces/OptionsConstraints.md b/docs/english/reference/interfaces/OptionsConstraints.md index 90dc04266..344d41e6d 100644 --- a/docs/english/reference/interfaces/OptionsConstraints.md +++ b/docs/english/reference/interfaces/OptionsConstraints.md @@ -1,4 +1,4 @@ -# Interface: OptionsConstraints\ +# OptionsConstraints\ Defined in: [src/types/options/index.ts:18](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L18) diff --git a/docs/english/reference/interfaces/OverflowAction.md b/docs/english/reference/interfaces/OverflowAction.md index cca08ace2..4c3a7179a 100644 --- a/docs/english/reference/interfaces/OverflowAction.md +++ b/docs/english/reference/interfaces/OverflowAction.md @@ -1,4 +1,4 @@ -# Interface: OverflowAction +# OverflowAction Defined in: [src/types/actions/block-action.ts:184](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L184) diff --git a/docs/english/reference/interfaces/PlainTextInputAction.md b/docs/english/reference/interfaces/PlainTextInputAction.md index eec16e8c3..913577678 100644 --- a/docs/english/reference/interfaces/PlainTextInputAction.md +++ b/docs/english/reference/interfaces/PlainTextInputAction.md @@ -1,4 +1,4 @@ -# Interface: PlainTextInputAction +# PlainTextInputAction Defined in: [src/types/actions/block-action.ts:233](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L233) diff --git a/docs/english/reference/interfaces/RadioButtonsAction.md b/docs/english/reference/interfaces/RadioButtonsAction.md index 8f51a4a56..89944dd6c 100644 --- a/docs/english/reference/interfaces/RadioButtonsAction.md +++ b/docs/english/reference/interfaces/RadioButtonsAction.md @@ -1,4 +1,4 @@ -# Interface: RadioButtonsAction +# RadioButtonsAction Defined in: [src/types/actions/block-action.ts:215](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L215) diff --git a/docs/english/reference/interfaces/Receiver.md b/docs/english/reference/interfaces/Receiver.md index 417efc055..4198a77b7 100644 --- a/docs/english/reference/interfaces/Receiver.md +++ b/docs/english/reference/interfaces/Receiver.md @@ -1,4 +1,4 @@ -# Interface: Receiver +# Receiver Defined in: [src/types/receiver.ts:26](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L26) diff --git a/docs/english/reference/interfaces/ReceiverEvent.md b/docs/english/reference/interfaces/ReceiverEvent.md index 2d6609c07..10fe08b40 100644 --- a/docs/english/reference/interfaces/ReceiverEvent.md +++ b/docs/english/reference/interfaces/ReceiverEvent.md @@ -1,4 +1,4 @@ -# Interface: ReceiverEvent +# ReceiverEvent Defined in: [src/types/receiver.ts:5](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L5) diff --git a/docs/english/reference/interfaces/ReceiverRoutes.md b/docs/english/reference/interfaces/ReceiverRoutes.md index 90515c0ba..a40fae143 100644 --- a/docs/english/reference/interfaces/ReceiverRoutes.md +++ b/docs/english/reference/interfaces/ReceiverRoutes.md @@ -1,4 +1,4 @@ -# Interface: ReceiverRoutes +# ReceiverRoutes Defined in: [src/receivers/custom-routes.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/receivers/custom-routes.ts#L11) diff --git a/docs/english/reference/interfaces/ResponseAck.md b/docs/english/reference/interfaces/ResponseAck.md index d5f13fd0f..d8df8dcc1 100644 --- a/docs/english/reference/interfaces/ResponseAck.md +++ b/docs/english/reference/interfaces/ResponseAck.md @@ -1,4 +1,4 @@ -# Interface: ResponseAck +# ResponseAck Defined in: [src/types/receiver.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/receiver.ts#L34) diff --git a/docs/english/reference/interfaces/RichTextInputAction.md b/docs/english/reference/interfaces/RichTextInputAction.md index f5ab882db..b7d19d76d 100644 --- a/docs/english/reference/interfaces/RichTextInputAction.md +++ b/docs/english/reference/interfaces/RichTextInputAction.md @@ -1,4 +1,4 @@ -# Interface: RichTextInputAction +# RichTextInputAction Defined in: [src/types/actions/block-action.ts:240](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L240) diff --git a/docs/english/reference/interfaces/ShortcutConstraints.md b/docs/english/reference/interfaces/ShortcutConstraints.md index 822259ab4..0422b0ef3 100644 --- a/docs/english/reference/interfaces/ShortcutConstraints.md +++ b/docs/english/reference/interfaces/ShortcutConstraints.md @@ -1,4 +1,4 @@ -# Interface: ShortcutConstraints\ +# ShortcutConstraints\ Defined in: [src/types/shortcuts/index.ts:14](https://github.com/slackapi/bolt-js/blob/main/src/types/shortcuts/index.ts#L14) diff --git a/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md index abd90534a..60d3de462 100644 --- a/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackCommandMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Interface: SlackCommandMiddlewareArgs +# SlackCommandMiddlewareArgs Defined in: [src/types/command/index.ts:6](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L6) diff --git a/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md index 73623d99f..1ed6432d4 100644 --- a/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackOptionsMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Interface: SlackOptionsMiddlewareArgs\ +# SlackOptionsMiddlewareArgs\ Defined in: [src/types/options/index.ts:8](https://github.com/slackapi/bolt-js/blob/main/src/types/options/index.ts#L8) diff --git a/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md index 09a02b5f2..1178cf70e 100644 --- a/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md +++ b/docs/english/reference/interfaces/SlackViewMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Interface: SlackViewMiddlewareArgs\ +# SlackViewMiddlewareArgs\ Defined in: [src/types/view/index.ts:19](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L19) diff --git a/docs/english/reference/interfaces/SlashCommand.md b/docs/english/reference/interfaces/SlashCommand.md index 709c8c12d..787a39985 100644 --- a/docs/english/reference/interfaces/SlashCommand.md +++ b/docs/english/reference/interfaces/SlashCommand.md @@ -1,4 +1,4 @@ -# Interface: SlashCommand +# SlashCommand Defined in: [src/types/command/index.ts:20](https://github.com/slackapi/bolt-js/blob/main/src/types/command/index.ts#L20) diff --git a/docs/english/reference/interfaces/SocketModeReceiverOptions.md b/docs/english/reference/interfaces/SocketModeReceiverOptions.md index 7a3e9402b..d6d0f219c 100644 --- a/docs/english/reference/interfaces/SocketModeReceiverOptions.md +++ b/docs/english/reference/interfaces/SocketModeReceiverOptions.md @@ -1,4 +1,4 @@ -# Interface: SocketModeReceiverOptions +# SocketModeReceiverOptions Defined in: [src/receivers/SocketModeReceiver.ts:31](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeReceiver.ts#L31) diff --git a/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md index 9033057a7..0d6b49a44 100644 --- a/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md +++ b/docs/english/reference/interfaces/SocketModeReceiverProcessEventErrorHandlerArgs.md @@ -1,4 +1,4 @@ -# Interface: SocketModeReceiverProcessEventErrorHandlerArgs +# SocketModeReceiverProcessEventErrorHandlerArgs Defined in: [src/receivers/SocketModeFunctions.ts:24](https://github.com/slackapi/bolt-js/blob/main/src/receivers/SocketModeFunctions.ts#L24) diff --git a/docs/english/reference/interfaces/StaticSelectAction.md b/docs/english/reference/interfaces/StaticSelectAction.md index 9b82de6c6..c57063bc8 100644 --- a/docs/english/reference/interfaces/StaticSelectAction.md +++ b/docs/english/reference/interfaces/StaticSelectAction.md @@ -1,4 +1,4 @@ -# Interface: StaticSelectAction +# StaticSelectAction Defined in: [src/types/actions/block-action.ts:76](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L76) diff --git a/docs/english/reference/interfaces/TimepickerAction.md b/docs/english/reference/interfaces/TimepickerAction.md index 5b65427e3..f816e3b0a 100644 --- a/docs/english/reference/interfaces/TimepickerAction.md +++ b/docs/english/reference/interfaces/TimepickerAction.md @@ -1,4 +1,4 @@ -# Interface: TimepickerAction +# TimepickerAction Defined in: [src/types/actions/block-action.ts:205](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L205) diff --git a/docs/english/reference/interfaces/UploadedFile.md b/docs/english/reference/interfaces/UploadedFile.md index 6e65c6939..ded25586e 100644 --- a/docs/english/reference/interfaces/UploadedFile.md +++ b/docs/english/reference/interfaces/UploadedFile.md @@ -1,4 +1,4 @@ -# Interface: UploadedFile +# UploadedFile Defined in: [src/types/view/index.ts:109](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L109) diff --git a/docs/english/reference/interfaces/UsersSelectAction.md b/docs/english/reference/interfaces/UsersSelectAction.md index ebfeadf84..1049b421f 100644 --- a/docs/english/reference/interfaces/UsersSelectAction.md +++ b/docs/english/reference/interfaces/UsersSelectAction.md @@ -1,4 +1,4 @@ -# Interface: UsersSelectAction +# UsersSelectAction Defined in: [src/types/actions/block-action.ts:102](https://github.com/slackapi/bolt-js/blob/main/src/types/actions/block-action.ts#L102) diff --git a/docs/english/reference/interfaces/ViewClearResponseAction.md b/docs/english/reference/interfaces/ViewClearResponseAction.md index 01624d5aa..3c4e821ff 100644 --- a/docs/english/reference/interfaces/ViewClearResponseAction.md +++ b/docs/english/reference/interfaces/ViewClearResponseAction.md @@ -1,4 +1,4 @@ -# Interface: ViewClearResponseAction +# ViewClearResponseAction Defined in: [src/types/view/index.ts:298](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L298) diff --git a/docs/english/reference/interfaces/ViewClosedAction.md b/docs/english/reference/interfaces/ViewClosedAction.md index d8128435f..6aff939b0 100644 --- a/docs/english/reference/interfaces/ViewClosedAction.md +++ b/docs/english/reference/interfaces/ViewClosedAction.md @@ -1,4 +1,4 @@ -# Interface: ViewClosedAction +# ViewClosedAction Defined in: [src/types/view/index.ts:78](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L78) diff --git a/docs/english/reference/interfaces/ViewConstraints.md b/docs/english/reference/interfaces/ViewConstraints.md index 63d3d5682..afe33f836 100644 --- a/docs/english/reference/interfaces/ViewConstraints.md +++ b/docs/english/reference/interfaces/ViewConstraints.md @@ -1,4 +1,4 @@ -# Interface: ViewConstraints +# ViewConstraints Defined in: [src/types/view/index.ts:11](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L11) diff --git a/docs/english/reference/interfaces/ViewErrorsResponseAction.md b/docs/english/reference/interfaces/ViewErrorsResponseAction.md index eb50467f8..fb442147e 100644 --- a/docs/english/reference/interfaces/ViewErrorsResponseAction.md +++ b/docs/english/reference/interfaces/ViewErrorsResponseAction.md @@ -1,4 +1,4 @@ -# Interface: ViewErrorsResponseAction +# ViewErrorsResponseAction Defined in: [src/types/view/index.ts:302](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L302) diff --git a/docs/english/reference/interfaces/ViewOutput.md b/docs/english/reference/interfaces/ViewOutput.md index facf65e8f..8c0a97b91 100644 --- a/docs/english/reference/interfaces/ViewOutput.md +++ b/docs/english/reference/interfaces/ViewOutput.md @@ -1,4 +1,4 @@ -# Interface: ViewOutput +# ViewOutput Defined in: [src/types/view/index.ts:254](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L254) diff --git a/docs/english/reference/interfaces/ViewPushResponseAction.md b/docs/english/reference/interfaces/ViewPushResponseAction.md index 0230d2902..f8a184c31 100644 --- a/docs/english/reference/interfaces/ViewPushResponseAction.md +++ b/docs/english/reference/interfaces/ViewPushResponseAction.md @@ -1,4 +1,4 @@ -# Interface: ViewPushResponseAction +# ViewPushResponseAction Defined in: [src/types/view/index.ts:293](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L293) diff --git a/docs/english/reference/interfaces/ViewResponseUrl.md b/docs/english/reference/interfaces/ViewResponseUrl.md index 3ff4740f3..8f6cf9f36 100644 --- a/docs/english/reference/interfaces/ViewResponseUrl.md +++ b/docs/english/reference/interfaces/ViewResponseUrl.md @@ -1,4 +1,4 @@ -# Interface: ViewResponseUrl +# ViewResponseUrl Defined in: [src/types/view/index.ts:34](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L34) diff --git a/docs/english/reference/interfaces/ViewStateSelectedOption.md b/docs/english/reference/interfaces/ViewStateSelectedOption.md index e9815d44f..8ccc5c665 100644 --- a/docs/english/reference/interfaces/ViewStateSelectedOption.md +++ b/docs/english/reference/interfaces/ViewStateSelectedOption.md @@ -1,4 +1,4 @@ -# Interface: ViewStateSelectedOption +# ViewStateSelectedOption Defined in: [src/types/view/index.ts:103](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L103) diff --git a/docs/english/reference/interfaces/ViewStateValue.md b/docs/english/reference/interfaces/ViewStateValue.md index 7862e16fd..3049dc5a8 100644 --- a/docs/english/reference/interfaces/ViewStateValue.md +++ b/docs/english/reference/interfaces/ViewStateValue.md @@ -1,4 +1,4 @@ -# Interface: ViewStateValue +# ViewStateValue Defined in: [src/types/view/index.ts:236](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L236) diff --git a/docs/english/reference/interfaces/ViewSubmitAction.md b/docs/english/reference/interfaces/ViewSubmitAction.md index 8f14bfc48..e23574db3 100644 --- a/docs/english/reference/interfaces/ViewSubmitAction.md +++ b/docs/english/reference/interfaces/ViewSubmitAction.md @@ -1,4 +1,4 @@ -# Interface: ViewSubmitAction +# ViewSubmitAction Defined in: [src/types/view/index.ts:47](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L47) diff --git a/docs/english/reference/interfaces/ViewUpdateResponseAction.md b/docs/english/reference/interfaces/ViewUpdateResponseAction.md index a70fcb896..f9131d962 100644 --- a/docs/english/reference/interfaces/ViewUpdateResponseAction.md +++ b/docs/english/reference/interfaces/ViewUpdateResponseAction.md @@ -1,4 +1,4 @@ -# Interface: ViewUpdateResponseAction +# ViewUpdateResponseAction Defined in: [src/types/view/index.ts:288](https://github.com/slackapi/bolt-js/blob/main/src/types/view/index.ts#L288) diff --git a/docs/english/reference/type-aliases/AckFn.md b/docs/english/reference/type-aliases/AckFn.md index c7ffc2889..4047fdf5a 100644 --- a/docs/english/reference/type-aliases/AckFn.md +++ b/docs/english/reference/type-aliases/AckFn.md @@ -1,4 +1,4 @@ -# Type Alias: AckFn\ +# AckFn\ ```ts type AckFn = (response?) => Promise; diff --git a/docs/english/reference/type-aliases/AnyMiddlewareArgs.md b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md index d65c2b0eb..1375ec38f 100644 --- a/docs/english/reference/type-aliases/AnyMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/AnyMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Type Alias: AnyMiddlewareArgs +# AnyMiddlewareArgs ```ts type AnyMiddlewareArgs = diff --git a/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md index f78ed7184..6f738fdbe 100644 --- a/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantThreadContextChangedMiddleware.md @@ -1,4 +1,4 @@ -# Type Alias: AssistantThreadContextChangedMiddleware +# AssistantThreadContextChangedMiddleware ```ts type AssistantThreadContextChangedMiddleware = Middleware; diff --git a/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md index 00cd00081..d0f027add 100644 --- a/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantThreadStartedMiddleware.md @@ -1,4 +1,4 @@ -# Type Alias: AssistantThreadStartedMiddleware +# AssistantThreadStartedMiddleware ```ts type AssistantThreadStartedMiddleware = Middleware; diff --git a/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md index ce1dca35b..0b09689dd 100644 --- a/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md +++ b/docs/english/reference/type-aliases/AssistantUserMessageMiddleware.md @@ -1,4 +1,4 @@ -# Type Alias: AssistantUserMessageMiddleware +# AssistantUserMessageMiddleware ```ts type AssistantUserMessageMiddleware = Middleware; diff --git a/docs/english/reference/type-aliases/Authorize.md b/docs/english/reference/type-aliases/Authorize.md index 88660d9be..7ded5fbb9 100644 --- a/docs/english/reference/type-aliases/Authorize.md +++ b/docs/english/reference/type-aliases/Authorize.md @@ -1,4 +1,4 @@ -# Type Alias: Authorize\ +# Authorize\ ```ts type Authorize = (source, body?) => Promise; diff --git a/docs/english/reference/type-aliases/BlockButtonAction.md b/docs/english/reference/type-aliases/BlockButtonAction.md index 494cfe761..5b3708ac4 100644 --- a/docs/english/reference/type-aliases/BlockButtonAction.md +++ b/docs/english/reference/type-aliases/BlockButtonAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockButtonAction +# BlockButtonAction ```ts type BlockButtonAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockChannelsSelectAction.md b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md index 1f8a0252d..a7ac21196 100644 --- a/docs/english/reference/type-aliases/BlockChannelsSelectAction.md +++ b/docs/english/reference/type-aliases/BlockChannelsSelectAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockChannelsSelectAction +# BlockChannelsSelectAction ```ts type BlockChannelsSelectAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockCheckboxesAction.md b/docs/english/reference/type-aliases/BlockCheckboxesAction.md index ab8f570c6..260783e63 100644 --- a/docs/english/reference/type-aliases/BlockCheckboxesAction.md +++ b/docs/english/reference/type-aliases/BlockCheckboxesAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockCheckboxesAction +# BlockCheckboxesAction ```ts type BlockCheckboxesAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockConversationsSelectAction.md b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md index 3249caf9b..67f4d03be 100644 --- a/docs/english/reference/type-aliases/BlockConversationsSelectAction.md +++ b/docs/english/reference/type-aliases/BlockConversationsSelectAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockConversationsSelectAction +# BlockConversationsSelectAction ```ts type BlockConversationsSelectAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockDatepickerAction.md b/docs/english/reference/type-aliases/BlockDatepickerAction.md index e651a4534..4db1cdc02 100644 --- a/docs/english/reference/type-aliases/BlockDatepickerAction.md +++ b/docs/english/reference/type-aliases/BlockDatepickerAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockDatepickerAction +# BlockDatepickerAction ```ts type BlockDatepickerAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockElementAction.md b/docs/english/reference/type-aliases/BlockElementAction.md index 79dd93d3a..1a4cdbd06 100644 --- a/docs/english/reference/type-aliases/BlockElementAction.md +++ b/docs/english/reference/type-aliases/BlockElementAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockElementAction +# BlockElementAction ```ts type BlockElementAction = diff --git a/docs/english/reference/type-aliases/BlockExternalSelectAction.md b/docs/english/reference/type-aliases/BlockExternalSelectAction.md index da42b4d9b..07b6671a6 100644 --- a/docs/english/reference/type-aliases/BlockExternalSelectAction.md +++ b/docs/english/reference/type-aliases/BlockExternalSelectAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockExternalSelectAction +# BlockExternalSelectAction ```ts type BlockExternalSelectAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md index 85c3cb8f2..9e606a5e5 100644 --- a/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md +++ b/docs/english/reference/type-aliases/BlockFeedbackButtonsAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockFeedbackButtonsAction +# BlockFeedbackButtonsAction ```ts type BlockFeedbackButtonsAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockIconButtonAction.md b/docs/english/reference/type-aliases/BlockIconButtonAction.md index 886440fd6..455f51dd1 100644 --- a/docs/english/reference/type-aliases/BlockIconButtonAction.md +++ b/docs/english/reference/type-aliases/BlockIconButtonAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockIconButtonAction +# BlockIconButtonAction ```ts type BlockIconButtonAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockOverflowAction.md b/docs/english/reference/type-aliases/BlockOverflowAction.md index 8f0df1f6d..930191431 100644 --- a/docs/english/reference/type-aliases/BlockOverflowAction.md +++ b/docs/english/reference/type-aliases/BlockOverflowAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockOverflowAction +# BlockOverflowAction ```ts type BlockOverflowAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockPlainTextInputAction.md b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md index e1669bbfd..6e2ae40fe 100644 --- a/docs/english/reference/type-aliases/BlockPlainTextInputAction.md +++ b/docs/english/reference/type-aliases/BlockPlainTextInputAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockPlainTextInputAction +# BlockPlainTextInputAction ```ts type BlockPlainTextInputAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockRadioButtonsAction.md b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md index 69f16ca69..cc2b61915 100644 --- a/docs/english/reference/type-aliases/BlockRadioButtonsAction.md +++ b/docs/english/reference/type-aliases/BlockRadioButtonsAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockRadioButtonsAction +# BlockRadioButtonsAction ```ts type BlockRadioButtonsAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockStaticSelectAction.md b/docs/english/reference/type-aliases/BlockStaticSelectAction.md index 9ba7bf2fb..d2f3f7f93 100644 --- a/docs/english/reference/type-aliases/BlockStaticSelectAction.md +++ b/docs/english/reference/type-aliases/BlockStaticSelectAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockStaticSelectAction +# BlockStaticSelectAction ```ts type BlockStaticSelectAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockTimepickerAction.md b/docs/english/reference/type-aliases/BlockTimepickerAction.md index b1f8e63fd..a6e99288d 100644 --- a/docs/english/reference/type-aliases/BlockTimepickerAction.md +++ b/docs/english/reference/type-aliases/BlockTimepickerAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockTimepickerAction +# BlockTimepickerAction ```ts type BlockTimepickerAction = BlockAction; diff --git a/docs/english/reference/type-aliases/BlockUsersSelectAction.md b/docs/english/reference/type-aliases/BlockUsersSelectAction.md index 54d63a93d..dd14bceb3 100644 --- a/docs/english/reference/type-aliases/BlockUsersSelectAction.md +++ b/docs/english/reference/type-aliases/BlockUsersSelectAction.md @@ -1,4 +1,4 @@ -# Type Alias: BlockUsersSelectAction +# BlockUsersSelectAction ```ts type BlockUsersSelectAction = BlockAction; diff --git a/docs/english/reference/type-aliases/EventFromType.md b/docs/english/reference/type-aliases/EventFromType.md index e4f1f810e..05edb5406 100644 --- a/docs/english/reference/type-aliases/EventFromType.md +++ b/docs/english/reference/type-aliases/EventFromType.md @@ -1,4 +1,4 @@ -# Type Alias: EventFromType\ +# EventFromType\ ```ts type EventFromType = KnownEventFromType extends never ? BaseSlackEvent : KnownEventFromType; diff --git a/docs/english/reference/type-aliases/EventTypePattern.md b/docs/english/reference/type-aliases/EventTypePattern.md index ec2d9dfdc..c6f716631 100644 --- a/docs/english/reference/type-aliases/EventTypePattern.md +++ b/docs/english/reference/type-aliases/EventTypePattern.md @@ -1,4 +1,4 @@ -# Type Alias: EventTypePattern +# EventTypePattern ```ts type EventTypePattern = string | RegExp; diff --git a/docs/english/reference/type-aliases/FunctionInputs.md b/docs/english/reference/type-aliases/FunctionInputs.md index 8c6afae3a..6866271f8 100644 --- a/docs/english/reference/type-aliases/FunctionInputs.md +++ b/docs/english/reference/type-aliases/FunctionInputs.md @@ -1,4 +1,4 @@ -# Type Alias: FunctionInputs +# FunctionInputs ```ts type FunctionInputs = Record; diff --git a/docs/english/reference/type-aliases/InteractiveAction.md b/docs/english/reference/type-aliases/InteractiveAction.md index eb49d0eab..1917b8b70 100644 --- a/docs/english/reference/type-aliases/InteractiveAction.md +++ b/docs/english/reference/type-aliases/InteractiveAction.md @@ -1,4 +1,4 @@ -# Type Alias: InteractiveAction +# InteractiveAction ```ts type InteractiveAction = diff --git a/docs/english/reference/type-aliases/InteractiveButtonClick.md b/docs/english/reference/type-aliases/InteractiveButtonClick.md index 3b4969f1c..1b0b27051 100644 --- a/docs/english/reference/type-aliases/InteractiveButtonClick.md +++ b/docs/english/reference/type-aliases/InteractiveButtonClick.md @@ -1,4 +1,4 @@ -# Type Alias: InteractiveButtonClick +# InteractiveButtonClick ```ts type InteractiveButtonClick = InteractiveMessage; diff --git a/docs/english/reference/type-aliases/InteractiveMenuSelect.md b/docs/english/reference/type-aliases/InteractiveMenuSelect.md index 805a04954..4063f09c1 100644 --- a/docs/english/reference/type-aliases/InteractiveMenuSelect.md +++ b/docs/english/reference/type-aliases/InteractiveMenuSelect.md @@ -1,4 +1,4 @@ -# Type Alias: InteractiveMenuSelect +# InteractiveMenuSelect ```ts type InteractiveMenuSelect = InteractiveMessage; diff --git a/docs/english/reference/type-aliases/KnownEventFromType.md b/docs/english/reference/type-aliases/KnownEventFromType.md index 83e9f27e4..5081ceec1 100644 --- a/docs/english/reference/type-aliases/KnownEventFromType.md +++ b/docs/english/reference/type-aliases/KnownEventFromType.md @@ -1,4 +1,4 @@ -# Type Alias: KnownEventFromType\ +# KnownEventFromType\ ```ts type KnownEventFromType = Extract +# KnownOptionsPayloadFromType\ ```ts type KnownOptionsPayloadFromType = Extract +# Middleware\ ```ts type Middleware = (args) => Promise; diff --git a/docs/english/reference/type-aliases/NextFn.md b/docs/english/reference/type-aliases/NextFn.md index 89da88d62..92fe36355 100644 --- a/docs/english/reference/type-aliases/NextFn.md +++ b/docs/english/reference/type-aliases/NextFn.md @@ -1,4 +1,4 @@ -# Type Alias: NextFn +# NextFn ```ts type NextFn = () => Promise; diff --git a/docs/english/reference/type-aliases/OptionsPayloadFromType.md b/docs/english/reference/type-aliases/OptionsPayloadFromType.md index 7f0be5908..5444884af 100644 --- a/docs/english/reference/type-aliases/OptionsPayloadFromType.md +++ b/docs/english/reference/type-aliases/OptionsPayloadFromType.md @@ -1,4 +1,4 @@ -# Type Alias: OptionsPayloadFromType\ +# OptionsPayloadFromType\ ```ts type OptionsPayloadFromType = KnownOptionsPayloadFromType extends never ? BasicOptionsPayload : KnownOptionsPayloadFromType; diff --git a/docs/english/reference/type-aliases/OptionsSource.md b/docs/english/reference/type-aliases/OptionsSource.md index ca00c3ac4..a36ee8be0 100644 --- a/docs/english/reference/type-aliases/OptionsSource.md +++ b/docs/english/reference/type-aliases/OptionsSource.md @@ -1,4 +1,4 @@ -# Type Alias: OptionsSource +# OptionsSource ```ts type OptionsSource = SlackOptions["type"]; diff --git a/docs/english/reference/type-aliases/RespondArguments.md b/docs/english/reference/type-aliases/RespondArguments.md index 2e3da5a54..e0a673ef0 100644 --- a/docs/english/reference/type-aliases/RespondArguments.md +++ b/docs/english/reference/type-aliases/RespondArguments.md @@ -1,4 +1,4 @@ -# Type Alias: RespondArguments +# RespondArguments ```ts type RespondArguments = DistributiveOmit & object; diff --git a/docs/english/reference/type-aliases/RespondFn.md b/docs/english/reference/type-aliases/RespondFn.md index b1aeb0363..db38a7a12 100644 --- a/docs/english/reference/type-aliases/RespondFn.md +++ b/docs/english/reference/type-aliases/RespondFn.md @@ -1,4 +1,4 @@ -# Type Alias: RespondFn +# RespondFn ```ts type RespondFn = (message) => Promise>>; diff --git a/docs/english/reference/type-aliases/SayArguments.md b/docs/english/reference/type-aliases/SayArguments.md index 234391cd1..cb79dc25a 100644 --- a/docs/english/reference/type-aliases/SayArguments.md +++ b/docs/english/reference/type-aliases/SayArguments.md @@ -1,4 +1,4 @@ -# Type Alias: SayArguments +# SayArguments ```ts type SayArguments = DistributiveOmit & object; diff --git a/docs/english/reference/type-aliases/SayFn.md b/docs/english/reference/type-aliases/SayFn.md index 9740a5fb2..7c7262c49 100644 --- a/docs/english/reference/type-aliases/SayFn.md +++ b/docs/english/reference/type-aliases/SayFn.md @@ -1,4 +1,4 @@ -# Type Alias: SayFn +# SayFn ```ts type SayFn = (message) => Promise; diff --git a/docs/english/reference/type-aliases/SayStreamArguments.md b/docs/english/reference/type-aliases/SayStreamArguments.md index dacc64e69..0f78c041f 100644 --- a/docs/english/reference/type-aliases/SayStreamArguments.md +++ b/docs/english/reference/type-aliases/SayStreamArguments.md @@ -1,4 +1,4 @@ -# Type Alias: SayStreamArguments +# SayStreamArguments ```ts type SayStreamArguments = Partial>; diff --git a/docs/english/reference/type-aliases/SayStreamFn.md b/docs/english/reference/type-aliases/SayStreamFn.md index a2aac956d..97090cec9 100644 --- a/docs/english/reference/type-aliases/SayStreamFn.md +++ b/docs/english/reference/type-aliases/SayStreamFn.md @@ -1,4 +1,4 @@ -# Type Alias: SayStreamFn +# SayStreamFn ```ts type SayStreamFn = (args?) => ReturnType; diff --git a/docs/english/reference/type-aliases/SetStatusArguments.md b/docs/english/reference/type-aliases/SetStatusArguments.md index ff7a80a3d..fa5982914 100644 --- a/docs/english/reference/type-aliases/SetStatusArguments.md +++ b/docs/english/reference/type-aliases/SetStatusArguments.md @@ -1,4 +1,4 @@ -# Type Alias: SetStatusArguments +# SetStatusArguments ```ts type SetStatusArguments = Omit; diff --git a/docs/english/reference/type-aliases/SetStatusFn.md b/docs/english/reference/type-aliases/SetStatusFn.md index c5f6ac4fc..ca0dc35f3 100644 --- a/docs/english/reference/type-aliases/SetStatusFn.md +++ b/docs/english/reference/type-aliases/SetStatusFn.md @@ -1,4 +1,4 @@ -# Type Alias: SetStatusFn +# SetStatusFn ```ts type SetStatusFn = (status) => Promise; diff --git a/docs/english/reference/type-aliases/SlackAction.md b/docs/english/reference/type-aliases/SlackAction.md index 6009585cb..803b5da48 100644 --- a/docs/english/reference/type-aliases/SlackAction.md +++ b/docs/english/reference/type-aliases/SlackAction.md @@ -1,4 +1,4 @@ -# Type Alias: SlackAction +# SlackAction ```ts type SlackAction = diff --git a/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md index 82357856d..7c7d634a5 100644 --- a/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackActionMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Type Alias: SlackActionMiddlewareArgs\ +# SlackActionMiddlewareArgs\ ```ts type SlackActionMiddlewareArgs = object & Action extends Exclude ? object : unknown; diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md index 790f690e4..69f0f91c9 100644 --- a/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Type Alias: SlackEventMiddlewareArgs\ +# SlackEventMiddlewareArgs\ ```ts type SlackEventMiddlewareArgs = object & EventType extends "message" ? object : unknown & EventFromType extends diff --git a/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md index d6deb0e78..c216bc055 100644 --- a/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md +++ b/docs/english/reference/type-aliases/SlackEventMiddlewareArgsOptions.md @@ -1,4 +1,4 @@ -# Type Alias: SlackEventMiddlewareArgsOptions +# SlackEventMiddlewareArgsOptions ```ts type SlackEventMiddlewareArgsOptions = object; diff --git a/docs/english/reference/type-aliases/SlackOptions.md b/docs/english/reference/type-aliases/SlackOptions.md index 93d6917a9..5c499ec50 100644 --- a/docs/english/reference/type-aliases/SlackOptions.md +++ b/docs/english/reference/type-aliases/SlackOptions.md @@ -1,4 +1,4 @@ -# Type Alias: SlackOptions +# SlackOptions ```ts type SlackOptions = diff --git a/docs/english/reference/type-aliases/SlackShortcut.md b/docs/english/reference/type-aliases/SlackShortcut.md index 55901622e..162524906 100644 --- a/docs/english/reference/type-aliases/SlackShortcut.md +++ b/docs/english/reference/type-aliases/SlackShortcut.md @@ -1,4 +1,4 @@ -# Type Alias: SlackShortcut +# SlackShortcut ```ts type SlackShortcut = diff --git a/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md index fd4ff7f2b..9a80ae3f2 100644 --- a/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md +++ b/docs/english/reference/type-aliases/SlackShortcutMiddlewareArgs.md @@ -1,4 +1,4 @@ -# Type Alias: SlackShortcutMiddlewareArgs\ +# SlackShortcutMiddlewareArgs\ ```ts type SlackShortcutMiddlewareArgs = object & Shortcut extends MessageShortcut ? object : unknown; diff --git a/docs/english/reference/type-aliases/SlackViewAction.md b/docs/english/reference/type-aliases/SlackViewAction.md index 5ec236419..694c50409 100644 --- a/docs/english/reference/type-aliases/SlackViewAction.md +++ b/docs/english/reference/type-aliases/SlackViewAction.md @@ -1,4 +1,4 @@ -# Type Alias: SlackViewAction +# SlackViewAction ```ts type SlackViewAction = diff --git a/docs/english/reference/type-aliases/StringIndexed.md b/docs/english/reference/type-aliases/StringIndexed.md index 8bb81676e..1b30ee739 100644 --- a/docs/english/reference/type-aliases/StringIndexed.md +++ b/docs/english/reference/type-aliases/StringIndexed.md @@ -1,4 +1,4 @@ -# Type Alias: StringIndexed +# StringIndexed ```ts type StringIndexed = Record; diff --git a/docs/english/reference/type-aliases/ViewResponseAction.md b/docs/english/reference/type-aliases/ViewResponseAction.md index ccfc99743..eb7071096 100644 --- a/docs/english/reference/type-aliases/ViewResponseAction.md +++ b/docs/english/reference/type-aliases/ViewResponseAction.md @@ -1,4 +1,4 @@ -# Type Alias: ViewResponseAction +# ViewResponseAction ```ts type ViewResponseAction = diff --git a/docs/english/reference/type-aliases/XOR.md b/docs/english/reference/type-aliases/XOR.md index e6bc9dbe4..114a47c8e 100644 --- a/docs/english/reference/type-aliases/XOR.md +++ b/docs/english/reference/type-aliases/XOR.md @@ -1,4 +1,4 @@ -# Type Alias: XOR\ +# XOR\ ```ts type XOR = T | U extends Record ? Without & U | Without & T : T | U; diff --git a/docs/english/reference/variables/autoAcknowledge.md b/docs/english/reference/variables/autoAcknowledge.md index f7d5cbbf1..837b5199b 100644 --- a/docs/english/reference/variables/autoAcknowledge.md +++ b/docs/english/reference/variables/autoAcknowledge.md @@ -1,4 +1,4 @@ -# Variable: autoAcknowledge +# autoAcknowledge ```ts const autoAcknowledge: Middleware; diff --git a/docs/english/reference/variables/contextBuiltinKeys.md b/docs/english/reference/variables/contextBuiltinKeys.md index cb278901f..8853e634a 100644 --- a/docs/english/reference/variables/contextBuiltinKeys.md +++ b/docs/english/reference/variables/contextBuiltinKeys.md @@ -1,4 +1,4 @@ -# Variable: contextBuiltinKeys +# contextBuiltinKeys ```ts const contextBuiltinKeys: string[]; diff --git a/docs/english/reference/variables/directMention.md b/docs/english/reference/variables/directMention.md index 8c66e32c6..7c1669fbb 100644 --- a/docs/english/reference/variables/directMention.md +++ b/docs/english/reference/variables/directMention.md @@ -1,4 +1,4 @@ -# Variable: directMention +# directMention ```ts const directMention: Middleware>; diff --git a/docs/english/reference/variables/ignoreSelf.md b/docs/english/reference/variables/ignoreSelf.md index 4af7902cc..068eef035 100644 --- a/docs/english/reference/variables/ignoreSelf.md +++ b/docs/english/reference/variables/ignoreSelf.md @@ -1,4 +1,4 @@ -# Variable: ignoreSelf +# ignoreSelf ```ts const ignoreSelf: Middleware; diff --git a/docs/english/reference/variables/onlyActions.md b/docs/english/reference/variables/onlyActions.md index bb80b0463..c64b1e81a 100644 --- a/docs/english/reference/variables/onlyActions.md +++ b/docs/english/reference/variables/onlyActions.md @@ -1,4 +1,4 @@ -# Variable: onlyActions +# onlyActions ```ts const onlyActions: Middleware; diff --git a/docs/english/reference/variables/onlyCommands.md b/docs/english/reference/variables/onlyCommands.md index f2b4cdf37..633da26a7 100644 --- a/docs/english/reference/variables/onlyCommands.md +++ b/docs/english/reference/variables/onlyCommands.md @@ -1,4 +1,4 @@ -# Variable: onlyCommands +# onlyCommands ```ts const onlyCommands: Middleware; diff --git a/docs/english/reference/variables/onlyEvents.md b/docs/english/reference/variables/onlyEvents.md index a83b3cae8..fdbc0a224 100644 --- a/docs/english/reference/variables/onlyEvents.md +++ b/docs/english/reference/variables/onlyEvents.md @@ -1,4 +1,4 @@ -# Variable: onlyEvents +# onlyEvents ```ts const onlyEvents: Middleware; diff --git a/docs/english/reference/variables/onlyOptions.md b/docs/english/reference/variables/onlyOptions.md index c5c8db331..bab0aaebf 100644 --- a/docs/english/reference/variables/onlyOptions.md +++ b/docs/english/reference/variables/onlyOptions.md @@ -1,4 +1,4 @@ -# Variable: onlyOptions +# onlyOptions ```ts const onlyOptions: Middleware; diff --git a/docs/english/reference/variables/onlyShortcuts.md b/docs/english/reference/variables/onlyShortcuts.md index cc09b0b9b..18bae760d 100644 --- a/docs/english/reference/variables/onlyShortcuts.md +++ b/docs/english/reference/variables/onlyShortcuts.md @@ -1,4 +1,4 @@ -# Variable: onlyShortcuts +# onlyShortcuts ```ts const onlyShortcuts: Middleware; diff --git a/docs/english/reference/variables/onlyViewActions.md b/docs/english/reference/variables/onlyViewActions.md index dff5a6152..c1f0a9aec 100644 --- a/docs/english/reference/variables/onlyViewActions.md +++ b/docs/english/reference/variables/onlyViewActions.md @@ -1,4 +1,4 @@ -# Variable: onlyViewActions +# onlyViewActions ```ts const onlyViewActions: Middleware; diff --git a/typedoc.json b/typedoc.json index a4f400769..1b6a92f7a 100644 --- a/typedoc.json +++ b/typedoc.json @@ -3,6 +3,11 @@ "entryPoints": ["src/index.ts"], "plugin": ["typedoc-plugin-markdown", "./typedoc-plugin-sidebar-labels.mjs"], "hideBreadcrumbs": true, + "pageTitleTemplates": { + "index": "{projectName}", + "member": "{name}", + "module": "{name}" + }, "outputs": [ { "name": "markdown",