Request.variables.setUrlSearchParam

fx-fetch

---

fx-fetch / Request / setUrlSearchParam

Variable: setUrlSearchParam()

const setUrlSearchParam: {(self, key, value): Request; (key, value): (self) => Request; }

Defined in: packages/fx-fetch/src/Request/setUrlSearchParam.ts:31

Sets a search parameter in the URL of a Request.

Call Signature

(self, key, value): Request

Sets a search parameter in the URL of a Request.

Parameters

self

Request

key

string

value

SearchParamValueInput

Returns

Request

Example

import { Request } from 'fx-fetch';

const request = Request.make({ url: 'https://api.example.com' });
const requestWithParam = Request.setUrlSearchParam(request, 'page', '1');

Since

0.1.0

Call Signature

(key, value): (self) => Request

Sets a search parameter in the URL of a Request.

Parameters

key

string

value

SearchParamValueInput

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 requestWithParam = pipe(
  request,
  Request.setUrlSearchParam('page', '1')
);

Since

0.1.0

Example

import { Request } from 'fx-fetch';

const request = Request.make({ url: 'https://api.example.com' });
const requestWithParam = Request.setUrlSearchParam(request, 'page', '1');

Since

0.1.0