Skip to content

StreamAsync method is confusing #30

@kirsan31

Description

@kirsan31

Hello, LiveClient.StreamAsync is very confusing in examples and docs/description.

Stream records as an async enumerable

Must be something like:

Stream records as an async enumerable unless client is stopped or cancellationToken canceled.

In main page examples this:

await foreach (var record in client.StreamAsync()) { }

is very confusing :( The following questions arise:

  • Is this code necessary to retrieve the data or not?
  • Will this code end when there is no more data?
  • Why is it there in this form anyway? :)

To figure all this out, I had to study the source code...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions