method

ServerWebSocket.close

code?: number,
reason?: string
): void;

Closes the connection.

Close codes:

  • 1000 means "normal closure" (default)
  • 1009 means a message was too big and was rejected
  • 1011 means the server encountered an error
  • 1012 means the server is restarting
  • 1013 means the server is too busy or the client is rate-limited
  • 3000 through 3999 are reserved for libraries and frameworks
  • 4000 through 4999 are reserved for applications

0, 1005 and 1006 send a Close frame with no code, so you can forward the code from a close handler unchanged.

To close the connection abruptly, use terminate().

@param code

The close code to send

@param reason

The close reason to send. Truncated to 123 bytes of UTF-8, at a character boundary.