Url.variables.deleteSearchParam

fx-fetch

---

fx-fetch / Url / deleteSearchParam

Variable: deleteSearchParam()

const deleteSearchParam: {(url, key, value?): Url; (key, value?): (url) => Url; }

Defined in: packages/fx-fetch/src/Url/deleteSearchParam.ts:57

Deletes search parameters from a Url. If a value is provided, only that value is removed; otherwise, all values for the key are removed.

Call Signature

(url, key, value?): Url

Deletes search parameters from a Url. If a value is provided, only that value is removed; otherwise, all values for the key are removed.

Parameters

url

Url

key

string

value?

SearchParamValueInput

Returns

Url

Example

import { Url } from 'fx-fetch';

const url = Url.make('https://api.example.com?page=1&limit=10');
const urlWithoutParam = Url.deleteSearchParam(url, 'page');

Since

0.1.0

Call Signature

(key, value?): (url) => Url

Deletes search parameters from a Url. If a value is provided, only that value is removed; otherwise, all values for the key are removed.

Parameters

key

string

value?

SearchParamValueInput

Returns

(url): Url

Parameters

url

Url

Returns

Url

Example

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

const url = Url.make('https://api.example.com?page=1&limit=10');
const urlWithoutParam = pipe(
  url,
  Url.deleteSearchParam('page')
);

Since

0.1.0

Example

import { Url } from 'fx-fetch';

const url = Url.make('https://api.example.com?page=1&limit=10');
const urlWithoutParam = Url.deleteSearchParam(url, 'page');

Since

0.1.0