# README
go-twitch-irc
See forked for README:
Added support for proxy based net-dial. (socks5)
env
variables
WEBSHARE_API_KEY=<api_key>
set env
export $(grep -v '^#' .env | xargs)
unset env
unset $(grep -v '^#' .env | sed -E 's/(.*)=.*/\1/' | xargs)
# Packages
No description provided by the author
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
ListFromAPI collects the Proxy list and the replacement info.
NewAnonymousClient to create a new client without login requirements (anonymous user) Do note that the Say and Whisper functions will be ineffectual when using this constructor.
NewClient to create a new client.
ParseMessage parse a raw Twitch IRC message.
# Constants
CLEARCHAT timeout messages.
CLEARMSG whenever a single message is deleted.
CommandsCapability for Twitch's Commands capabilities, see https://dev.twitch.tv/docs/irc/commands.
GLOBALUSERSTATE On successful login, provides data about the current logged-in user through IRC tags.
JOIN whenever a user joins a channel.
MembershipCapability for Twitch's Membership capabilities, see https://dev.twitch.tv/docs/irc/membership.
NAMES (or 353 https://www.alien.net.au/irc/irc2numerics.html#353) is the response sent from the server when the client requests a list of names for a channel.
NOTICE messages like sub mode, host on.
PART whenever a user parts from a channel.
PING is a message that can be sent from the IRC server.
PONG is a message that should be sent from the IRC server as a response to us sending a PING message.
PRIVMSG standard chat message.
RECONNECT is sent from Twitch when they request the client to reconnect (i.e.
ROOMSTATE changes like sub mode.
TagsCapability for Twitch's Tags capabilities, see https://dev.twitch.tv/docs/irc/tags.
No description provided by the author
No description provided by the author
UNSET is for message types we currently don't support.
USERNOTICE messages like subs, resubs, raids, etc.
USERSTATE messages.
WHISPER private messages.
# Variables
DefaultCapabilities is the default caps when creating a new Client.
ErrClientDisconnected returned from Connect() when a Disconnect() was called.
ErrConnectionIsNotOpen is returned by Disconnect in case you call it without being connected.
ErrLoginAuthenticationFailed returned from Connect() when either the wrong or a malformed oauth token is used.
ReadBufferSize can be modified to change the read channel buffer size.
WriteBufferSize can be modified to change the write channel buffer size.
# Structs
ClearChatMessage data you receive from CLEARCHAT message type.
ClearMessage data you receive from CLEARMSG message type.
Client client to control your connection and attach callbacks.
Emote twitch emotes.
EmotePosition is a single position of an emote to be used for text replacement.
GlobalUserStateMessage On successful login, provides data about the current logged-in user through IRC tags See https://dev.twitch.tv/docs/irc/tags/#globaluserstate-twitch-tags.
No description provided by the author
NamesMessage describes the data posted in response to a /names command See https://www.alien.net.au/irc/irc2numerics.html#353.
NoticeMessage data you receive from the NOTICE message type.
PingMessage describes an IRC PING message.
PongMessage describes an IRC PONG message.
PrivateMessage data you receive from PRIVMSG message type.
Proxy https://proxy.webshare.io/docs/#the-proxy-list-object.
No description provided by the author
RawMessage data you receive from TMI.
ReconnectMessage describes the.
ReplacementInfo https://proxy.webshare.io/docs/#the-replacement-info-object.
RoomStateMessage data you receive from ROOMSTATE message type.
User data you receive from TMI.
UserJoinMessage desJoines the message that is sent whenever a user joins a channel we're connected to See https://dev.twitch.tv/docs/irc/membership/#join-twitch-membership.
UserNoticeMessage data you receive from USERNOTICE message type.
UserPartMessage describes the message that is sent whenever a user leaves a channel we're connected to See https://dev.twitch.tv/docs/irc/membership/#part-twitch-membership.
UserStateMessage data you receive from the USERSTATE message type.
WhisperMessage data you receive from WHISPER message type.
# Interfaces
Message interface that all messages implement.
# Type aliases
MessageType different message types possible to receive via IRC.