mirror of
https://github.com/lune-org/lune.git
synced 2024-12-12 04:50:36 +00:00
Update net.serve
docs for address
change (#149)
This commit is contained in:
parent
fe4ba1db02
commit
347da823b7
1 changed files with 17 additions and 1 deletions
|
@ -113,12 +113,28 @@ type ServeWebSocketHandler = (socket: WebSocket) -> ()
|
|||
|
||||
Configuration for `net.serve`.
|
||||
|
||||
This may contain one of, or both of the following callbacks:
|
||||
This may contain one of or more of the following values:
|
||||
|
||||
* `address` for setting the IP address to serve from. Defaults to the loopback interface (`http://localhost`).
|
||||
* `handleRequest` for handling normal http requests, equivalent to just passing a function to `net.serve`
|
||||
* `handleWebSocket` for handling web socket requests, which will receive a `WebSocket` object as its first and only parameter
|
||||
|
||||
When setting `address`, the `handleRequest` callback must also be defined.
|
||||
|
||||
```lua
|
||||
net.serve(8080, {
|
||||
address = "http://0.0.0.0",
|
||||
handleRequest = function(request)
|
||||
return {
|
||||
status = 200,
|
||||
body = "Echo:\n" .. request.body,
|
||||
}
|
||||
end
|
||||
})
|
||||
```
|
||||
]=]
|
||||
export type ServeConfig = {
|
||||
address: string?,
|
||||
handleRequest: ServeHttpHandler?,
|
||||
handleWebSocket: ServeWebSocketHandler?,
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue