37 results found
-
1 vote
-
Fix TMI JS example with Promise handling https://dev.twitch.tv/docs/irc#overview
Row:
client.connect();Should be replaced with:
client.connect().catch((err) => {console.log('Connection error!', err)});
or smth like that.Let's show users how to write good code, and show them, that all Promises should be handled. Unhandled promise rejections is bad!
Tmi.js Library also have connect example which contain promise handling
6 votes -
Allow 'Continue' or 'Next Page' on Tutorial The tutorials just leave you at the end of a page with no 'Continue' or 'Next Step' button. It 's not obvious if I'm at the end of the tutorial or not.
1 vote -
Modify Channel Information says "Query parameters" example post says JSON blob https://dev.twitch.tv/docs/api/reference#modify-channel-information
The example calls uses JSON, but the documentation talks about Query String/URL encoded form.
Docs should cover both possibilities and examples should cover both methods
2 votes -
Embed documentation doesn't mention the SSL requirment https://dev.twitch.tv/docs/embed/ and it's child pages mention the requirements for parent but never SSL
2 votes -
Missing docs on OAuth for initial step by step guide The step by step guide does not reference OAuth tokens yet they are required to do an API request, please update the guide to include info on this.
1 vote -
The Validate requests endpoint omits the expiry from the example response URL
https://dev.twitch.tv/docs/authentication#validating-requests
{
"clientid": "<your client ID>",
"login": "<authorized user login>",
"scopes": [
"<requested scopes>"
],
"userid": "<authorized user ID>"
}should be
{
"clientid": "<your client ID>",
"login": "<authorized user login>",
"scopes": [
"<requested scopes>"
],
"userid": "<authorized user ID>",
"expires_in": timeInSeconds
}3 votes -
Change description of broadcaster_id in create clip The description of the broadcaster_id inside of the Create Clip endpoint is very confusing because it states that this is the id of the stream but it really is the id of the broadcaster as the name suggests.
2 votes -
HTTP Response codes unclear From: https://github.com/twitchdev/issues/issues/69
Brief descriptionSome endpoints return a 204 code no content.
But this is only highlighted in the example responses and not in the "main documentation"For example
https://dev.twitch.tv/docs/extensions/reference#send-extension-pubsub-message
https://dev.twitch.tv/docs/extensions/reference#send-extension-chat-messageEach endpoint documented could be extended to include usual HTTP response codes.
Expected documentation
The expected response code for success when theres no body response
Common non 2xx codes for the endpoints3 votes -
Webhooks (Un)Subscribe Parameters From: https://github.com/twitchdev/issues/issues/14
Brief description
https://dev.twitch.tv/docs/api/webhooks-reference
the
hub.topicsection is out of date, in the JSON Body ParametersExpected documentation
Just changed it to something like "refer to later in this docs for the available topics"
3 votes -
Wording on refreshing a token is confusing https://dev.twitch.tv/docs/authentication#refreshing-access-tokens
"
How to Refresh
To refresh a token, you need an access token/refresh token pair coming from a body. For example:
"You need only the "refresh token" and "client secret"
You can lose the access token, and still get a new token if you have a refresh_token
2 votes -
Helper: viewer is misleading as the viewer object is populated on all views not just the channel page https://dev.twitch.tv/docs/extensions/reference#helper-viewer
The Twitch.ext.viewer object is a collection of info about the twitch viewer that is watching the channel page where your extension is activated. It will only be populated if the viewer is logged in, and only after the `onAuthorized` callback has been called. Accessing its properties will otherwise return `null`.Should be
The Twitch.ext.viewer object is a collection of info about the twitch user that is watching the extension view.Or something, as the
viewerhelper object exists on all views!2 votes -
Get Broadcaster Subscriptions docs example incomplete The Get Broadcast Subscriptions docs https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions was updated to include gifterid and giftername fields, but neither of these were added to the example.
Also, the example is erroneous because it shows the same user id for both broadcaster and subscriber, but they represent different usernames, which is impossible.
2 votes -
Link to locustfile for load testing extensions not working The formatting of the link to the locustfile in https://dev.twitch.tv/docs/extensions/load-testing-extensions#run-your-locust-test is not working because there are code tags in front of and after:
1 vote -
Helper: Actions - don't work in the rig From: https://github.com/twitchdev/issues/issues/56
Brief description
Documentation describes that there are functions such as
followChannelandrequestIdSharebut the documentation doesn't mention that these functions don't work in the rig (at time of writing)https://dev.twitch.tv/docs/extensions/reference#helper-actions
Additional context or questions
https://discordapp.com/channels/504015559252377601/523676096277905419/676767529666084864
2 votes -
onPositionChanged still in docs From: https://github.com/twitchdev/issues/issues/36
Brief description
https://dev.twitch.tv/docs/extensions/reference#helper-extensions
The JS helper/callback function
onPositionChangedis still documented but is no longer relevant post video component redesignExpected documentation
Section Should be removed
2 votes -
How to link out on a mobile extension Twitch documentation does not state how to handle opening a new window on a mobile extension.
2 votes
- Don't see your idea?