Commit 79d07a1

Request and Response objects explanation

Author	Mitja Felicijan <mitja.felicijan@gmail.com>	2026-05-17 12:38:59 +0200
Committer	Mitja Felicijan <mitja.felicijan@gmail.com>	2026-05-17 12:38:59 +0200
Commit	`79d07a169279b7daee83adfb61a084c1d73bbe3a` (patch)

-rw-r--r-- DOCS.md 13

1 files changed, 12 insertions, 1 deletions



- `http.run()`: Starts the event loop.
  
### Request Object (`req`)
- `req.method`: The HTTP method (e.g., `"GET"`, `"POST"`).
- `req.path`: The requested path.
- `req.query`: A table containing URL query parameters.
- `req.params`: A table containing route parameters (e.g., `:id`).
- `req.body`: The raw request body as a string.
- `req:json()`: Parses the request body as JSON and returns a Lua table (or `nil` if invalid).
  
### Response Object (`res`)
- `res:status(code)`: Sets the HTTP status code (e.g., `200`, `404`). Returns `res` for chaining.
- `res:header(name, value)`: Sets a response header. Returns `res` for chaining.
- `res:send(body)`: Sends the response body with `text/html` content type.
- `res:json(table)`: Serializes the table to JSON and sends it with `application/json` content type.
### WebSocket Object (`ws`)
- `ws:send(message)`: Sends a text message to the client.
- `ws:on(event, callback)`: Registers an event listener. Supported events: `"message"`, `"close"`.


diff --git a/DOCS.md b/DOCS.md
...
166	- `http.run()`: Starts the event loop.	166	- `http.run()`: Starts the event loop.
167		167
168	### Request Object (`req`)	168	### Request Object (`req`)
169	...	169	- `req.method`: The HTTP method (e.g., `"GET"`, `"POST"`).
		170	- `req.path`: The requested path.
		171	- `req.query`: A table containing URL query parameters.
		172	- `req.params`: A table containing route parameters (e.g., `:id`).
		173	- `req.body`: The raw request body as a string.
		174	- `req:json()`: Parses the request body as JSON and returns a Lua table (or `nil` if invalid).
		175
		176	### Response Object (`res`)
		177	- `res:status(code)`: Sets the HTTP status code (e.g., `200`, `404`). Returns `res` for chaining.
		178	- `res:header(name, value)`: Sets a response header. Returns `res` for chaining.
		179	- `res:send(body)`: Sends the response body with `text/html` content type.
		180	- `res:json(table)`: Serializes the table to JSON and sends it with `application/json` content type.
170	### WebSocket Object (`ws`)	181	### WebSocket Object (`ws`)
171	- `ws:send(message)`: Sends a text message to the client.	182	- `ws:send(message)`: Sends a text message to the client.
172	- `ws:on(event, callback)`: Registers an event listener. Supported events: `"message"`, `"close"`.	183	- `ws:on(event, callback)`: Registers an event listener. Supported events: `"message"`, `"close"`.
...