Skip to content

Stream documentation doesn't mention interop #1254

Description

@tmcw

What is the type of issue?

Documentation is missing

What is the issue?

If a brownfield application wants to adopt Effect and use its Streams abstraction, then it's likely that they'll need to interop with streams, and my guess is that they'll have

  1. Node.js streams
  2. Web-standard ReadableStream

Unfortunately the documentation doesn't mention either of these, which is pretty odd? It looks like there is a Stream.fromReadableStream() method, but it's undocumented.

My guess is that you'd interop Node.js streams to Effect Streams by using them as async generators, but there is no documentation for that either.

Where did you find it?

https://effect.website/docs/stream/creating/

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions