Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamw committed Jan 3, 2025
1 parent 7f184f9 commit 8fd0331
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/backends/synchronous.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Both HttpClient and OkHttp backends support regular [websockets](../other/websoc
"com.softwaremill.sttp.client4" %% "ox" % "@VERSION@",
```

```scala mdoc:compile-only
```scala
import sttp.client4.*
import sttp.client4.impl.ox.sse.OxServerSentEvents
import java.io.InputStream
Expand Down
2 changes: 1 addition & 1 deletion docs/other/websockets.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def asWebSocketStream[S](s: Streams[S])(p: s.Pipe[WebSocketFrame.Data[_], WebSoc
WebSocketStreamResponseAs[Either[String, Unit], S] = ???

def asWebSocketStreamOrFail[S](s: Streams[S])(p: s.Pipe[WebSocketFrame.Data[_], WebSocketFrame]):
WebSocketStreamResponseAs[Unit, S] =
WebSocketStreamResponseAs[Unit, S] = ???
```

Using streaming websockets requires the backend to support the given streaming capability (see also [streaming](../requests/streaming.md)). Streaming capabilities are described as implementations of `Streams[S]`, and are provided by backend implementations, e.g. `PekkoStreams` or `Fs2Streams[F]`.
Expand Down

0 comments on commit 8fd0331

Please sign in to comment.