Request.variables.setCredentials

fx-fetch

---

fx-fetch / Request / setCredentials

Variable: setCredentials()

const setCredentials: {(self, credentials): Request; (credentials): (self) => Request; }

Defined in: packages/fx-fetch/src/Request/setCredentials.ts:34

Sets credentials mode in a request to control how cookies and authorization headers are sent.

Call Signature

(self, credentials): Request

Sets credentials mode in a request (direct call).

Parameters

self

Request

credentials

RequestCredentials

Returns

Request

Example

import { Request } from 'fx-fetch';

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

Since

0.1.0

Call Signature

(credentials): (self) => Request

Sets credentials mode in a request.

Parameters

credentials

RequestCredentials

Returns

(self): Request

Parameters

self

Request

Returns

Request

Example

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

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

const requestWithCredentials = pipe(
  request,
  Request.setCredentials('include')
);

Since

0.1.0

Example

import { Request } from 'fx-fetch';

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

// Include credentials (cookies, authorization headers) in cross-origin requests
const requestWithCredentials = Request.setCredentials(request, 'include');

// Send credentials only for same-origin requests
const requestSameOrigin = Request.setCredentials(request, 'same-origin');

Since

0.1.0