App

The Lynx class is used to create your application.

local Lynx = require("@lynx/lynx")

local app = Lynx.new()

-- Define routes and middleware here

app:serve()

Methods

:<method>(path: string, handler: Handler | Middleware, ...: Handler | Middleware)

Supported methods: :get, :post, :put, :delete, :patch

Define a route for a specific HTTP method.

app:get("/", function(c)
  return c:text("Hello, Lynx!")
end)

:all(path: string, handler: Handler | Middleware, ...: Handler | Middleware)

Define a route that matches all HTTP methods.

app:all("/all", function(c)
  return c:text("All methods")
end)

:on(method: string, path: string, handler: Handler | Middleware, ...: Handler | Middleware)

Define a route for a specific or custom HTTP method.

app:on("CUSTOM", "/custom", function(c)
  return c:text("Custom method")
end)

:use(middleware: Middleware, ...: Middleware)
or
:use(path: string, middleware: Middleware, ...: Middleware)

Create a middleware that runs on every request or on a specific path.

app:use(function(c, next)
  print("Before request")
  next()
  print("After request")
end)

:static(path: string, directory: string)

Serve static files from a directory.

app:static("/static", "public")

:route(path: string, app: Lynx)

Mount a sub-application at a specific path.

local api = Lynx.new()

api:get("/", function(c)
  return c:text("api")
end)

app:route("/api", api)

:notFound(handler: Handler)

Define a custom 404 handler.

app:notFound(function(c)
  return c:text(`🔍 {c.req.method} {c.req.path} Not found`, 404)
end)

:onError(handler: ErrorHandler)

Define a custom error handler.

app:onError(function(c, err)
  return c:text(`🚨 {err}`, 500)
end)

:request(request: string | net.ServeRequest)

Send a request to the application and return the response. This can be useful for testing your application.

local response = app:request("/hello")

Alternatively, you can pass a net.ServeRequest object.

local response = app:request({
  method = "POST",
  path = "/create"
})

:serve(port: number?)

Start serving the application. Optionally specify a port (default: 3000).

app:serve()