TemplatedApp | uWebSockets.js v18.1.0 documentation

TemplatedApp is either an SSL or non-SSL app. See App for more info, read user manual.

Hierarchy

TemplatedApp

Index

Methods

any

any(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:245
Registers an HTTP handler matching specified URL pattern on any HTTP method.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

connect

connect(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:241
Registers an HTTP CONNECT handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

del

del(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:233
Registers an HTTP DELETE handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

get

get(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:227
Registers an HTTP GET handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

head

head(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:239
Registers an HTTP HEAD handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

listen

listen(host: RecognizedString, port: number, cb: function): TemplatedApp
listen(port: number, cb: function): TemplatedApp

- Defined in index.d.ts:223
Listens to hostname & port. Callback hands either false or a listen socket.

Parameters
- host: RecognizedString
- port: number
- cb: function
  - - (listenSocket: us_listen_socket): void
    - Parameters
      - listenSocket: us_listen_socket
      Returns void
Returns TemplatedApp
- Defined in index.d.ts:225
Listens to port. Callback hands either false or a listen socket.

Parameters
- port: number
- cb: function
  - - (listenSocket: any): void
    - Parameters
      - listenSocket: any
      Returns void
Returns TemplatedApp

options

options(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:231
Registers an HTTP OPTIONS handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

patch

patch(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:235
Registers an HTTP PATCH handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

post

post(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:229
Registers an HTTP POST handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

publish

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

- Defined in index.d.ts:249
Publishes a message under topic, for all WebSockets under this app. See WebSocket.publish.

Parameters
- topic: RecognizedString
- message: RecognizedString
- Optional isBinary: boolean
- Optional compress: boolean
Returns TemplatedApp

put

put(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:237
Registers an HTTP PUT handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

trace

trace(pattern: RecognizedString, handler: function): TemplatedApp

- Defined in index.d.ts:243
Registers an HTTP TRACE handler matching specified URL pattern.

Parameters
- pattern: RecognizedString
- handler: function
  - - (res: HttpResponse, req: HttpRequest): void
    - Parameters
      - res: HttpResponse
      - req: HttpRequest
      Returns void
Returns TemplatedApp

ws

ws(pattern: RecognizedString, behavior: WebSocketBehavior): TemplatedApp

- Defined in index.d.ts:247
Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught.

Parameters
- pattern: RecognizedString
- behavior: WebSocketBehavior
Returns TemplatedApp

Hierarchy

Index

Methods

Methods

any

Parameters

pattern: RecognizedString

handler: function

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

connect

Parameters

pattern: RecognizedString

handler: function

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

del

Parameters

pattern: RecognizedString

handler: function

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

get

Parameters

pattern: RecognizedString

handler: function

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

head

Parameters

pattern: RecognizedString

handler: function

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

listen

Parameters

host: RecognizedString

port: number

cb: function

Parameters

listenSocket: us_listen_socket

Returns void

Returns TemplatedApp

Parameters

port: number

cb: function

Parameters

listenSocket: any

Returns void

Returns TemplatedApp

options

Parameters

pattern: RecognizedString

handler: function

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

patch

Parameters

pattern: RecognizedString

handler: function

Parameters

res: HttpResponse