Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/Streamerbot/client
/ functions
Functions
84 in github.com/Streamerbot/client
⨍
Functions
84
◇
Types & classes
5
↓ 24 callers
Method
debug
(...args: any[])
packages/client/src/utils/logger.ts:38
↓ 24 callers
Method
warn
(...args: any[])
packages/client/src/utils/logger.ts:46
↓ 8 callers
Method
disconnect
* Disconnect Streamer.bot WebSocket
packages/client/src/ws/StreamerbotClient.ts:240
↓ 7 callers
Method
error
(...args: any[])
packages/client/src/utils/logger.ts:50
↓ 6 callers
Method
on
* Helper method to handle custom event subscriptions * * This method allows you to subscribe to a specific event, source, or all events * and
packages/client/src/ws/StreamerbotClient.ts:612
↓ 5 callers
Method
log
(level: LogLevel, ...args: any[])
packages/client/src/utils/logger.ts:54
↓ 4 callers
Method
connect
* Connect to a Streamer.bot WebSocket server
packages/client/src/ws/StreamerbotClient.ts:182
↓ 4 callers
Method
subscribe
* Subscribe to events from your connected Streamer.bot instance
packages/client/src/ws/StreamerbotClient.ts:773
↓ 4 callers
Method
verbose
(...args: any[])
packages/client/src/utils/logger.ts:34
↓ 4 callers
Function
withTimeout
( promise: Promise<T>, options: { timeout: number; message?: string; controller: AbortController; signal?:
packages/client/src/ws/util/websocket.util.ts:42
↓ 3 callers
Function
disconnect
()
packages/vue/src/composables/useStreamerbot.ts:67
↓ 3 callers
Method
getActions
* Get all actions from your connected Streamer.bot instance
packages/client/src/ws/StreamerbotClient.ts:862
↓ 3 callers
Method
getSupportedEvents
* Get the supported events from the Streamer.bot instance. * * @returns The GetEvents method response from the connected instance.
packages/client/src/ws/StreamerbotClient.ts:665
↓ 3 callers
Method
info
(...args: any[])
packages/client/src/utils/logger.ts:42
↓ 3 callers
Method
onError
(event: Event)
packages/client/src/ws/StreamerbotClient.ts:497
↓ 2 callers
Function
_init
(immediate: boolean = false)
packages/vue/src/composables/useStreamerbot.ts:94
↓ 2 callers
Method
cleanup
()
packages/client/src/ws/StreamerbotClient.ts:509
↓ 2 callers
Method
doAction
* Get all actions from your connected Streamer.bot instance
packages/client/src/ws/StreamerbotClient.ts:871
↓ 2 callers
Method
executeCodeTrigger
* Execute a custom code trigger
packages/client/src/ws/StreamerbotClient.ts:1012
↓ 2 callers
Function
fetch
()
packages/vue/src/composables/useGlobalVariable.ts:47
↓ 2 callers
Function
generateId
(prefix: 'req' | 'res' = 'req')
packages/client/src/ws/util/websocket.util.ts:3
↓ 2 callers
Method
getInfo
* Get information about the connected Streamer.bot instance
packages/client/src/ws/StreamerbotClient.ts:994
↓ 2 callers
Method
getSubscriptionsFromEventStrings
* Parse an array of event strings and return a structured subscription object * * @param events - An array of event strings to parse, e.g. ['Twi
packages/client/src/ws/StreamerbotClient.ts:709
↓ 2 callers
Method
getSubscriptionsFromListeners
* Parse the configured listeners and return a subscription object * * @param listeners - Optional array of listeners to parse. If not provided,
packages/client/src/ws/StreamerbotClient.ts:698
↓ 2 callers
Method
request
* Make a request to the Streamer.bot WebSocket, * wait for the response, and return the response data
packages/client/src/ws/StreamerbotClient.ts:534
↓ 2 callers
Function
sha256base64
(message: string)
packages/client/src/ws/util/websocket.util.ts:73
↓ 2 callers
Method
updateSupportedEvents
* Update the supported events from the Streamer.bot instance. * * This will ensure the client has an accurate list of events * which can be s
packages/client/src/ws/StreamerbotClient.ts:644
↓ 2 callers
Function
withCustomEventResponse
({ timeout = 10_000, addEventListener, removeEventListener }: { timeout?: number; addEventListener:
packages/client/src/ws/util/websocket.util.ts:103
↓ 1 callers
Method
authenticate
(data: StreamerbotHelloRequest)
packages/client/src/ws/StreamerbotClient.ts:320
↓ 1 callers
Method
doActionWithCustomEventResponse
* Executes an action and waits for a matching Custom event response * * @param action The action ID or object with ID/name to execute * @para
packages/client/src/ws/StreamerbotClient.ts:907
↓ 1 callers
Method
executeCodeTriggerWithCustomEventResponse
* Executes a code trigger and waits for a matching Custom event response * * @param triggerName The name of the code trigger to execute * @pa
packages/client/src/ws/StreamerbotClient.ts:1036
↓ 1 callers
Function
fetchAvatar
(username: string = '')
apps/toolkit/src/stores/streamerbot.store.ts:90
↓ 1 callers
Function
fetchGlobal
()
examples/nodejs/index.js:63
↓ 1 callers
Method
getActiveViewers
* Returns all active viewers and their user information
packages/client/src/ws/StreamerbotClient.ts:1003
↓ 1 callers
Method
getBroadcaster
* Get the current broadcaster account information
packages/client/src/ws/StreamerbotClient.ts:947
↓ 1 callers
Function
getCloseEventReason
(event: CloseEvent)
packages/client/src/ws/util/websocket.util.ts:7
↓ 1 callers
Method
getEvents
* Get all possible events that may be subscribed to
packages/client/src/ws/StreamerbotClient.ts:853
↓ 1 callers
Method
getEventsFromListeners
* Extract events from the configured listeners * * @param listeners - Optional array of listeners to extract events from. If not provided, it us
packages/client/src/ws/StreamerbotClient.ts:680
↓ 1 callers
Method
getGlobal
* Get a global variable by name * * @version 0.2.5 * @param name The name of the global variable to fetch * @param persisted Whether the g
packages/client/src/ws/StreamerbotClient.ts:1132
↓ 1 callers
Method
handshake
()
packages/client/src/ws/StreamerbotClient.ts:269
↓ 1 callers
Function
hexToBase64
(hexString: string)
packages/client/src/ws/util/websocket.util.ts:83
↓ 1 callers
Function
loadFonts
()
apps/toolkit/src/plugins/webfontloader.ts:7
↓ 1 callers
Method
parseEventString
* Parse a string event subscription into a structured object * * @param event - The event string to parse, e.g. 'Twitch.ChatMessage', 'YouTube.*
packages/client/src/ws/StreamerbotClient.ts:736
↓ 1 callers
Method
send
* Send a raw object to the Streamer.bot WebSocket
packages/client/src/ws/StreamerbotClient.ts:526
↓ 1 callers
Method
setLevel
(level: LogLevel)
packages/client/src/utils/logger.ts:26
↓ 1 callers
Function
testCustomCodeTrigger
()
examples/nodejs/index.js:79
↓ 1 callers
Function
testDoAction
()
examples/nodejs/index.js:71
↓ 1 callers
Function
useStreamerbot
(options: UseStreamerbotOptions)
packages/vue/src/composables/useStreamerbot.ts:21
Method
authenticated
* Check if the WebSocket connection is authenticated
packages/client/src/ws/StreamerbotClient.ts:160
Method
clearCredits
* Reset credits data
packages/client/src/ws/StreamerbotClient.ts:985
Function
clearLogs
(options: { type?: string } = {})
apps/toolkit/src/stores/streamerbot.store.ts:100
Function
connect
()
packages/vue/src/composables/useStreamerbot.ts:57
Method
constructor
(options: Partial<LoggerOptions> = {})
packages/client/src/utils/logger.ts:21
Method
constructor
(options: Partial<StreamerbotClientOptions> = DefaultStreamerbotClientOptions)
packages/client/src/ws/StreamerbotClient.ts:143
Function
fetchActions
()
apps/toolkit/src/stores/streamerbot.store.ts:82
Function
fetchActiveViewers
()
apps/toolkit/src/stores/streamerbot.store.ts:86
Function
get
(target: StreamerbotClient, prop: string, receiver: any)
packages/vue/src/composables/useStreamerbot.ts:79
Method
getCodeTriggers
* Get all custom code triggers
packages/client/src/ws/StreamerbotClient.ts:1076
Method
getCommands
* Get commands for the connected Streamer.bot instance * * @version 0.2.5
packages/client/src/ws/StreamerbotClient.ts:1087
Method
getCredits
* Get the current credits payload
packages/client/src/ws/StreamerbotClient.ts:967
Method
getEmotes
* Get emotes for the selected platform * * @version 0.2.5
packages/client/src/ws/StreamerbotClient.ts:1098
Method
getGlobals
* Get all global variables * * @version 0.2.5
packages/client/src/ws/StreamerbotClient.ts:1118
Method
getMonitoredYouTubeBroadcasts
* Get all monitored YouTube broadcasts * * @version 0.2.5
packages/client/src/ws/StreamerbotClient.ts:958
Method
getUserGlobal
* Get user global variables * * @version 0.2.5 * @param platform The platform to fetch globals for (twitch, youtube, trovo) * @param userI
packages/client/src/ws/StreamerbotClient.ts:1194
Method
getUserGlobals
* Get user global variables * * @version 0.2.5 * @param platform The platform to fetch globals for (twitch, youtube, trovo) * @param name
packages/client/src/ws/StreamerbotClient.ts:1160
Method
getUserPronouns
* Retrieves the pronouns of a user from the specified platform. * * @param platform - The platform from which to retrieve the user's pronouns.
packages/client/src/ws/StreamerbotClient.ts:1291
Function
handleCustomEvent
(eventData: any)
packages/client/src/ws/util/websocket.util.ts:123
Function
install
(app)
packages/vue/src/index.ts:5
Method
onClose
(event: CloseEvent)
packages/client/src/ws/StreamerbotClient.ts:409
Function
onConnect
(data: StreamerbotInfo)
packages/vue/src/composables/useStreamerbot.ts:31
Function
onConnect
(data: StreamerbotInfo)
apps/toolkit/src/stores/streamerbot.store.ts:65
Function
onData
(payload: any)
packages/vue/src/composables/useStreamerbot.ts:51
Function
onDisconnect
()
packages/vue/src/composables/useStreamerbot.ts:38
Function
onError
(err: Error)
packages/vue/src/composables/useStreamerbot.ts:44
Method
onMessage
(event: MessageEvent)
packages/client/src/ws/StreamerbotClient.ts:449
Method
onOpen
()
packages/client/src/ws/StreamerbotClient.ts:361
Method
ready
* Check if the WebSocket connection is fully ready to make requests * * - Socket connection is open * - If authentication is enabled, it chec
packages/client/src/ws/StreamerbotClient.ts:173
Method
sendMessage
* Send chat messages * * Authenticated WebSocket is required * * @version 0.2.5 * @param platform The platform to send the message to
packages/client/src/ws/StreamerbotClient.ts:1243
Method
setCustomLogger
(logger: (level: LogLevel, ...args: any[]) => void)
packages/client/src/utils/logger.ts:30
Method
testCredits
* Test credits by populating with fake data
packages/client/src/ws/StreamerbotClient.ts:976
Method
unsubscribe
* Unsubscribe from events you are currently subscribed to
packages/client/src/ws/StreamerbotClient.ts:814
Function
useGlobalVariable
( name: string, options: MaybeRefOrGetter<Partial<UseGlobalVariableOptions>> = {} )
packages/vue/src/composables/useGlobalVariable.ts:9
Function
useLinks
(page: Ref<any> = null)
apps/docs/app/composables/useLinks.ts:1
Function
useSeo
(page: Ref<ParsedContent>, options: OgImageOptions = defaultOptions)
apps/docs/app/composables/useSeo.ts:15