Skip to content

Commit 4e8b457

Browse files
authored
docs: Rename StartTime() StreamOptFn to StreamStartTime() (#186)
1 parent 0de1e35 commit 4e8b457

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ API reference documentation for the driver is available on [pkg.go.dev](https://
2323

2424
## Using the Driver
2525

26-
For FQL templates, denote variables with `${}` and pass variables as `map[string]any` to `fauna.FQL()`. You can escape a variable with by prepending
26+
For FQL templates, denote variables with `${}` and pass variables as `map[string]any` to `FQL()`. You can escape a variable with by prepending
2727
an additional `$`.
2828

2929
### Basic Usage
@@ -338,9 +338,9 @@ func main() {
338338
}
339339
```
340340

341-
In query results, the driver represents an event source as a `fauna.EventSource` value.
341+
In query results, the driver represents an event source as an `EventSource` value.
342342

343-
To start a stream from a query result, call `Stream()` and pass the `fauna.EventSource`.
343+
To start a stream from a query result, call `Stream()` and pass the `EventSource`.
344344
This lets you output a stream alongside normal query results:
345345

346346
```go
@@ -418,16 +418,18 @@ The `StreamFromQuery()` and `Stream()` methods accept
418418
[StreamOptFn](https://pkg.go.dev/github.com/fauna/fauna-go/v3#StreamOptFn)
419419
functions as arguments.
420420

421-
Use `fauna.StartTime()` to restart a stream at a specific timestamp:
421+
Use `StreamStartTime()` to restart a stream at a specific timestamp:
422422

423423
```go
424424
streamQuery, _ := fauna.FQL(`Product.all().eventSource()`, nil)
425+
tenMinutesAgo := time.Now().Add(-10 * time.Minute)
426+
425427
client.StreamFromQuery(streamQuery, fauna.StreamOptFn{
426-
fauna.StartTime(1710968002310000),
428+
fauna.StreamStartTime(tenMinutesAgo),
427429
})
428430
```
429431

430-
Use `fauna.EventCursor()` to resume a stream from an event cursor after a disconnect:
432+
Use `EventCursor()` to resume a stream from an event cursor after a disconnect:
431433

432434
```go
433435
client.StreamFromQuery(streamQuery, fauna.StreamOptFn{

0 commit comments

Comments
 (0)