uWebSockets.js

https://unetworking.github.io/uWebSockets.js/generated/
Admin
uWebSockets.js is a high-performance WebSocket and HTTP server library for Node.js with support for...
Tokens:9,160
Snippets:102
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### listen

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Starts the server on a specified port or host.

```APIDOC
## listen(host: RecognizedString, port: number, options?: ListenOptions, cb: Function)

### Description
Listens to a hostname and port, optionally with ListenOptions. The callback receives the listen socket or false.

### Parameters
- **host** (RecognizedString) - Optional - The hostname to bind to.
- **port** (number) - Required - The port to listen on.
- **options** (ListenOptions) - Optional - Configuration options for the listener.
- **cb** (Function) - Required - Callback function (listenSocket: false | us_listen_socket) => void | Promise<void>.

### Returns
- **TemplatedApp**
```

--------------------------------

### get

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers an HTTP GET handler.

```APIDOC
## get(pattern: RecognizedString, handler: Function)

### Description
Registers an HTTP GET handler matching the specified URL pattern.

### Parameters
- **pattern** (RecognizedString) - Required - The URL pattern to match.
- **handler** (Function) - Required - The callback function (res: HttpResponse, req: HttpRequest) => void | Promise<void>.

### Returns
- **TemplatedApp**
```

--------------------------------

### AppOptions Interface

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/AppOptions.html

Configuration options for SSLApp initialization.

```APIDOC
## Interface AppOptions

### Description
Options used when constructing an app, specifically for SSLApp. These options are passed directly to the underlying uSockets C layer.

### Properties
- **ca_file_name** (RecognizedString) - Optional - Path to the CA certificate file.
- **cert_file_name** (RecognizedString) - Optional - Path to the certificate file.
- **dh_params_file_name** (RecognizedString) - Optional - Path to the DH parameters file.
- **key_file_name** (RecognizedString) - Optional - Path to the private key file.
- **passphrase** (RecognizedString) - Optional - Passphrase for the SSL key.
- **ssl_ciphers** (RecognizedString) - Optional - SSL ciphers to use.
- **ssl_prefer_low_memory_usage** (boolean) - Optional - If true, translates to SSL_MODE_RELEASE_BUFFERS.
```

--------------------------------

### any

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers an HTTP handler for any method.

```APIDOC
## any(pattern: RecognizedString, handler: Function)

### Description
Registers an HTTP handler matching the specified URL pattern on any HTTP method.

### Parameters
- **pattern** (RecognizedString) - Required - The URL pattern to match.
- **handler** (Function) - Required - The callback function (res: HttpResponse, req: HttpRequest) => void | Promise<void>.

### Returns
- **TemplatedApp**
```

--------------------------------

### SSLApp(options: AppOptions): TemplatedApp

Source: https://unetworking.github.io/uWebSockets.js/generated/functions/SSLApp.html

Constructs an SSL app. See App for further details on the returned TemplatedApp instance.

```APIDOC
## SSLApp(options: AppOptions)

### Description
Constructs an SSL-enabled application instance. This function initializes the application with the provided SSL configuration options.

### Parameters
- **options** (AppOptions) - Required - Configuration options for the SSL application.

### Returns
- **TemplatedApp** - An instance of the application configured for SSL.
```

--------------------------------

### addServerName

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Adds a server name with specific options.

```APIDOC
## addServerName(hostname: string, options: AppOptions)

### Description
Adds a server name to the application configuration.

### Parameters
- **hostname** (string) - Required - The hostname to add.
- **options** (AppOptions) - Required - Configuration options for the server name.

### Returns
- **TemplatedApp**
```

--------------------------------

### cork(cb: () => void)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Executes a function while the socket is corked to optimize syscalls.

```APIDOC
## cork(cb: () => void)

### Description
Takes a function in which the socket is corked (packing many sends into one single syscall/SSL block).

### Parameters
- **cb** (function) - Required - The callback function to execute while corked.

### Returns
- **WebSocket<UserData>**
```

--------------------------------

### App(options?: AppOptions): TemplatedApp

Source: https://unetworking.github.io/uWebSockets.js/generated/functions/App.html

Constructs a non-SSL application instance used to define routes and manage server behavior.

```APIDOC
## App(options?: AppOptions)

### Description
Constructs a non-SSL app. An app is your starting point where you attach behavior to URL routes. This is also where you listen and run your app, set any SSL options (in case of SSLApp) and the like.

### Parameters
#### Options
- **options** (AppOptions) - Optional - Configuration options for the application.

### Returns
- **TemplatedApp** - The constructed application instance.
```

--------------------------------

### options(pattern, handler)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers an HTTP OPTIONS handler matching the specified URL pattern.

```APIDOC
### options(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>)

Registers an HTTP OPTIONS handler matching the specified URL pattern.

#### Parameters
- **pattern** (RecognizedString) - Required - URL pattern to match.
- **handler** ((res: HttpResponse, req: HttpRequest) => void | Promise<void>) - Required - Request handler function.

#### Returns
- **TemplatedApp**
```

--------------------------------

### missingServerName(cb: (hostname: string) => void)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers a synchronous callback on missing server names.

```APIDOC
### missingServerName(cb: (hostname: string) => void)

Registers a synchronous callback on missing server names.

#### Parameters
- **cb** ((hostname: string) => void) - Required - Callback function triggered when a server name is missing.

#### Returns
- **TemplatedApp**
```

--------------------------------

### TemplatedApp Methods

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

The TemplatedApp interface provides methods for routing, server management, and WebSocket communication.

```APIDOC
## TemplatedApp Methods

### Description
Methods available on the TemplatedApp interface for configuring and running the application.

### Methods
- **addChildAppDescriptor(descriptor: AppDescriptor): void** - Adds a child app descriptor.
- **addServerName(hostname: string, options: AppOptions): TemplatedApp** - Adds a server name for SNI.
- **any(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a handler for any HTTP method.
- **close(): TemplatedApp** - Closes the application.
- **connect(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a CONNECT handler.
- **del(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a DELETE handler.
- **domain(domain: string): TemplatedApp** - Sets the current domain.
- **filter(cb: (res: HttpResponse, count: Number) => void | Promise<void>): TemplatedApp** - Sets a filter callback.
- **get(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a GET handler.
- **getDescriptor(): AppDescriptor** - Returns the app descriptor.
- **head(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a HEAD handler.
- **listen(host: RecognizedString, port: number, cb: (listenSocket: false | us_listen_socket) => void | Promise<void>): TemplatedApp** - Starts the server on a specific host and port.
- **listen_unix(cb: (listenSocket: us_listen_socket) => void | Promise<void>, path: RecognizedString): TemplatedApp** - Starts the server on a Unix domain socket.
- **options(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers an OPTIONS handler.
- **patch(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a PATCH handler.
- **post(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a POST handler.
- **publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean** - Publishes a message to a topic.
- **put(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a PUT handler.
- **trace(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>): TemplatedApp** - Registers a TRACE handler.
- **ws<UserData>(pattern: RecognizedString, behavior: WebSocketBehavior<UserData>): TemplatedApp** - Registers a WebSocket route.
```

--------------------------------

### publish(topic, message, isBinary, compress)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Publishes a message under a topic for all WebSockets under this app.

```APIDOC
### publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean)

Publishes a message under a topic for all WebSockets under this app.

#### Parameters
- **topic** (RecognizedString) - Required - The topic to publish to.
- **message** (RecognizedString) - Required - The message content.
- **isBinary** (boolean) - Optional - Whether the message is binary.
- **compress** (boolean) - Optional - Whether to compress the message.

#### Returns
- **boolean**
```

--------------------------------

### upgrade

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Upgrades a HttpResponse to a WebSocket.

```APIDOC
## upgrade<UserData>(userData, secWebSocketKey, secWebSocketProtocol, secWebSocketExtensions, context)

### Description
Upgrades a HttpResponse to a WebSocket. See UpgradeAsync, UpgradeSync example files.

### Parameters
- **userData** (UserData) - Required
- **secWebSocketKey** (RecognizedString) - Required
- **secWebSocketProtocol** (RecognizedString) - Required
- **secWebSocketExtensions** (RecognizedString) - Required
- **context** (us_socket_context_t) - Required
```

--------------------------------

### tryEnd

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Ends the response by streaming appropriately sized chunks of body.

```APIDOC
## tryEnd(fullBodyOrChunk: RecognizedString, totalSize: number)

### Description
Ends this response, or tries to, by streaming appropriately sized chunks of body. Use in conjunction with onWritable.

### Parameters
- **fullBodyOrChunk** (RecognizedString) - Required
- **totalSize** (number) - Required

### Returns
- **[boolean, boolean]** - Tuple [ok, hasResponded]
```

--------------------------------

### ws(pattern, behavior)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers a handler matching the specified URL pattern where WebSocket upgrade requests are caught.

```APIDOC
### ws<UserData>(pattern: RecognizedString, behavior: WebSocketBehavior<UserData>)

Registers a handler matching the specified URL pattern where WebSocket upgrade requests are caught.

#### Parameters
- **pattern** (RecognizedString) - Required - URL pattern to match.
- **behavior** (WebSocketBehavior<UserData>) - Required - WebSocket behavior configuration.

#### Returns
- **TemplatedApp**
```

--------------------------------

### resume

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Resumes HTTP request body streaming.

```APIDOC
## resume()

### Description
Resume HTTP request body streaming (unthrottle).
```

--------------------------------

### post(pattern, handler)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers an HTTP POST handler matching the specified URL pattern.

```APIDOC
### post(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>)

Registers an HTTP POST handler matching the specified URL pattern.

#### Parameters
- **pattern** (RecognizedString) - Required - URL pattern to match.
- **handler** ((res: HttpResponse, req: HttpRequest) => void | Promise<void>) - Required - Request handler function.

#### Returns
- **TemplatedApp**
```

--------------------------------

### getBufferedAmount()

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Returns the amount of data currently buffered in backpressure.

```APIDOC
## getBufferedAmount()

### Description
Returns the bytes buffered in backpressure.

### Returns
- **number**
```

--------------------------------

### sendFirstFragment(message: RecognizedString, isBinary?: boolean, compress?: boolean)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Sends the first fragment of a fragmented message.

```APIDOC
## sendFirstFragment(message: RecognizedString, isBinary?: boolean, compress?: boolean)

### Description
Sends the first fragment of a fragmented message.

### Parameters
- **message** (RecognizedString) - Required
- **isBinary** (boolean) - Optional
- **compress** (boolean) - Optional

### Returns
- **number**
```

--------------------------------

### subscribe(topic: RecognizedString)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Subscribes the WebSocket to a topic.

```APIDOC
## subscribe(topic: RecognizedString)

### Description
Subscribe to a topic.

### Parameters
- **topic** (RecognizedString) - Required

### Returns
- **boolean**
```

--------------------------------

### publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Publishes a message to a specific topic.

```APIDOC
## publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean)

### Description
Publish a message under topic.

### Parameters
- **topic** (RecognizedString) - Required
- **message** (RecognizedString) - Required
- **isBinary** (boolean) - Optional
- **compress** (boolean) - Optional

### Returns
- **boolean**
```

--------------------------------

### write

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Writes a chunk of the response.

```APIDOC
## write(chunk: RecognizedString)

### Description
Enters or continues chunked encoding mode. Writes part of the response. End with zero length write.

### Parameters
- **chunk** (RecognizedString) - Required

### Returns
- **boolean** - Returns true if no backpressure was added.
```

--------------------------------

### send(message: RecognizedString, isBinary?: boolean, compress?: boolean)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Sends a message over the WebSocket.

```APIDOC
## send(message: RecognizedString, isBinary?: boolean, compress?: boolean)

### Description
Sends a message. Returns 1 for success, 2 for dropped, 0 for backpressure.

### Parameters
- **message** (RecognizedString) - Required
- **isBinary** (boolean) - Optional
- **compress** (boolean) - Optional

### Returns
- **number**
```

--------------------------------

### getTopics()

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Returns a list of topics the WebSocket is currently subscribed to.

```APIDOC
## getTopics()

### Description
Returns a list of topics this websocket is subscribed to.

### Returns
- **string[]**
```

--------------------------------

### trace(pattern, handler)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers an HTTP TRACE handler matching the specified URL pattern.

```APIDOC
### trace(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>)

Registers an HTTP TRACE handler matching the specified URL pattern.

#### Parameters
- **pattern** (RecognizedString) - Required - URL pattern to match.
- **handler** ((res: HttpResponse, req: HttpRequest) => void | Promise<void>) - Required - Request handler function.

#### Returns
- **TemplatedApp**
```

--------------------------------

### Optimize Response Writing with cork

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Use cork to group multiple write operations into a single atomic IO operation, improving performance for both TCP and TLS connections.

```javascript
res.cork(() => {  
  res.writeStatus("200 OK").writeHeader("Some", "Value").write("Hello world!");  
});
```

--------------------------------

### getParts(body, contentType)

Source: https://unetworking.github.io/uWebSockets.js/generated/functions/getParts.html

Parses a POSTed body and its corresponding content type to extract multipart fields.

```APIDOC
## getParts(body, contentType)

### Description
Takes a POSTed body and contentType, and returns an array of parts if the request is a multipart request.

### Signature
`getParts(body: RecognizedString, contentType: RecognizedString): MultipartField[]`

### Parameters
- **body** (RecognizedString) - The body of the POST request.
- **contentType** (RecognizedString) - The content type header of the request.

### Returns
- **MultipartField[]** - An array of parts extracted from the multipart request.
```

--------------------------------

### WebSocket Methods

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

A collection of methods available on the WebSocket interface for managing the connection lifecycle and communication.

```APIDOC
## WebSocket Methods

### close()
Closes the WebSocket connection.

### cork(cb: () => void)
Corks the socket to batch operations. Returns the WebSocket instance.

### end(code?: number, shortMessage?: RecognizedString)
Gracefully closes the connection with an optional status code and message.

### getBufferedAmount()
Returns the number of bytes currently buffered in the output queue.

### getRemoteAddress()
Returns the remote address as an ArrayBuffer.

### getRemoteAddressAsText()
Returns the remote address as a text-formatted ArrayBuffer.

### getRemotePort()
Returns the remote port number.

### getTopics()
Returns an array of topics the socket is currently subscribed to.

### getUserData()
Returns the UserData associated with the connection.

### isSubscribed(topic: RecognizedString)
Checks if the socket is subscribed to a specific topic.

### ping(message?: RecognizedString)
Sends a ping frame. Returns a number indicating success or failure.

### publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean)
Publishes a message to a topic. Returns true if successful.

### send(message: RecognizedString, isBinary?: boolean, compress?: boolean)
Sends a message over the WebSocket. Returns the number of bytes sent.

### subscribe(topic: RecognizedString)
Subscribes the socket to a topic. Returns true if successful.

### unsubscribe(topic: RecognizedString)
Unsubscribes the socket from a topic. Returns true if successful.
```

--------------------------------

### writeHeader

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Writes a key-value pair to the HTTP response headers.

```APIDOC
## writeHeader(key: RecognizedString, value: RecognizedString)

### Description
Writes key and value to HTTP response.

### Parameters
- **key** (RecognizedString) - Required
- **value** (RecognizedString) - Required
```

--------------------------------

### addChildAppDescriptor

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Adds a child app descriptor for worker thread distribution.

```APIDOC
## addChildAppDescriptor(descriptor: AppDescriptor)

### Description
Adds a child app descriptor for worker thread distribution.

### Parameters
- **descriptor** (AppDescriptor) - Required - The app descriptor to add.

### Returns
- **void**
```

--------------------------------

### unsubscribe(topic: RecognizedString)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Unsubscribes the WebSocket from a topic.

```APIDOC
## unsubscribe(topic: RecognizedString)

### Description
Unsubscribe from a topic.

### Parameters
- **topic** (RecognizedString) - Required

### Returns
- **boolean**
```

--------------------------------

### put(pattern, handler)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers an HTTP PUT handler matching the specified URL pattern.

```APIDOC
### put(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>)

Registers an HTTP PUT handler matching the specified URL pattern.

#### Parameters
- **pattern** (RecognizedString) - Required - URL pattern to match.
- **handler** ((res: HttpResponse, req: HttpRequest) => void | Promise<void>) - Required - Request handler function.

#### Returns
- **TemplatedApp**
```

--------------------------------

### writeStatus

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Writes the HTTP status message.

```APIDOC
## writeStatus(status: RecognizedString)

### Description
Writes the HTTP status message such as "200 OK". This has to be called first in any response.

### Parameters
- **status** (RecognizedString) - Required
```

--------------------------------

### ping(message?: RecognizedString)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Sends a ping control message.

```APIDOC
## ping(message?: RecognizedString)

### Description
Sends a ping control message. Returns sendStatus regarding backpressure.

### Parameters
- **message** (RecognizedString) - Optional - The ping message.

### Returns
- **number**
```

--------------------------------

### isSubscribed(topic: RecognizedString)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Checks if the WebSocket is subscribed to a specific topic.

```APIDOC
## isSubscribed(topic: RecognizedString)

### Description
Returns whether this websocket is subscribed to topic.

### Parameters
- **topic** (RecognizedString) - Required - The topic to check.

### Returns
- **boolean**
```

--------------------------------

### HttpRequest Methods

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpRequest.html

Methods available on the HttpRequest object to retrieve request information and control routing flow.

```APIDOC
## forEach(cb: (key: string, value: string) => void): void

### Description
Loops over all headers.

### Parameters
- **cb** ((key: string, value: string) => void) - Required - Callback function to execute for each header.

## getCaseSensitiveMethod(): string

### Description
Returns the HTTP method as-is.

## getHeader(lowerCaseKey: RecognizedString): string

### Description
Returns the lowercased header value or empty string.

### Parameters
- **lowerCaseKey** (RecognizedString) - Required - The header key to retrieve.

## getMethod(): string

### Description
Returns the lowercased HTTP method, useful for "any" routes.

## getParameter(index: number | RecognizedString): string

### Description
Returns the parsed parameter at index. Corresponds to route. Can also take the name of the parameter.

### Parameters
- **index** (number | RecognizedString) - Required - The index or name of the parameter.

## getQuery(): string

### Description
Returns the raw querystring (the part of URL after ? sign) or empty string.

## getQuery(key: string): string

### Description
Returns a decoded query parameter value or undefined.

### Parameters
- **key** (string) - Required - The query parameter key.

## getUrl(): string

### Description
Returns the URL including initial /slash.

## setYield(_yield: boolean): HttpRequest

### Description
Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail.

### Parameters
- **_yield** (boolean) - Required - Boolean value to set yield state.
```

--------------------------------

### numSubscribers(topic: RecognizedString)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Returns the number of subscribers for a specific topic.

```APIDOC
### numSubscribers(topic: RecognizedString)

Returns the number of subscribers for a specific topic.

#### Parameters
- **topic** (RecognizedString) - Required - The topic to query.

#### Returns
- **number**
```

--------------------------------

### onWritable

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Registers a handler for writable events to continue failed write attempts.

```APIDOC
## onWritable(handler: (offset: number) => boolean)

### Description
Registers a handler for writable events. Continue failed write attempts in here. You MUST return true for success, false for failure.

### Parameters
- **handler** (function) - Required - A function that takes an offset (number) and returns a boolean.
```

--------------------------------

### removeServerName(hostname)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Removes a server name.

```APIDOC
### removeServerName(hostname: string)

Removes a server name.

#### Parameters
- **hostname** (string) - Required - The hostname to remove.

#### Returns
- **TemplatedApp**
```

--------------------------------

### patch(pattern, handler)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Registers an HTTP PATCH handler matching the specified URL pattern.

```APIDOC
### patch(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void | Promise<void>)

Registers an HTTP PATCH handler matching the specified URL pattern.

#### Parameters
- **pattern** (RecognizedString) - Required - URL pattern to match.
- **handler** ((res: HttpResponse, req: HttpRequest) => void | Promise<void>) - Required - Request handler function.

#### Returns
- **TemplatedApp**
```

--------------------------------

### close()

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Forcefully closes the WebSocket connection without sending a close message.

```APIDOC
## close()

### Description
Forcefully closes this WebSocket. Immediately calls the close handler. No WebSocket close message is sent.

### Returns
- **void**
```

--------------------------------

### getRemoteAddressAsText()

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Returns the remote IP address as a text string.

```APIDOC
## getRemoteAddressAsText()

### Description
Returns the remote IP address as text.

### Returns
- **ArrayBuffer**
```

--------------------------------

### end(code?: number, shortMessage?: RecognizedString)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Gracefully closes the WebSocket connection with an optional status code and message.

```APIDOC
## end(code?: number, shortMessage?: RecognizedString)

### Description
Gracefully closes this WebSocket. Immediately calls the close handler. A WebSocket close message is sent with code and shortMessage.

### Parameters
- **code** (number) - Optional - The close status code.
- **shortMessage** (RecognizedString) - Optional - The close message.

### Returns
- **void**
```

--------------------------------

### us_listen_socket_close(listenSocket: us_listen_socket): void

Source: https://unetworking.github.io/uWebSockets.js/generated/functions/us_listen_socket_close.html

Closes a uSockets listen socket.

```APIDOC
## us_listen_socket_close

### Description
Closes a uSockets listen socket.

### Signature
`us_listen_socket_close(listenSocket: us_listen_socket): void`

### Parameters
- **listenSocket** (us_listen_socket) - The listen socket to be closed.

### Returns
- **void**
```

--------------------------------

### getUserData()

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Returns the user-defined data object associated with the WebSocket.

```APIDOC
## getUserData()

### Description
Returns the UserData object.

### Returns
- **UserData**
```

--------------------------------

### sendFragment(message: RecognizedString, compress?: boolean)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Sends a middle fragment of a fragmented message.

```APIDOC
## sendFragment(message: RecognizedString, compress?: boolean)

### Description
Sends a middle fragment of a fragmented message.

### Parameters
- **message** (RecognizedString) - Required
- **compress** (boolean) - Optional

### Returns
- **number**
```

--------------------------------

### getRemotePort()

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Returns the remote port number.

```APIDOC
## getRemotePort()

### Description
Returns the remote port number.

### Returns
- **number**
```

--------------------------------

### pause

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

Pauses HTTP request body streaming.

```APIDOC
## pause()

### Description
Pause HTTP request body streaming (throttle). Some buffered data may still be sent to onData.
```

--------------------------------

### Define WebSocketBehavior Interface

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocketBehavior.html

The interface structure for configuring WebSocket behavior and event handlers in uWebSockets.js.

```typescript
interface WebSocketBehavior<UserData> {  
close?: (  
ws: WebSocket<UserData>,  
code: number,  
message: ArrayBuffer,  
) => void;  
closeOnBackpressureLimit?: boolean;  
compression?: number;  
drain?: (ws: WebSocket<UserData>) => void;  
dropped?: (  
ws: WebSocket<UserData>,  
message: ArrayBuffer,  
isBinary: boolean,  
) => void | Promise<void>;  
idleTimeout?: number;  
maxBackpressure?: number;  
maxLifetime?: number;  
maxPayloadLength?: number;  
message?: (  
ws: WebSocket<UserData>,  
message: ArrayBuffer,  
isBinary: boolean,  
) => void | Promise<void>;  
open?: (ws: WebSocket<UserData>) => void | Promise<void>;  
ping?: (ws: WebSocket<UserData>, message: ArrayBuffer) => void;  
pong?: (ws: WebSocket<UserData>, message: ArrayBuffer) => void;  
sendPingsAutomatically?: boolean;  
subscription?: (  
ws: WebSocket<UserData>,  
topic: ArrayBuffer,  
newCount: number,  
oldCount: number,  
) => void;  
upgrade?: (  
res: HttpResponse,  
req: HttpRequest,  
context: us_socket_context_t,  
) => void | Promise<void>;  
}
```

--------------------------------

### getRemoteAddress()

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Returns the remote IP address as a binary ArrayBuffer.

```APIDOC
## getRemoteAddress()

### Description
Returns the remote IP address as a binary ArrayBuffer.

### Returns
- **ArrayBuffer**
```

--------------------------------

### WebSocketBehavior Interface Definition

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocketBehavior.html

The WebSocketBehavior interface defines the structure for configuring WebSocket behavior, including event handlers for connection lifecycle and message processing.

```APIDOC
## Interface WebSocketBehavior<UserData>

### Description
A structure holding settings and handlers for a WebSocket URL route handler.

### Properties
- **close** (function) - Optional - Callback triggered when the WebSocket connection is closed.
- **closeOnBackpressureLimit** (boolean) - Optional - Whether to close the connection if the backpressure limit is reached.
- **compression** (number) - Optional - Compression setting for the WebSocket.
- **drain** (function) - Optional - Callback triggered when the socket is ready to be written to again after backpressure.
- **dropped** (function) - Optional - Callback triggered when a message is dropped.
- **idleTimeout** (number) - Optional - Timeout in seconds before an idle connection is closed.
- **maxBackpressure** (number) - Optional - Maximum allowed backpressure in bytes.
- **maxLifetime** (number) - Optional - Maximum lifetime of the connection in seconds.
- **maxPayloadLength** (number) - Optional - Maximum allowed payload length in bytes.
- **message** (function) - Optional - Callback triggered when a message is received.
- **open** (function) - Optional - Callback triggered when the WebSocket connection is opened.
- **ping** (function) - Optional - Callback triggered when a ping frame is received.
- **pong** (function) - Optional - Callback triggered when a pong frame is received.
- **sendPingsAutomatically** (boolean) - Optional - Whether to send pings automatically.
- **subscription** (function) - Optional - Callback triggered on subscription changes.
- **upgrade** (function) - Optional - Callback triggered during the WebSocket upgrade process.
```

--------------------------------

### sendLastFragment(message: RecognizedString, compress?: boolean)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

Sends the last fragment of a fragmented message.

```APIDOC
## sendLastFragment(message: RecognizedString, compress?: boolean)

### Description
Sends the last fragment of a fragmented message.

### Parameters
- **message** (RecognizedString) - Required
- **compress** (boolean) - Optional

### Returns
- **number**
```

--------------------------------

### us_socket_local_port(socket: us_listen_socket | us_socket): number

Source: https://unetworking.github.io/uWebSockets.js/generated/functions/us_socket_local_port.html

Retrieves the local port of a socket or listen socket. Returns the port number as a number, or -1 if the port cannot be determined.

```APIDOC
## us_socket_local_port

### Description
Gets the local port of a socket or listen socket.

### Signature
`us_socket_local_port(socket: us_listen_socket | us_socket): number`

### Parameters
- **socket** (us_listen_socket | us_socket) - Required - The socket or listen socket to query.

### Returns
- **number** - The local port number, or -1 if unavailable.
```

--------------------------------

### HttpResponse Interface Definition

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/HttpResponse.html

The TypeScript interface definition for HttpResponse, outlining all available methods and properties.

```typescript
interface HttpResponse {  
close(): HttpResponse;  
collectBody(  
maxSize: number,  
handler: (fullBody: ArrayBuffer) => void,  
): HttpResponse;  
cork(cb: () => void): HttpResponse;  
end(body?: RecognizedString, closeConnection?: boolean): HttpResponse;  
endWithoutBody(  
reportedContentLength?: number,  
closeConnection?: boolean,  
): HttpResponse;  
getProxiedRemoteAddress(): ArrayBuffer;  
getProxiedRemoteAddressAsText(): ArrayBuffer;  
getProxiedRemotePort(): number;  
getRemoteAddress(): ArrayBuffer;  
getRemoteAddressAsText(): ArrayBuffer;  
getRemotePort(): number;  
getWriteOffset(): number;  
onAborted(handler: () => void): HttpResponse;  
onData(  
handler: (chunk: ArrayBuffer, isLast: boolean) => void,  
): HttpResponse;  
onDataV2(  
handler: (chunk: ArrayBuffer, maxRemainingBodyLength: bigint) => void,  
): HttpResponse;  
onWritable(handler: (offset: number) => boolean): HttpResponse;  
pause(): void;  
resume(): void;  
tryEnd(  
fullBodyOrChunk: RecognizedString,  
totalSize: number,  
): [boolean, boolean];  
upgrade<UserData>(  
userData: UserData,  
secWebSocketKey: RecognizedString,  
secWebSocketProtocol: RecognizedString,  
secWebSocketExtensions: RecognizedString,  
context: us_socket_context_t,  
): void;  
write(chunk: RecognizedString): boolean;  
writeHeader(key: RecognizedString, value: RecognizedString): HttpResponse;  
writeStatus(status: RecognizedString): HttpResponse;  
[key: string]: any;  
}
```

--------------------------------

### WebSocket Interface Definition

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/WebSocket.html

The TypeScript interface definition for the WebSocket object, including generic UserData support and all available connection methods.

```typescript
interface WebSocket<UserData> {  
close(): void;  
cork(cb: () => void): WebSocket<UserData>;  
end(code?: number, shortMessage?: RecognizedString): void;  
getBufferedAmount(): number;  
getRemoteAddress(): ArrayBuffer;  
getRemoteAddressAsText(): ArrayBuffer;  
getRemotePort(): number;  
getTopics(): string[];  
getUserData(): UserData;  
isSubscribed(topic: RecognizedString): boolean;  
ping(message?: RecognizedString): number;  
publish(  
topic: RecognizedString,  
message: RecognizedString,  
isBinary?: boolean,  
compress?: boolean,  
): boolean;  
send(  
message: RecognizedString,  
isBinary?: boolean,  
compress?: boolean,  
): number;  
sendFirstFragment(  
message: RecognizedString,  
isBinary?: boolean,  
compress?: boolean,  
): number;  
sendFragment(message: RecognizedString, compress?: boolean): number;  
sendLastFragment(message: RecognizedString, compress?: boolean): number;  
subscribe(topic: RecognizedString): boolean;  
unsubscribe(topic: RecognizedString): boolean;  
}
```

--------------------------------

### removeChildAppDescriptor(descriptor)

Source: https://unetworking.github.io/uWebSockets.js/generated/interfaces/TemplatedApp.html

Removes a child app descriptor.

```APIDOC
### removeChildAppDescriptor(descriptor: AppDescriptor)

Removes a child app descriptor.

#### Parameters
- **descriptor** (AppDescriptor) - Required - The descriptor to remove.

#### Returns
- **void**
```
Tokens:
Raw