Skip to content

Commit 813e9e9

Browse files
authored
docs: add sendFragment (#1218)
1 parent 891cb0b commit 813e9e9

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

‎docs/index.d.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,21 @@ export interface WebSocket<UserData> {
106106

107107
/** Returns the UserData object. */
108108
getUserData() : UserData;
109+
110+
/** Sends the first fragment of a fragmented message. Use for sending large messages in chunks.
111+
* Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure.
112+
*/
113+
sendFirstFragment(message: RecognizedString, isBinary?: boolean, compress?: boolean) : number;
114+
115+
/** Sends a middle fragment of a fragmented message.
116+
* Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure.
117+
*/
118+
sendFragment(message: RecognizedString, compress?: boolean) : number;
119+
120+
/** Sends the last fragment of a fragmented message.
121+
* Returns 1 for success, 2 for dropped due to backpressure limit, and 0 for built up backpressure.
122+
*/
123+
sendLastFragment(message: RecognizedString, compress?: boolean) : number;
109124
}
110125

111126
/** An HttpResponse is valid until either onAborted callback or any of the .end/.tryEnd calls succeed. You may attach user data to this object. */

0 commit comments

Comments
 (0)