Class ChatChannel<TMeta>

Type Parameters

TMeta = Record<string, unknown>

Index

Methods

create getId join leave hasMember memberCount members$ installFilter uninstallFilter filterCount send recent historyLength clearHistory getRateLimitMessages getRateLimitWindowMs getHistorySize getMaxBodyLen sendsInWindow

Methods

`Static`create

create<TMeta = Record<string, unknown>>(
opts: ChatChannelOptions,
): ChatChannel<TMeta>
Type Parameters
- TMeta = Record<string, unknown>
Parameters
- opts: ChatChannelOptions
Returns ChatChannel<TMeta>
- Defined in runtime/chat-channel.ts:107

getId

getId(): string
Returns string
- Defined in runtime/chat-channel.ts:112

join

join(id: string, now: number): boolean
Parameters
- id: string
- now: number
Returns boolean
- Defined in runtime/chat-channel.ts:115

leave

leave(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/chat-channel.ts:124

hasMember

hasMember(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/chat-channel.ts:128

memberCount

memberCount(): number
Returns number
- Defined in runtime/chat-channel.ts:129

members$

members$(): ChatMember[]
Returns ChatMember[]
- Defined in runtime/chat-channel.ts:130

installFilter

installFilter(fn: ChatFilter<TMeta>): void
Parameters
- fn: ChatFilter<TMeta>
Returns void
- Defined in runtime/chat-channel.ts:148

uninstallFilter

uninstallFilter(fn: ChatFilter<TMeta>): boolean
Parameters
- fn: ChatFilter<TMeta>
Returns boolean
- Defined in runtime/chat-channel.ts:154

filterCount

filterCount(): number
Returns number
- Defined in runtime/chat-channel.ts:161

send

send(
    senderId: string,
    body: string,
    now: number,
    meta?: TMeta,
): SendResult<TMeta>
Parameters
- senderId: string
- body: string
- now: number
- Optionalmeta: TMeta
Returns SendResult<TMeta>
- Defined in runtime/chat-channel.ts:165

recent

recent(limit?: number): ChatMessage<TMeta>[]
Parameters
- Optionallimit: number
Returns ChatMessage<TMeta>[]
- Defined in runtime/chat-channel.ts:233

historyLength

historyLength(): number
Returns number
- Defined in runtime/chat-channel.ts:238

clearHistory

clearHistory(): void
Returns void
- Defined in runtime/chat-channel.ts:239

getRateLimitMessages

getRateLimitMessages(): number
Returns number
- Defined in runtime/chat-channel.ts:242

getRateLimitWindowMs

getRateLimitWindowMs(): number
Returns number
- Defined in runtime/chat-channel.ts:243

getHistorySize

getHistorySize(): number
Returns number
- Defined in runtime/chat-channel.ts:244

getMaxBodyLen

getMaxBodyLen(): number
Returns number
- Defined in runtime/chat-channel.ts:245

sendsInWindow

sendsInWindow(senderId: string, now: number): number
Parameters
- senderId: string
- now: number
Returns number
- Defined in runtime/chat-channel.ts:249