TemplatedApp | uWebSockets.js v20.4.0 documentation

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

Hierarchy

TemplatedApp

Index

Methods

addServerName

addServerName(hostname: string, options: AppOptions): TemplatedApp

- Defined in index.d.ts:299
Adds a server name.

Parameters
- hostname: string
- options: AppOptions
Returns TemplatedApp

any

any(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

connect

connect(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

del

del(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

get

get(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

head

head(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

listen

listen(host: RecognizedString, port: number, cb: (listenSocket: us_listen_socket) => void): TemplatedApp
listen(port: number, cb: (listenSocket: any) => void): TemplatedApp
listen(port: number, options: ListenOptions, cb: (listenSocket: false | us_listen_socket) => void): TemplatedApp

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

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

Parameters
- port: number
- cb: (listenSocket: any) => void
  - - (listenSocket: any): void
    - Parameters
      - listenSocket: any
      Returns void
Returns TemplatedApp
- Defined in index.d.ts:271
Listens to port and sets Listen Options. Callback hands either false or a listen socket.

Parameters
- port: number
- options: ListenOptions
- cb: (listenSocket: false | us_listen_socket) => void
  - - (listenSocket: false | us_listen_socket): void
    - Parameters
      - listenSocket: false | us_listen_socket
      Returns void
Returns TemplatedApp

missingServerName

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

- Defined in index.d.ts:303
Registers a synchronous callback on missing server names. See /examples/ServerName.js.

Parameters
- cb: (hostname: string) => void
  - - (hostname: string): void
    - Parameters
      - hostname: string
      Returns void
Returns TemplatedApp

numSubscribers

numSubscribers(topic: RecognizedString): number

- Defined in index.d.ts:297
Returns number of subscribers for this topic.

Parameters
- topic: RecognizedString
Returns number

options

options(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

patch

patch(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

post

post(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

publish

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

- Defined in index.d.ts:295
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 boolean

put

put(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

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

removeServerName

removeServerName(hostname: string): TemplatedApp

- Defined in index.d.ts:301
Removes a server name.

Parameters
- hostname: string
Returns TemplatedApp

trace

trace(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void): TemplatedApp

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

Parameters
- pattern: RecognizedString
- handler: (res: HttpResponse, req: HttpRequest) => void
  - - (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:293
Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught.

Parameters
- pattern: RecognizedString
- behavior: WebSocketBehavior
Returns TemplatedApp

Hierarchy

Index

Methods

Methods

addServerName

Parameters

hostname: string

options: AppOptions

Returns TemplatedApp

any

Parameters

pattern: RecognizedString

handler: (res: HttpResponse, req: HttpRequest) => void

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

connect

Parameters

pattern: RecognizedString

handler: (res: HttpResponse, req: HttpRequest) => void

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

del

Parameters

pattern: RecognizedString

handler: (res: HttpResponse, req: HttpRequest) => void

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

get

Parameters

pattern: RecognizedString

handler: (res: HttpResponse, req: HttpRequest) => void

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

head

Parameters

pattern: RecognizedString

handler: (res: HttpResponse, req: HttpRequest) => void

Parameters

res: HttpResponse

req: HttpRequest

Returns void

Returns TemplatedApp

listen

Parameters

host: RecognizedString

port: number

cb: (listenSocket: us_listen_socket) => void

Parameters

listenSocket: us_listen_socket

Returns void

Returns TemplatedApp

Parameters

port: number

cb: (listenSocket: any) => void

Parameters

listenSocket: any

Returns void

Returns TemplatedApp

Parameters

port: number

options: ListenOptions

cb: (listenSocket: false | us_listen_socket) => void

Parameters

listenSocket: false | us_listen_socket

Returns void

Returns TemplatedApp

missingServerName

Parameters