UseChatMessagesReturn
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:452
Properties
appendMessage()
appendMessage: (
message) =>void
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:458
Append a new message to the end
Parameters
message
Returns
void
clearMessages()
clearMessages: () =>
void
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:472
Clear all messages
Returns
void
getMessage()
getMessage: (
id) =>ChatMessageData|undefined
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:474
Find a message by ID
Parameters
id
string
Returns
ChatMessageData | undefined
messages
messages:
ChatMessageData[]
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:454
Current message array
removeMessage()
removeMessage: (
id) =>void
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:470
Remove a message by ID
Parameters
id
string
Returns
void
setMessages
setMessages:
Dispatch<SetStateAction<ChatMessageData[]>>
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:456
Replace the entire message array
updateMessage()
updateMessage: (
id,update) =>void
Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:463
Update a message by ID. Accepts a partial update or an updater function.
Parameters
id
string
update
Partial<ChatMessageData> | (prev) => Partial<ChatMessageData>
Returns
void