UpgradeWebSocketOptions class

Options which can be set when performing a {@linkcode Deno.upgradeWebSocket} upgrade of a {@linkcode Request}

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

UpgradeWebSocketOptions.new({String? protocol, num? idleTimeout})
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
idleTimeout ↔ num?

Available on UpgradeWebSocketOptions, provided by the UpgradeWebSocketOptions$Typings extension

If the client does not respond to this frame with a pong within the timeout specified, the connection is deemed unhealthy and is closed. The close and error event will be emitted.
getter/setter pair
protocol ↔ String?

Available on UpgradeWebSocketOptions, provided by the UpgradeWebSocketOptions$Typings extension

Sets the .protocol property on the client side web socket to the value provided here, which should be one of the strings specified in the protocols parameter when requesting the web socket. This is intended for clients and servers to specify sub-protocols to use to communicate to each other.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited