closeOnBackpressureLimit option type

[anuj-kr-jha]

Hi there,

First of all, I just wanted to say how much I appreciate the uWebSocket.js library. It's been incredibly helpful in building high-performance WebSocket applications, and the documentation and community support have been fantastic. Thank you for all the hard work you've put into this project _/\_ !

I'm using uWebSocket.js in my project and I have a question about one of the options that can be passed when creating the app.

In the WebSocketBehavior interface, there's an option called closeOnBackpressureLimit:

interface WebSocketBehavior<UserData> {
    // ....
    /** Whether or not we should automatically close the socket when a message is dropped due to backpressure. Defaults to false. */
    closeOnBackpressureLimit?: number;
    // ...
}

The comment suggests that this option is a boolean indicating whether or not the socket should be automatically closed when a message is dropped due to backpressure, with a default value of false.

However, the type of closeOnBackpressureLimit is specified as number instead of boolean.

So my question is: How should I interpret and use this option?

• Should I pass 0 to represent false and any number >=1 to represent true?
• Or does the number actually represent a limit or threshold for when the socket should be closed due to backpressure. b/w we also have maxBackpressure that represent whats the max value of sum of all message in backpressure queue in bytes ?

I'd appreciate if someone could clarify the intended usage and meaning of this option.

Thanks in advance for your help <3 !

[uNetworkingAB]

This was recently fixed in documentation, for now you can pass 1 for true 0 for false