The main extension entry interface, available as the global
This class handles environment detection, data harness collection and updates (for authentication and backend communication) and SDK instance creation.
On import or inclusion in an HTML file, a singleton object will be globally accessible
Returns a version of the Muxy SDK associated with the provided identifier.
Makes trivia state enum available from the global
Debugging options. Should only be set by a call to .debug()
A flag used to signal when setup has been called. This function must be called once and only once before SDK objects may be created.
The Twitch Channel ID to use for testing. This will determine who the viewer and/or broadcaster appears as when testing the extension.
Changes to this value must be made before calling SDK.
The Twitch ClientID as returned from the auth callback. This is used for all requests to Twitch's API.
Returns a twitch client to use. Can only be used after the loaded promise resolves.
An instance of the TwitchClient class.
Setup debugging options for the application. This allows the application to fake what user they are running as, the channel the extension is running on, pubsub debug message frequency, and even the backend URL that the extension uses.
This should be called before setup().
an instance of DebuggingOptions
Mandatory SDK setup call. Must be called once and only once to establish the Extension environment and client ID to use.
Prints to console a description of the library's current version and
environment info. This is called automatically when the library is
setup, unless the
quiet parameter is passed to setup.
Generated using TypeDoc