Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-2646] Document <stream>.close() method #257

Merged
merged 1 commit into from
Apr 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,33 @@ stream.start(
);
```

_Close a stream_

Use the `<stream>.close()` method to close a stream.

```javascript
import { Client, fql } from "fauna"
const client = new Client()

const stream = await client.stream(fql`Product.all().toStream()`)

let count = 0;
for await (const event of stream) {
console.log(event.type)
console.log(event.data)
count++;

// Close the stream after 2 events
if (count === 2) {
console.log("Closing the stream ...")
stream.close()
break;
}
}

client.close();
```

# Contributing

Any contributions are from the community are greatly appreciated!
Expand Down
Loading