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.

Sign up for GitHub

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

Jump to bottom

docs: add note on NATS jetstream beta package #405

Merged
merged 2 commits into from
Jun 27, 2024
Merged

docs: add note on NATS jetstream beta package #405

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a2fdd3
docs: add note on NATS jetstream beta package
AlexCuse Oct 29, 2023
5c8f519
Merge branch 'master' into jetstream-beta-note
m110 Jun 27, 2024
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
7 changes: 6 additions & 1 deletion docs/content/pubsubs/nats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ toc = false

NATS Jetstream is a data streaming system powered by NATS, and written in the Go programming language.

As of v2.0.2 this middleware will contain a beta implementation in `pkg/jetstream` based on the
[nats.go Jetstream package](https://github.com/nats-io/nats.go/tree/main/jetstream). This implementation is
considered experimental tracking with the upstream client though we target a stable watermill API by v2.1.
For production use it is recommended to use the pubsub implementations in `pkg/nats` with Jetstream enabled.

### Installation

go get github.com/ThreeDotsLabs/watermill-nats/v2
Expand Down Expand Up @@ -63,7 +68,7 @@ Example:
{{% load-snippet-partial file="src-link/_examples/pubsubs/nats-jetstream/main.go" first_line_contains="subscriber, err :=" last_line_contains="panic(err)" padding_after="1" %}}
{{% /render-md %}}

You can also use `NewSubscriberWithNATSConn` and `NewPublisherWithNatsConn` to use a custom `stan.Conn` created by `NewStanConnection`.
You can also use `NewSubscriberWithNatsConn` and `NewPublisherWithNatsConn` to use a custom `*nats.Conn`.

#### Publishing

Expand Down
Loading