IQHTTPEngine

@quik/http

---

@quik/http / IQHTTPEngine

Interface: IQHTTPEngine

Defined in: http/src/engine/IQHTTPEngine.ts:6

Interface describing the contract for a HTTP engine implementation.

Properties

engine

readonly engine: string

Defined in: http/src/engine/IQHTTPEngine.ts:8

Name of the underlying engine implementation.

---

host

readonly host: string

Defined in: http/src/engine/IQHTTPEngine.ts:16

Host on which the server listens.

---

isListening

readonly isListening: boolean

Defined in: http/src/engine/IQHTTPEngine.ts:12

Indicates whether the server is listening.

---

port

readonly port: number

Defined in: http/src/engine/IQHTTPEngine.ts:14

Port on which the server listens.

---

server

readonly server: Server

Defined in: http/src/engine/IQHTTPEngine.ts:10

Node HTTP server instance used by the engine.

Methods

reload()

reload(): Promise<void>

Defined in: http/src/engine/IQHTTPEngine.ts:25

Stop the server, re-register all routes and restart listening.

Returns

Promise<void>

---

start()

start(): Promise<void>

Defined in: http/src/engine/IQHTTPEngine.ts:19

Start the HTTP server.

Returns

Promise<void>

---

stop()

stop(): Promise<void>

Defined in: http/src/engine/IQHTTPEngine.ts:22

Stop the HTTP server.

Returns

Promise<void>