You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description
I noticed a potential issue in the documentation regarding the parameter notation in the code comments. For example, the notation [options[].processInitialData=true] seems unusual, and I'm not sure if it's correct. Typically, options parameters are documented without the array notation when describing properties of an object.
* @param {boolean} [options[].processInitialData=true] Process the initital data which includes messages of the last minutes
* @param {boolean} [options[].fetchRoomInfoOnConnect=true] Fetch the room info (room status, streamer info, etc.) on connect (will be returned when calling connect())
* @param {boolean} [options[].enableExtendedGiftInfo=false] Enable this option to get extended information on 'gift' events like gift name and cost
* @param {boolean} [options[].enableWebsocketUpgrade=true] Use WebSocket instead of request polling if TikTok offers it
* @param {boolean} [options[].enableRequestPolling=true] Use request polling if no WebSocket upgrade is offered. If `false` an exception will be thrown if TikTok does not offer a WebSocket upgrade.
* @param {number} [options[].requestPollingIntervalMs=1000] Request polling interval if WebSocket is not used
* @param {string} [options[].sessionId=null] The session ID from the "sessionid" cookie is required if you want to send automated messages in the chat.
* @param {object} [options[].clientParams={}] Custom client params for Webcast API
* @param {object} [options[].requestHeaders={}] Custom request headers for axios
* @param {object} [options[].websocketHeaders={}] Custom request headers for websocket.client
* @param {object} [options[].requestOptions={}] Custom request options for axios. Here you can specify an `httpsAgent` to use a proxy and a `timeout` value for example.
* @param {object} [options[].websocketOptions={}] Custom request options for websocket.client. Here you can specify an `agent` to use a proxy and a `timeout` value for example.
*/
The text was updated successfully, but these errors were encountered:
Description
I noticed a potential issue in the documentation regarding the parameter notation in the code comments. For example, the notation
[options[].processInitialData=true]
seems unusual, and I'm not sure if it's correct. Typically, options parameters are documented without the array notation when describing properties of an object.Code Snippet
TikTok-Live-Connector/src/index.js
Lines 63 to 79 in f31c7de
The text was updated successfully, but these errors were encountered: