elgatosf / streamdeck-javascript-sdk

A library for plugins used for connecting to Stream Deck.
119 stars 17 forks source link

Errors in API documentation #6

Closed bjanders closed 11 months ago

bjanders commented 1 year ago

This is not the correct project to report in, but I don't know in which one I should report API documentation errors.

On https://developer.elgato.com/documentation/stream-deck/sdk/registration-procedure/ there's the example (it two places):

websocket.onopen = function()
{
  // WebSocket is connected, register the plugin
  {
    "event": inRegisterEvent,
    "uuid": inPluginUUID
  }

  websocket.send(JSON.stringify(json));
}

This is missing var json =, i.e., it should be:

websocket.onopen = function()
{
  // WebSocket is connected, register the plugin
  var json = {
    "event": inRegisterEvent,
    "uuid": inPluginUUID
  }

  websocket.send(JSON.stringify(json));
}
ninjadev64 commented 11 months ago

This has since been fixed, you may want to close the issue