HttpServer

A localhost HTTP server with the /gateway/bot default. new starts it on an ephemeral port and stores the handler; the handler may answer any route by returning a response or a raw string body, and falls through to the default by returning nil.

Summary

Properties

HttpServer.handler :: Handler?HttpServer.gatewayUrl :: functionHttpServer.onStop :: function?HttpServer.server :: any?HttpServer.port :: numberHttpServer.url :: string

Methods

HttpServer:respond(request: ZuneRequest) → string | ZuneResponseHttpServer:stop()

Functions

HttpServer.new(settings: { handler: Handler?, gatewayUrl: () -> string?, onStop: ((server: HttpServer) -> ())?, }) → HttpServer

Properties

handler

HttpServer.handler  :: Handler?

---

The test's handler, which answers every request before the default routes.

gatewayUrl

HttpServer.gatewayUrl  :: function

---

Returns the websocket URL, or nil when no websocket server exists.

onStop

HttpServer.onStop  :: function?

---

Called with the handle after it stops.

server

HttpServer.server  :: any?

---

The Zune server handle, nil after it stops.

port

HttpServer.port  :: number

---

The ephemeral port the server bound to.

url

HttpServer.url  :: string

---

The server's base URL, http://127.0.0.1:{port}.

Methods

respond

HttpServer : respond ( request )  -> string | ZuneResponse

Answers one request: the handler first, then the default.

Parameters

request: ZuneRequest

Returns

string | ZuneResponse

stop

HttpServer : stop ( )  -> ()

Stops listening. Safe to call twice.

Functions

new

HttpServer . new ( settings )  -> HttpServer

Creates and starts the server on 127.0.0.1 with an ephemeral port.

Parameters

settings: { handler: Handler?, gatewayUrl: () -> string?, onStop: ((server, }

Returns

HttpServer