Fetch.functions.fetchReadableStream

fx-fetch

---

fx-fetch / Fetch / fetchReadableStream

Function: fetchReadableStream()

fetchReadableStream(request): Effect<ReadableStream<Uint8Array<ArrayBuffer>>, MalformedReadableStreamError | FetchError | AbortError | NotAllowedError | NotOkError, Fetch>

Defined in: packages/fx-fetch/src/Fetch/fetchReadableStream.ts:36

Fetches and reads a readable stream response.

Parameters

request

Request

Returns

Effect<ReadableStream<Uint8Array<ArrayBuffer>>, MalformedReadableStreamError | FetchError | AbortError | NotAllowedError | NotOkError, Fetch>

Since

0.1.0

See

Response.readReadableStream

Example

import { Effect } from 'effect';
import { Fetch, Request, Response } from 'fx-fetch';

//       ┌─── Effect.Effect<
//       │      void,
//       │      | Fetch.FetchError
//       │      | Fetch.AbortError
//       │      | Fetch.NotAllowedError
//       │      | Response.NotOkError
//       │      | MalformedReadableStreamError,
//       │      Fetch.Fetch
//       │    >
//       ▼
const program = Effect.gen(function* () {
  const request = Request.unsafeMake({ url: './my-endpoint' });

  //       ┌─── ReadableStream<Uint8Array<ArrayBuffer>>
  //       ▼
  const payload = yield* Fetch.fetchReadableStream(request);
});