Request.variables.addSignal

fx-fetch

---

fx-fetch / Request / addSignal

Variable: addSignal()

const addSignal: {(self, signal): Request; (signal): (self) => Request; }

Defined in: packages/fx-fetch/src/Request/addSignal.ts:28

Adds an abort signal to a Request.

Call Signature

(self, signal): Request

Adds an abort signal to a Request.

Parameters

self

Request

signal

AbortSignal

Returns

Request

Example

import { Request } from 'fx-fetch';

const controller = new AbortController();
const request = Request.make({ url: 'https://api.example.com' });
const requestWithSignal = Request.addSignal(request, controller.signal);

Since

0.1.0

Call Signature

(signal): (self) => Request

Adds an abort signal to a Request.

Parameters

signal

AbortSignal

Returns

(self): Request

Parameters

self

Request

Returns

Request

Example

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

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

const requestWithSignal = pipe(
  request,
  Request.addSignal(controller.signal)
);

Since

0.1.0

Example

import { Request } from 'fx-fetch';

const controller = new AbortController();
const request = Request.make({ url: 'https://api.example.com' });
const requestWithSignal = Request.addSignal(request, controller.signal);

Since

0.1.0