Function runChatMessageHandlerReplyCreator

runChatMessageHandlerReplyCreator<DATA, CREATE_REPLY_INPUT_DATA, DETECTOR_INPUT_DATA, DETECTOR_OUTPUT_DATA>(client: Readonly<Client>, channel: string, tags: Readonly<ChatUserstate>, message: string, data: DATA, globalStrings: Readonly<StringMap>, globalPlugins: Readonly<PluginMap>, globalMacros: Readonly<MacroMap>, logger: Readonly<Logger>, chatMessageHandler: ChatMessageHandlerReplyCreator<CREATE_REPLY_INPUT_DATA, DETECTOR_INPUT_DATA, DETECTOR_OUTPUT_DATA>): Promise<boolean>
Generic method to handle a chat message.

Returns
True if the command was detected and a reply was sent.
Type Parameters
- DATA extends object
- CREATE_REPLY_INPUT_DATA extends object = EMPTY_OBJECT
  
  The data that is necessary to create a reply.
- DETECTOR_INPUT_DATA extends object = EMPTY_OBJECT
  
  The data that is necessary to detect if a reply should be created.
- DETECTOR_OUTPUT_DATA extends object = EMPTY_OBJECT
  
  The data that is created by the reply detector for further use when creating the reply.
Parameters
- client: Readonly<Client>
  
  Twitch client.
- channel: string
  
  Twitch channel.
- tags: Readonly<ChatUserstate>
  
  Twitch user state.
- message: string
  
  Twitch message.
- data: DATA
  
  Data for Twitch command handler.
- globalStrings: Readonly<StringMap>
  
  Global strings.
- globalPlugins: Readonly<PluginMap>
  
  Global plugins.
- globalMacros: Readonly<MacroMap>
  
  Global macros.
- logger: Readonly<Logger>
  
  Global logger.
- chatMessageHandler: ChatMessageHandlerReplyCreator<CREATE_REPLY_INPUT_DATA, DETECTOR_INPUT_DATA, DETECTOR_OUTPUT_DATA>
  
  The Twitch command handler.
Returns Promise<boolean>
- Defined in src/chatMessageHandler/runChatMessageHandler.ts:186

Function runChatMessageHandlerReplyCreator

Returns

Type Parameters

DATA extends object

CREATE_REPLY_INPUT_DATA extends object = EMPTY_OBJECT

DETECTOR_INPUT_DATA extends object = EMPTY_OBJECT

DETECTOR_OUTPUT_DATA extends object = EMPTY_OBJECT

Parameters

client: Readonly<Client>

channel: string

tags: Readonly<ChatUserstate>

message: string

data: DATA

globalStrings: Readonly<StringMap>

globalPlugins: Readonly<PluginMap>

globalMacros: Readonly<MacroMap>

logger: Readonly<Logger>

chatMessageHandler: ChatMessageHandlerReplyCreator<CREATE_REPLY_INPUT_DATA, DETECTOR_INPUT_DATA, DETECTOR_OUTPUT_DATA>

Returns Promise<boolean>

Settings

Member Visibility

Theme