github twurple/twurple v4.0.0
4.0.0

latest releases: v7.1.0, v7.1.0-pre.9, v7.1.0-pre.8...
4 years ago

Yay, we're publishing changelogs now! This shows all the changes compared to version 3.7.3.

Breaking changes

  • [twitch] Removed TokenInfo#valid. Related methods will now throw instances of InvalidTokenError instead. (09dcc82)
  • [twitch] In order to make the clientId argument optional in TwitchClient.getTokenInfo, its argument order was swapped; its signature now reads: static async getTokenInfo(accessToken: string, clientId?: string) (3a36089)
  • [twitch] Removed async from TwitchClient.withCredentials - if you use await, this should not matter, but if you use .then, you need to remove it (6857c2b)
  • [twitch-chat-client] Removed async from ChatClient.forTwitchClient - see above (1c1d1db)
  • [twitch-chat-client] Removed the reason argument from the onTimeout and onBan events in ChatClient since the reasons are not sent over chat by Twitch anymore (944ee4f)
  • [twitch-chat-client] Swapped the ChatClient#host argument order to make it more consistent with the other methods - the target channel is always the first argument (8a79035)
  • [twitch-pubsub-client] Added scopes to various topics in preparation for upcoming changes on Twitch's side (9ce469d)

Deprecations

  • [twitch-chat-client] ChatClient#waitForRegistration - this method encouraged to write code that executes actions after the initial connect, but if a reconnect was necessary for any reason (e.g. a connection failure), these actions could not be repeated, resulting in, for example, your bot not joining any channels; use the ChatClient#onRegister event instead (616f3fa)
  • [twitch-chat-client] ChatClientOptions#logLevel - use the minLevel option of ChatClientOptions#logger instead (5f713f0)

Features

  • [easy-twitch-bot] New package! This is still a very early version of a more easy-to-use chat client built on the twitch-chat-client foundation (c767c70)
  • [twitch] Added a rate limiter for Helix API requests (6d93524)
  • [twitch-chat-client] Added a way to automatically join channels on connect (fa8b975)
  • [twitch-chat-client] Added a way to pass arbitrary options to the internal logger in ChatClient using ChatClientOptions#logger (5f713f0)
  • [twitch-pubsub-client] Added automatic token refreshing for PubSub (2451f15)

Fixes

  • [twitch-chat-client] Made it possible to not pass options to new ChatClient (903ff4c)
  • [twitch-chat-client] Automatically try reconnecting with a refreshed token when an authentication error occurs (5ac5919)

Internal

  • [all] Moved some utilities into various shared libraries (da11283, 51d918a)
  • [all] Moved ESLint config into shared library (51d918a)
  • [twitch-pubsub-client] Refactored the BasicPubSubClient to use the same internal connection handling as chat (0ef8c37)

Don't miss a new twurple release

NewReleases is sending notifications on new releases.