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

expose async-generator client API #185

Merged
merged 1 commit into from
Jul 31, 2024
Merged

expose async-generator client API #185

merged 1 commit into from
Jul 31, 2024

Conversation

sqs
Copy link
Member

@sqs sqs commented Jul 31, 2024

Previously, the client and controller only exposed a "watch" API using RxJS Observables so that callers could subscribe to and watch changes (to mentions, annotations, etc.). This required callers to depend on RxJS, which is a big dependency that can introduce complexity in their own applications. Now, there is a new API xyzChanges__asyncGenerator for each of meta, mentions, items, and annotations that lets callers just use native async generators. This API is experimental and may be changed without notice.

Previously, the client and controller only exposed a "watch" API using RxJS Observables so that callers could subscribe to and watch changes (to mentions, annotations, etc.). This required callers to depend on RxJS, which is a big dependency that can introduce complexity in their own applications. Now, there is a new API `xyzChanges__asyncGenerator` for each of `meta`, `mentions`, `items`, and `annotations` that lets callers just use native async generators. This API is experimental and may be changed without notice.
@sqs sqs enabled auto-merge (squash) July 31, 2024 09:30
@sqs sqs merged commit 62c802c into main Jul 31, 2024
10 of 12 checks passed
@sqs sqs deleted the sqs/async-generator-api branch July 31, 2024 09:30
bevzzz pushed a commit to bevzzz/openctx that referenced this pull request Dec 12, 2024
Previously, the client and controller only exposed a "watch" API using
RxJS Observables so that callers could subscribe to and watch changes
(to mentions, annotations, etc.). This required callers to depend on
RxJS, which is a big dependency that can introduce complexity in their
own applications. Now, there is a new API `xyzChanges__asyncGenerator`
for each of `meta`, `mentions`, `items`, and `annotations` that lets
callers just use native async generators. This API is experimental and
may be changed without notice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant