@kararty/dank-twitch-irc

Index

Enumerations

ClientState

Interfaces

Type aliases

Variables

Functions

Type aliases

AnnouncementUsernoticeMessage

AnnouncementUsernoticeMessage: AnAnnouncementUsernoticeMessage<"announcement", AnnouncementParameters>

AnonGiftPaidUpgradeParameters

AnonGiftPaidUpgradeParameters: EventParams & { promoGiftTotal?: number; promoGiftTotalRaw?: string; promoName?: string }

AnonGiftPaidUpgradeUsernoticeMessage

AnonGiftPaidUpgradeUsernoticeMessage: SpecificUsernoticeMessage<"anongiftpaidupgrade", AnonGiftPaidUpgradeParameters>

AnonSubgiftParameters

AnonSubgiftParameters: SubgiftParameters

AnonSubgiftUsernoticeMessage

AnonSubgiftUsernoticeMessage: SpecificUsernoticeMessage<"anonsubgift", AnonSubgiftParameters>

BasicTcpTransportConfiguration

BasicTcpTransportConfiguration: Omit<TcpTransportConfiguration, "host" | "port">

BitsBadgeTierUsernoticeMessage

BitsBadgeTierUsernoticeMessage: SpecificUsernoticeMessage<"bitsbadgetier", BitsBadgeTierParameters>

ClientEvents

ClientEvents: SpecificClientEvents & TwitchMessageEvents & IRCMessageEvents

Condition

Condition: (message: IRCMessage) => boolean

Type declaration

- (message: IRCMessage): boolean
- Parameters
  - message: IRCMessage
  Returns boolean

ConnectionPredicate

ConnectionPredicate: (conn: SingleConnection) => boolean

Type declaration

- (conn: SingleConnection): boolean
- Parameters
  - conn: SingleConnection
  Returns boolean

CustomRateLimitsConfig

CustomRateLimitsConfig: RateLimits

ExpandedClientConfiguration

ExpandedClientConfiguration: Required<Omit<ClientConfiguration, "connection" | "password" | "rateLimits">> & { connection: ExpandedTransportConfiguration; password: string | undefined; rateLimits: RateLimits }

ExpandedDuplexTransportConfiguration

ExpandedDuplexTransportConfiguration: Required<DuplexTransportConfiguration>

ExpandedTcpTransportConfiguration

ExpandedTcpTransportConfiguration: Required<TcpTransportConfiguration> & { preSetup: false }

ExpandedTransportConfiguration

ExpandedTransportConfiguration: ExpandedDuplexTransportConfiguration | ExpandedTcpTransportConfiguration | ExpandedWebSocketTransportConfiguration

ExpandedWebSocketTransportConfiguration

ExpandedWebSocketTransportConfiguration: WebSocketTransportConfiguration & { preSetup: false }

FunctionPropsOf

FunctionPropsOf<T>: { [ K in keyof T as T[K] extends (...args: any) => any ? K : never]: T[K] }

Type parameters

T: object

GiftPaidUpgradeParameters

GiftPaidUpgradeParameters: AnonGiftPaidUpgradeParameters & { senderLogin: string; senderName: string }

GiftPaidUpgradeUsernoticeMessage

GiftPaidUpgradeUsernoticeMessage: SpecificUsernoticeMessage<"giftpaidupgrade", GiftPaidUpgradeParameters>

MassSubgiftUsernoticeMessage

MassSubgiftUsernoticeMessage: SpecificUsernoticeMessage<"submysterygift", MassSubgiftParameters>

OverrideFunction

OverrideFunction<S, T, K>: (this: S, oldFn: T[K], ...args: Parameters<T[K]>) => ReturnType<T[K]>

Type parameters

S
T: Record<string, (...args: any) => any>
K: keyof T

Type declaration

- (this: S, oldFn: T[K], ...args: Parameters<T[K]>): ReturnType<T[K]>
- Parameters
  - this: S
  - oldFn: T[K]
  - Rest ...args: Parameters<T[K]>
  Returns ReturnType<T[K]>

OverrideFunctions

OverrideFunctions<S, T>: { [ K in keyof T as T[K] extends (...args: any) => any ? K : never]?: OverrideFunction<S, T, K> }

Type parameters

S
T: Record<string, any>

PresetKeys

PresetKeys: "default" | "knownBot" | "verifiedBot"

PrivmsgUserState

PrivmsgUserState: Omit<UserState, "emoteSets" | "emoteSetsRaw">

Omits emoteSets and emoteSetsRaw from UserState (because they are not sent for PRIVMSG messages)

SubEventParams

SubEventParams: EventParams & StreakSubParams & { cumulativeMonths: number; cumulativeMonthsRaw: string; subPlan: string; subPlanName: string }

SubUsernoticeMessage

SubUsernoticeMessage: SpecificUsernoticeMessage<"sub", SubEventParams>

SubgiftUsernoticeMessage

SubgiftUsernoticeMessage: SpecificUsernoticeMessage<"subgift", SubgiftParameters>

TransportConfiguration

TransportConfiguration: DuplexTransportConfiguration | TcpTransportConfiguration | BasicTcpTransportConfiguration | WebSocketTransportConfiguration | PresetWebSocketTransportConfiguration

TwitchCommands

TwitchCommands: typeof commandClassMap

TwitchEmoteList

TwitchEmoteList: TwitchEmote[]

TwitchEmoteSets

TwitchEmoteSets: string[]

TwitchFlagList

TwitchFlagList: TwitchFlag[]

TwitchMessageEvents

TwitchMessageEvents: { [ P in keyof TwitchCommands]: [InstanceType<TwitchCommands[P]>] }

Variables

Const MAX_OUTGOING_COMMAND_LENGTH

MAX_OUTGOING_COMMAND_LENGTH: number = ...

Maximum command length (excluding CR LF) the twitch server will accept before chopping the rest off

Const MAX_OUTGOING_LINE_LENGTH

MAX_OUTGOING_LINE_LENGTH: 4096 = 4096

Maximum line length (including CR LF) the twitch server will accept before chopping the rest off

Const commandClassMap

commandClassMap: { CAP: typeof CapMessage; CLEARCHAT: typeof ClearchatMessage; CLEARMSG: typeof ClearmsgMessage; GLOBALUSERSTATE: typeof GlobaluserstateMessage; HOSTTARGET: typeof HosttargetMessage; JOIN: typeof JoinMessage; NOTICE: typeof NoticeMessage; PART: typeof PartMessage; PING: typeof PingMessage; PONG: typeof PongMessage; PRIVMSG: typeof PrivmsgMessage; RECONNECT: typeof ReconnectMessage; ROOMSTATE: typeof RoomstateMessage; USERNOTICE: typeof UsernoticeMessage; USERSTATE: typeof UserstateMessage; WHISPER: typeof WhisperMessage } = ...

Type declaration

[key: string & Record<never, never>]: typeof IRCMessage
CAP: typeof CapMessage
CLEARCHAT: typeof ClearchatMessage
CLEARMSG: typeof ClearmsgMessage
GLOBALUSERSTATE: typeof GlobaluserstateMessage
HOSTTARGET: typeof HosttargetMessage
JOIN: typeof JoinMessage
NOTICE: typeof NoticeMessage
PART: typeof PartMessage
PING: typeof PingMessage
PONG: typeof PongMessage
PRIVMSG: typeof PrivmsgMessage
RECONNECT: typeof ReconnectMessage
ROOMSTATE: typeof RoomstateMessage
USERNOTICE: typeof UsernoticeMessage
USERSTATE: typeof UserstateMessage
WHISPER: typeof WhisperMessage

Const invisibleSuffix

invisibleSuffix: " 󠀀" = " \u{000e0000}"

Const rateLimitPresets

rateLimitPresets: Record<PresetKeys, RateLimits> = ...

Functions

acknowledgesCapabilities

acknowledgesCapabilities(requestedCapabilities: string[]): Condition

- Defined in lib/operations/request-capabilities.ts:8
Parameters
- requestedCapabilities: string[]
Returns Condition

alwaysFalse

alwaysFalse(message: IRCMessage): boolean

- Defined in lib/await/await-response.ts:8
Parameters
- message: IRCMessage
Returns boolean

alwaysTrue

alwaysTrue(message: IRCMessage): boolean

- Defined in lib/await/await-response.ts:9
Parameters
- message: IRCMessage
Returns boolean

anyCauseInstanceof

anyCauseInstanceof(error: undefined | Error, constructor: any): boolean

- Defined in lib/utils/any-cause-instanceof.ts:10
Parameters
- error: undefined | Error
- constructor: any
Returns boolean

applyReplacement

applyReplacement<S, T, K>(self: S, target: T, key: K, newFn: OverrideFunction<S, T, K>): void

- Defined in lib/utils/apply-function-replacements.ts:11
Type parameters
- S
- T: Record<string, any>
- K: string | number | symbol
Parameters
- self: S
- target: T
- key: K
- newFn: OverrideFunction<S, T, K>
Returns void

applyReplacements

applyReplacements<S, T>(self: S, target: T, replacements: OverrideFunctions<S, T>): void

- Defined in lib/utils/apply-function-replacements.ts:45
Type parameters
- S
- T: Record<string, any>
Parameters
- self: S
- target: T
- replacements: OverrideFunctions<S, T>
Returns void

awaitJoinResponse

awaitJoinResponse(conn: SingleConnection, channelName: string): Promise<JoinMessage>

- Defined in lib/operations/join.ts:20
Parameters
- conn: SingleConnection
- channelName: string
Returns Promise<JoinMessage>

awaitPartResponse

awaitPartResponse(conn: SingleConnection, channelName: string): Promise<PartMessage>

- Defined in lib/operations/part.ts:19
Parameters
- conn: SingleConnection
- channelName: string
Returns Promise<PartMessage>

awaitResponse

awaitResponse(conn: SingleConnection, config: Omit<AwaitConfig, "noResponseAction"> & { noResponseAction: "success" }): Promise<IRCMessage | undefined>
awaitResponse(conn: SingleConnection, config: Omit<AwaitConfig, "noResponseAction"> & { noResponseAction?: "failure" }): Promise<IRCMessage>

- Defined in lib/await/await-response.ts:224
Parameters
- conn: SingleConnection
- config: Omit<AwaitConfig, "noResponseAction"> & { noResponseAction: "success" }
Returns Promise<IRCMessage | undefined>
- Defined in lib/await/await-response.ts:231
Parameters
- conn: SingleConnection
- config: Omit<AwaitConfig, "noResponseAction"> & { noResponseAction?: "failure" }
Returns Promise<IRCMessage>

canSpamFast

canSpamFast(channelName: string, loggedInUsername: string, userStateTracker?: UserStateTracker): FastSpamResult
canSpamFast(channelName: string, loggedInUsername: string, userState: UserState): FastSpamResult

- Defined in lib/mixins/ratelimiters/utils.ts:11
Parameters
- channelName: string
- loggedInUsername: string
- Optional userStateTracker: UserStateTracker
Returns FastSpamResult
- Defined in lib/mixins/ratelimiters/utils.ts:17
Parameters
- channelName: string
- loggedInUsername: string
- userState: UserState
Returns FastSpamResult

causeOf

causeOf(error: Error): Error | undefined

- Defined in lib/utils/any-cause-instanceof.ts:3
Parameters
- error: Error
Returns Error | undefined

colorToHexString

colorToHexString(color: Color): string

- Defined in lib/message/color.ts:15
Make a hexadecimal color string (like e.g. #AABBCC) from a given color object.

Parameters
- color: Color
Returns string

convertToBadges

convertToBadges(value: string): TwitchBadgesList

- Defined in lib/message/parser/tag-values.ts:79
Parameters
- value: string
Returns TwitchBadgesList

convertToBoolean

convertToBoolean(value: string): boolean

- Defined in lib/message/parser/tag-values.ts:64
Parameters
- value: string
Returns boolean

convertToColor

convertToColor(value: string): Color | undefined

- Defined in lib/message/parser/tag-values.ts:68
Parameters
- value: string
Returns Color | undefined

convertToEmoteSets

convertToEmoteSets(value: string): TwitchEmoteSets

- Defined in lib/message/parser/tag-values.ts:90
Parameters
- value: string
Returns TwitchEmoteSets

convertToEmotes

convertToEmotes(value: string, messageText: string): TwitchEmoteList

- Defined in lib/message/parser/tag-values.ts:83
Parameters
- value: string
- messageText: string
Returns TwitchEmoteList

convertToFlags

convertToFlags(value: string, messageText: string): TwitchFlagList

- Defined in lib/message/parser/tag-values.ts:94
Parameters
- value: string
- messageText: string
Returns TwitchFlagList

convertToInt

convertToInt(value: string): number

- Defined in lib/message/parser/tag-values.ts:56
Parameters
- value: string
Returns number

convertToString

convertToString(value: string): string

- Defined in lib/message/parser/tag-values.ts:45
Parameters
- value: string
Returns string

convertToTimestamp

convertToTimestamp(value: string): Date

- Defined in lib/message/parser/tag-values.ts:75
Parameters
- value: string
Returns Date

convertToTrimmedString

convertToTrimmedString(value: string): string

- Defined in lib/message/parser/tag-values.ts:49
Parameters
- value: string
Returns string

correctChannelName

correctChannelName(input: string): string

- Defined in lib/validation/channel.ts:14
Parameters
- input: string
Returns string

decodeValue

decodeValue(value: undefined | string): string | null

- Defined in lib/message/parser/tags.ts:15
Parameters
- value: undefined | string
Returns string | null

deniedAnyCapability

deniedAnyCapability(requestedCapabilities: string[]): Condition

- Defined in lib/operations/request-capabilities.ts:17
Parameters
- requestedCapabilities: string[]
Returns Condition

expandConfig

expandConfig(config?: ClientConfiguration): ExpandedClientConfiguration

- Defined in lib/config/expanded.ts:132
Parameters
- Optional config: ClientConfiguration
Returns ExpandedClientConfiguration

expandRateLimitsConfig

expandRateLimitsConfig(config: undefined | RateLimitsConfig): RateLimits

- Defined in lib/config/expanded.ts:118
Parameters
- config: undefined | RateLimitsConfig
Returns RateLimits

expandTransportConfig

expandTransportConfig(config: undefined | TransportConfiguration): ExpandedTransportConfiguration

- Defined in lib/config/expanded.ts:65
Parameters
- config: undefined | TransportConfiguration
Returns ExpandedTransportConfiguration

extractEventParams

extractEventParams(tags: IRCMessageTags): EventParams

- Defined in lib/message/twitch-types/usernotice.ts:60
Parameters
- tags: IRCMessageTags
Returns EventParams

findAndPushToEnd

findAndPushToEnd<T>(arr: T[], filter: (t: T) => boolean): T | undefined

- Defined in lib/utils/find-and-push-to-end.ts:14
Type parameters
- T
Parameters
- arr: T[]
- filter: (t: T) => boolean
  - - (t: T): boolean
    - Parameters
      - t: T
      Returns boolean
Returns T | undefined

getCamelCasedName

getCamelCasedName(tagKey: string): string

- Defined in lib/message/twitch-types/usernotice.ts:33
Parameters
- tagKey: string
Returns string

getData

getData<V, A>(ircTags: IRCMessageTags, key: string, converter: (value: string, ...converterArgs: A) => V, ...converterArgs: A): V | undefined

- Defined in lib/message/parser/tag-values.ts:32
Type parameters
- V
- A: any[]
Parameters
- ircTags: IRCMessageTags
- key: string
- converter: (value: string, ...converterArgs: A) => V
  - - (value: string, ...converterArgs: A): V
    - Parameters
      - value: string
      - Rest ...converterArgs: A
      Returns V
- Rest ...converterArgs: A
Returns V | undefined

getIRCChannelName

getIRCChannelName(message: Pick<IRCMessage, "ircParameters">, optional?: false): string
getIRCChannelName(message: Pick<IRCMessage, "ircParameters">, optional: true): string | undefined

- Defined in lib/message/irc/channel-irc-message.ts:4
Parameters
- message: Pick<IRCMessage, "ircParameters">
- Optional optional: false
Returns string
- Defined in lib/message/irc/channel-irc-message.ts:8
Parameters
- message: Pick<IRCMessage, "ircParameters">
- optional: true
Returns string | undefined

getParameter

getParameter(message: Pick<IRCMessage, "ircParameters">, idx: number): string

- Defined in lib/message/irc/irc-message.ts:42
Parameters
- message: Pick<IRCMessage, "ircParameters">
- idx: number
Returns string

handleReconnectMessage

handleReconnectMessage(conn: SingleConnection): void

- Defined in lib/functionalities/handle-reconnect-message.ts:10
Parameters
- conn: SingleConnection
Returns void

hasAllStateTags

hasAllStateTags(partialRoomState: Partial<RoomState>): partialRoomState is RoomState

- Defined in lib/message/twitch-types/roomstate.ts:26
Parameters
- partialRoomState: Partial<RoomState>
Returns partialRoomState is RoomState

ignoreErrors

ignoreErrors(): undefined

- Defined in lib/utils/ignore-errors.ts:4
Useful as a catch handler in promises to ignore errors

Returns undefined

isAnonymousUsername

isAnonymousUsername(username: string): boolean

- Defined in lib/utils/is-anonymous-username.ts:3
Parameters
- username: string
Returns boolean

joinAll

joinAll(conn: SingleConnection, channelNames: string[]): Promise<Record<string, Error | undefined>>

- Defined in lib/operations/join-all.ts:6
Parameters
- conn: SingleConnection
- channelNames: string[]
Returns Promise<Record<string, Error | undefined>>

joinChannel

joinChannel(conn: SingleConnection, channelName: string): Promise<JoinMessage | undefined>

- Defined in lib/operations/join.ts:47
Parameters
- conn: SingleConnection
- channelName: string
Returns Promise<JoinMessage | undefined>

joinNothingToDo

joinNothingToDo(conn: SingleConnection, channelName: string): boolean

- Defined in lib/operations/join.ts:38
Parameters
- conn: SingleConnection
- channelName: string
Returns boolean

makeTransport

makeTransport(config: ExpandedTransportConfiguration): Transport

- Defined in lib/client/transport/make-transport.ts:7
Parameters
- config: ExpandedTransportConfiguration
Returns Transport

matchingNotice

matchingNotice(channelName: string, noticeIDs: string[]): (msg: IRCMessage) => boolean

- Defined in lib/await/conditions.ts:4
Parameters
- channelName: string
- noticeIDs: string[]
Returns (msg: IRCMessage) => boolean
- - (msg: IRCMessage): boolean
  - Parameters
    - msg: IRCMessage
    Returns boolean

me

me(conn: SingleConnection, channelName: string, message: string): Promise<UserstateMessage>

- Defined in lib/operations/say.ts:101
Parameters
- conn: SingleConnection
- channelName: string
- message: string
Returns Promise<UserstateMessage>

parseActionAndMessage

parseActionAndMessage(trailingParameter: string): { isAction: boolean; message: string }

- Defined in lib/message/twitch-types/privmsg.ts:17
Parameters
- trailingParameter: string
Returns { isAction: boolean; message: string }
- isAction: boolean
- message: string

parseBadges

parseBadges(badgesSrc: string): TwitchBadgesList

- Defined in lib/message/parser/badges.ts:43
Parameters
- badgesSrc: string
Returns TwitchBadgesList

parseColor

parseColor(colorSrc: string): Color

- Defined in lib/message/parser/color.ts:6
Parameters
- colorSrc: string
Returns Color

parseEmoteSets

parseEmoteSets(emoteSetsSrc: string): TwitchEmoteSets

- Defined in lib/message/parser/emote-sets.ts:3
Parameters
- emoteSetsSrc: string
Returns TwitchEmoteSets

parseEmotes

parseEmotes(messageText: string, emotesSrc: string): TwitchEmoteList

- Defined in lib/message/parser/emotes.ts:6
Parameters
- messageText: string
- emotesSrc: string
Returns TwitchEmoteList

parseFlags

parseFlags(messageText: string, flagsSrc: string): TwitchFlagList

- Defined in lib/message/parser/flags.ts:4
Parameters
- messageText: string
- flagsSrc: string
Returns TwitchFlagList

parseHostedChannelName

parseHostedChannelName(rawHostedChannelName: undefined | string): string | undefined

- Defined in lib/message/twitch-types/hosttarget.ts:6
Parameters
- rawHostedChannelName: undefined | string
Returns string | undefined

parseHosttargetParameter

parseHosttargetParameter(rawParameter: string): { hostedChannelName: string | undefined; viewerCount: number | undefined }

- Defined in lib/message/twitch-types/hosttarget.ts:50
Parameters
- rawParameter: string
Returns { hostedChannelName: string | undefined; viewerCount: number | undefined }
- hostedChannelName: string | undefined
- viewerCount: number | undefined

parseIRCMessage

parseIRCMessage(messageSrc: string): IRCMessage

- Defined in lib/message/parser/irc-message.ts:8
Parameters
- messageSrc: string
Returns IRCMessage

parseIntThrowing

parseIntThrowing(str: undefined | null | string): number

- Defined in lib/message/parser/common.ts:3
Parameters
- str: undefined | null | string
Returns number

parseSingleBadge

parseSingleBadge(badgeSrc: string): TwitchBadge

- Defined in lib/message/parser/badges.ts:5
Parameters
- badgeSrc: string
Returns TwitchBadge

parseTags

parseTags(tagsSrc: undefined | string): IRCMessageTags

- Defined in lib/message/parser/tags.ts:22
Parameters
- tagsSrc: undefined | string
Returns IRCMessageTags

parseTwitchMessage

parseTwitchMessage(messageSrc: string): IRCMessage

- Defined in lib/message/parser/twitch-message.ts:84
Parameters
- messageSrc: string
Returns IRCMessage

parseViewerCount

parseViewerCount(rawViewerCount: undefined | string): number | undefined

- Defined in lib/message/twitch-types/hosttarget.ts:24
Parameters
- rawViewerCount: undefined | string
Returns number | undefined

partChannel

partChannel(conn: SingleConnection, channelName: string): Promise<PartMessage | undefined>

- Defined in lib/operations/part.ts:44
Parameters
- conn: SingleConnection
- channelName: string
Returns Promise<PartMessage | undefined>

partNothingToDo

partNothingToDo(conn: SingleConnection, channelName: string): boolean

- Defined in lib/operations/part.ts:34
Parameters
- conn: SingleConnection
- channelName: string
Returns boolean

reasonForValue

reasonForValue(actualValue: undefined | null | string): string

- Defined in lib/utils/reason-for-value.ts:1
Parameters
- actualValue: undefined | null | string
Returns string

removeCommands

removeCommands(message: string): string

- Defined in lib/operations/say.ts:8
Parameters
- message: string
Returns string

removeInPlace

removeInPlace<T>(arr: T[], element: T): void

- Defined in lib/utils/remove-in-place.ts:1
Type parameters
- T
Parameters
- arr: T[]
- element: T
Returns void

reply

reply(conn: SingleConnection, channelName: string, messageID: string, message: string): Promise<UserstateMessage>

- Defined in lib/operations/say.ts:109
Parameters
- conn: SingleConnection
- channelName: string
- messageID: string
- message: string
Returns Promise<UserstateMessage>

replyToServerPing

replyToServerPing(conn: SingleConnection): void

- Defined in lib/functionalities/reply-to-ping.ts:3
Parameters
- conn: SingleConnection
Returns void

requestCapabilities

requestCapabilities(conn: SingleConnection, requestMembershipCapability: boolean): Promise<void>

- Defined in lib/operations/request-capabilities.ts:26
Parameters
- conn: SingleConnection
- requestMembershipCapability: boolean
Returns Promise<void>

requireData

requireData<V, A>(ircTags: IRCMessageTags, key: string, converter: (value: string, ...converterArgs: A) => undefined | V, ...converterArgs: A): V

- Defined in lib/message/parser/tag-values.ts:14
Type parameters
- V
- A: any[]
Parameters
- ircTags: IRCMessageTags
- key: string
- converter: (value: string, ...converterArgs: A) => undefined | V
  - - (value: string, ...converterArgs: A): undefined | V
    - Parameters
      - value: string
      - Rest ...converterArgs: A
      Returns undefined | V
- Rest ...converterArgs: A
Returns V

requireNickname

requireNickname(message: Pick<IRCMessage, "ircPrefix">): string

- Defined in lib/message/irc/irc-message.ts:60
Parameters
- message: Pick<IRCMessage, "ircPrefix">
Returns string

requireParameter

requireParameter(message: Pick<IRCMessage, "ircParameters">, idx: number): string

- Defined in lib/message/irc/irc-message.ts:49
Parameters
- message: Pick<IRCMessage, "ircParameters">
- idx: number
Returns string

say

say(conn: SingleConnection, channelName: string, messageText: string, replyToID?: string, action?: boolean): Promise<UserstateMessage>

- Defined in lib/operations/say.ts:66
Parameters
- conn: SingleConnection
- channelName: string
- messageText: string
- Optional replyToID: string
- action: boolean = false
Returns Promise<UserstateMessage>

sendClientPings

sendClientPings(conn: SingleConnection, config?: Partial<ClientPingConfig>): void

- Defined in lib/functionalities/send-pings.ts:22
Parameters
- conn: SingleConnection
- config: Partial<ClientPingConfig> = {}
Returns void

sendLogin

sendLogin(conn: SingleConnection, username: string, password?: string): Promise<void>

- Defined in lib/operations/login.ts:9
Parameters
- conn: SingleConnection
- username: string
- Optional password: string
Returns Promise<void>

sendPing

sendPing(conn: SingleConnection, pingIdentifier?: string, timeout?: number): Promise<PongMessage>

- Defined in lib/operations/ping.ts:14
Parameters
- conn: SingleConnection
- pingIdentifier: string = ...
- timeout: number = 2000
Returns Promise<PongMessage>

sendPrivmsg

sendPrivmsg(conn: SingleConnection, channelName: string, message: string, replyTo?: string): Promise<void>

- Defined in lib/operations/privmsg.ts:3
Parameters
- conn: SingleConnection
- channelName: string
- message: string
- Optional replyTo: string
Returns Promise<void>

setDefaults

setDefaults<I, D>(input: undefined | I, defaults: D): I & D

- Defined in lib/utils/set-defaults.ts:1
Type parameters
- I
- D
Parameters
- input: undefined | I
- defaults: D
Returns I & D

splitIntoChunks

splitIntoChunks(bits: string[], separator?: string, limit: number): string[][]

- Defined in lib/utils/split-into-chunks.ts:1
Parameters
- bits: string[]
- separator: string = " "
- limit: number
Returns string[][]

tagParserFor

tagParserFor(ircTags: IRCMessageTags): TagValueParser

- Defined in lib/message/parser/tag-values.ts:123
Parameters
- ircTags: IRCMessageTags
Returns TagValueParser

unionSets

unionSets<T>(sets: Set<T>[]): Set<T>

- Defined in lib/utils/union-sets.ts:1
Type parameters
- T
Parameters
- sets: Set<T>[]
Returns Set<T>

validateChannelName

validateChannelName(input?: null | string): void

- Defined in lib/validation/channel.ts:6
Parameters
- Optional input: null | string
Returns void

validateIRCCommand

validateIRCCommand(command: string): void

- Defined in lib/validation/irc-command.ts:3
Parameters
- command: string
Returns void

validateMessageID

validateMessageID(input?: null | string): void

- Defined in lib/validation/reply.ts:6
Parameters
- Optional input: null | string
Returns void

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AnnouncementUsernoticeMessage

AnonGiftPaidUpgradeParameters

AnonGiftPaidUpgradeUsernoticeMessage

AnonSubgiftParameters

AnonSubgiftUsernoticeMessage

BasicTcpTransportConfiguration

BitsBadgeTierUsernoticeMessage

ClientEvents

Condition

Type declaration

Parameters

message: IRCMessage

Returns boolean

ConnectionPredicate

Type declaration

Parameters

conn: SingleConnection

Returns boolean

CustomRateLimitsConfig

ExpandedClientConfiguration

ExpandedDuplexTransportConfiguration

ExpandedTcpTransportConfiguration

ExpandedTransportConfiguration

ExpandedWebSocketTransportConfiguration

FunctionPropsOf

Type parameters

T: object

GiftPaidUpgradeParameters

GiftPaidUpgradeUsernoticeMessage

MassSubgiftUsernoticeMessage

OverrideFunction

Type parameters

S

T: Record<string, (...args: any) => any>

K: keyof T

Type declaration

Parameters

this: S

oldFn: T[K]

Rest ...args: Parameters<T[K]>

Returns ReturnType<T[K]>

OverrideFunctions

Type parameters

S

T: Record<string, any>

PresetKeys

PrivmsgUserState

RaidUsernoticeMessage

RateLimitsConfig

ResubUsernoticeMessage

RitualUsernoticeMessage

StreakSubParams

SubEventParams

SubUsernoticeMessage

SubgiftUsernoticeMessage

TransportConfiguration

TwitchCommands

TwitchEmoteList

TwitchEmoteSets

TwitchFlagList

TwitchMessageEvents

Variables

Const MAX_OUTGOING_COMMAND_LENGTH

Const MAX_OUTGOING_LINE_LENGTH

Const commandClassMap

Type declaration

[key: string & Record<never, never>]: typeof IRCMessage

CAP: typeof CapMessage

CLEARCHAT: typeof ClearchatMessage

CLEARMSG: typeof ClearmsgMessage

GLOBALUSERSTATE: typeof GlobaluserstateMessage

HOSTTARGET: typeof HosttargetMessage