Url.variables.setSearchParam

fx-fetch

---

fx-fetch / Url / setSearchParam

Variable: setSearchParam()

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

Defined in: packages/fx-fetch/src/Url/setSearchParam.ts:45

Sets a search parameter on a Url. If the value is undefined, the parameter is removed.

Call Signature

(url, key, value): Url

Sets a search parameter on a Url. If the value is undefined, the parameter is removed.

Parameters

url

Url

key

string

value

SearchParamValueInput

Returns

Url

Example

import { Url } from 'fx-fetch';

const url = Url.unsafeMake({
  url: 'https://example.com',
  searchParams: {
    tag: "new"
  },
}); // 'https://example.com?tag=new'

const updatedUrl = Url.setSearchParam(url, 'tag', 'active'); // 'https://example.com?tag=active'

Since

0.1.0

Call Signature

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

Sets a search parameter on a Url. If the value is undefined, the parameter is removed.

Parameters

key

string

value

SearchParamValueInput

Returns

(url): Url

Parameters

url

Url

Returns

Url

Example

import { Url } from 'fx-fetch';

const url = Url.unsafeMake({
  url: 'https://example.com',
  searchParams: {
    tag: "new"
  },
}); // 'https://example.com?tag=new'

const updatedUrl = Url.setSearchParam(url, 'tag', 'active'); // 'https://example.com?tag=active'

Since

0.1.0

Example

import { Url } from 'fx-fetch';

const url = Url.unsafeMake({
  url: 'https://example.com',
  searchParams: {
    tag: "new"
  },
}); // 'https://example.com?tag=new'

const updatedUrl = Url.setSearchParam(url, 'tag', 'active'); // 'https://example.com?tag=active'

Since

0.1.0