Skip to content

Commit

Permalink
Update net.serve docs for address change (#149)
Browse files Browse the repository at this point in the history
  • Loading branch information
vocksel authored Feb 3, 2024
1 parent fe4ba1d commit 347da82
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion types/net.luau
Original file line number Diff line number Diff line change
Expand Up @@ -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?,
}
Expand Down

0 comments on commit 347da82

Please sign in to comment.