doc/modules/http.websocket.md: Add usage example to websocket:each()

daurnimator · Jul 19, 2018 · d06eb6e · d06eb6e
1 parent 921e04d
commit d06eb6e
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/doc/modules/http.websocket.md b/doc/modules/http.websocket.md
@@ -53,6 +53,16 @@ The opcode `0x1` will be returned as `"text"` and `0x2` will be returned as `"bi
 
 Iterator over [`websocket:receive()`](#http.websocket:receive).
 
+#### Example {#http.websocket:each-example}
+
+```lua
+local ws = websocket.new_from_uri("wss://echo.websocket.org")
+assert(ws:connect())
+
+for data, opcode in ws:each() do
+	print(data, opcode)
+end
+```
 
 ### `websocket:send_frame(frame, timeout)` <!-- --> {#http.websocket:send_frame}