Skip to content

Commit

Permalink
README fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored and cynicaljoy committed Oct 28, 2024
1 parent 72000d0 commit 2a937ee
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,10 +415,13 @@ func main() {
### Stream options

The [client configuration](#client-configuration) sets default query options for
`StreamFromQuery()`.
`StreamFromQuery()` and `Stream()`.

The `Stream()` method accepts the `fauna.StartTime` and `fauna.EventCursor`
function. Use `fauna.StartTime()` to restart a stream at a specific timestamp.
The `StreamFromQuery()` and `Stream()` methods accept
[StreamOptFn](https://pkg.go.dev/github.com/fauna/fauna-go/v2#StreamOptFn)
functions as arguments.

Use `fauna.StartTime()` to restart a stream at a specific timestamp:

```go
streamQuery, _ := fauna.FQL(`Product.all().eventSource()`, nil)
Expand Down

0 comments on commit 2a937ee

Please sign in to comment.