Interface ChatMessage<M>

A single chat message.

interface ChatMessage<M = unknown> {
    content: string;
    id: string;
    meta?: M;
    sender: ChatParticipant;
    timestamp: Date;
    type?: ChatMessageType;
}

Type Parameters

M = unknown
— Extra metadata attached to each message.

Index

Properties

content id meta? sender timestamp type?

Properties

`Readonly`content

content: string

Message content (plain text or HTML depending on type).

`Readonly`id

id: string

Unique message identifier.

`Optional` `Readonly`meta

meta?: M

Optional metadata.

`Readonly`sender

sender: ChatParticipant

Who sent the message.

`Readonly`timestamp

timestamp: Date

When the message was sent.

`Optional` `Readonly`type

type?: ChatMessageType

Content interpretation. Defaults to 'text'.