Response Types

The outgoing side of every route handler. Response is the res object your handler uses to reply. NetworkResponse is what the client receives. MiddlewareHandler is the function type accepted by app:Use().

Response

The res argument passed to every route handler. Call exactly one terminal method (Send, Error) per handler invocation. Chain Status() before the terminal call to set a status code.

copyexport type Response = {
    Send     : (self: Response, data: any?) -> (),
    Error    : (self: Response, message: string) -> (),
    Status   : (self: Response, code: number) -> Response,
    Redirect : (self: Response, route: string) -> (),
}

copyapp:Get("player/:id", function(req, res)
    local player = Players:GetPlayerByUserId(req.params.id)
    if not player then
        res:Status(404):Error("player not found")
        return
    end
    res:Send({ name = player.Name })
end)

NetworkResponse

The table the client's Network:Send() promise resolves with. Inspect ok first, then branch on type for more detail.

copyexport type NetworkResponse = {
    type       : "success" | "error" | "timeout",
    status     : number?,
    data       : any?,
    message    : string?,
    compressed : boolean?,
}

copy-- Client-side usage
local network = RoExpress.GetNetwork()

network:Send("player/123", { method = "GET" }):andThen(function(res)
    if res.type == "success" then
        print(res.data.name)
    elseif res.type == "error" then
        warn(res.status, res.message)
    else
        warn("request timed out")
    end
end)

MiddlewareHandler

The function type accepted by app:Use(). Middleware runs before every route handler on that app. Return false to block the request with a 403; throw an error to send a 500. Returning nothing (or true) passes the request through.

copyexport type MiddlewareHandler =
    (Player: Player, Payload: Payload) -> (boolean?)

copy-- Auth guard example
app:Use(function(player, payload)
    if not isAuthorized(player) then
        return false  -- blocked | client receives 403
    end
    -- return nil / true to pass through
end)

Module instance types

See also

← Types  ·  Request Types | Request, Payload, RouteHandler  ·  Response Object | detailed method reference with examples  ·  Network | NetworkResponse in use  ·  Middleware Guide | MiddlewareHandler patterns