RouteWebSocket class final

WebSocket route class

Inheritance

• Object
• Route
• RouteWebSocket

Constructors

RouteWebSocket(String name, {required MiddlewareWebSocket? middlewareWebSocket})

Properties

acceptedMethods → List<AcceptedMethods>?

final, inherited

guards → List<MiddlewareNullable>

Middleware guards that run before the route handler.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isDynamic → bool

Whether this route contains dynamic path segments (:param).

late, final, inherited

isHttpRoute → bool

Whether this route handles HTTP requests via middleware.

no setter, inherited

middleware → Middleware?

final, inherited

middlewareWebSocket → MiddlewareWebSocket?

final, inherited

name → String

final, inherited

openApi → OpenApiOperation?

Optional OpenAPI documentation for this operation (OpenAPI 3.x).

final, inherited

pathParameterNames → List<String>

Names of path parameters (without the : prefix), in path order.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

versionCache → int

no setter, inherited

Methods

matchPath(String path) → Map<String, String>?

Tries to match the given path against this route's pattern. Returns the extracted parameters if matched, or null if no match.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onUpdate() → void

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited