Request.variables.readStream

fx-fetch

---

fx-fetch / Request / readStream

Variable: readStream()

const readStream: {<E>(self, options): Effect<Stream<Uint8Array<ArrayBufferLike>, E, never>, MalformedReadableStreamError, never>; <E>(options): (self) => Effect<Stream<Uint8Array<ArrayBufferLike>, E, never>, MalformedReadableStreamError, never>; }

Defined in: packages/fx-fetch/src/Request/readStream.ts:43

Reads a ReadableStream request.

Call Signature

<E>(self, options): Effect<Stream<Uint8Array<ArrayBufferLike>, E, never>, MalformedReadableStreamError, never>

Reads a ReadableStream request.

Type Parameters

E

E

Parameters

self

Request

options

Options<E>

Returns

Effect<Stream<Uint8Array<ArrayBufferLike>, E, never>, MalformedReadableStreamError, never>

Example

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

const request = Request.make({ url: 'https://api.example.com' });
const streamEffect = Request.readStream(request, {
  onError: (error) => new Error('Stream error')
});

Since

0.1.0

Call Signature

<E>(options): (self) => Effect<Stream<Uint8Array<ArrayBufferLike>, E, never>, MalformedReadableStreamError, never>

Reads a ReadableStream request.

Type Parameters

E

E

Parameters

options

Options<E>

Returns

(self): Effect<Stream<Uint8Array<ArrayBufferLike>, E, never>, MalformedReadableStreamError, never>

Parameters

self

Request

Returns

Effect<Stream<Uint8Array<ArrayBufferLike>, E, never>, MalformedReadableStreamError, never>

Example

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

const request = Request.make({ url: 'https://api.example.com' });

const streamEffect = pipe(
  request,
  Request.readStream({
    onError: (error) => new Error('Stream error')
  })
);

Since

0.1.0

Example

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

const request = Request.make({ url: 'https://api.example.com' });
const streamEffect = Request.readStream(request, {
  onError: (error) => new Error('Stream error')
});

Since

0.1.0