Interface TemplatedApp

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

Hierarchy

TemplatedApp

Index

Methods

addServerName any connect del get head listen missingServerName numSubscribers options patch post publish put removeServerName trace ws

Methods

addServerName

addServerName(hostname: string, options: AppOptions): TemplatedApp
Adds a server name.
Parameters
- hostname: string
- options: AppOptions
Returns TemplatedApp
- Defined in index.d.ts:315

any

any(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:307

connect

connect(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:303

del

del(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:295

get

get(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:289

head

head(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:301

listen

listen(host: RecognizedString, port: number, cb: ((listenSocket: us_listen_socket) => void)): TemplatedApp
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:283
listen(port: number, cb: ((listenSocket: any) => void)): TemplatedApp
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:285
listen(port: number, options: ListenOptions, cb: ((listenSocket: false | us_listen_socket) => void)): TemplatedApp
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
- Defined in index.d.ts:287

missingServerName

missingServerName(cb: ((hostname: string) => void)): TemplatedApp
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
- Defined in index.d.ts:319

numSubscribers

numSubscribers(topic: RecognizedString): number
Returns number of subscribers for this topic.
Parameters
- topic: RecognizedString
Returns number
- Defined in index.d.ts:313

options

options(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:293

patch

patch(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:297

post

post(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:291

publish

publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean): boolean
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
- Defined in index.d.ts:311

put

put(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:299

removeServerName

removeServerName(hostname: string): TemplatedApp
Removes a server name.
Parameters
- hostname: string
Returns TemplatedApp
- Defined in index.d.ts:317

trace

trace(pattern: RecognizedString, handler: ((res: HttpResponse, req: HttpRequest) => void)): TemplatedApp
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
- Defined in index.d.ts:305

ws

ws<UserData>(pattern: RecognizedString, behavior: WebSocketBehavior<UserData>): TemplatedApp
Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught.
Type Parameters
- UserData
Parameters
- pattern: RecognizedString
- behavior: WebSocketBehavior<UserData>
Returns TemplatedApp
- Defined in index.d.ts:309

Interface 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

`Optional` isBinary: boolean

`Optional` compress: boolean