Skip to content

Documentation

TypeScript SDK: UrlTools: URLs and parameters

ctx.url() builds and parses URLs locally. It does not make a network request.

Each example is a separate fragment inside async function run(ctx: Akmelo.Context): Promise<void>. Use await only for methods whose signature returns a Promise.

Methods

absolutize

ctx.url().absolutize(base, relative) → string

Resolve a relative link against a known page address.

const result = ctx.url().absolutize('https://example.com/catalog', '/product');

param

ctx.url().param(url, name) → string | null

Read a string query parameter from a URL.

const result = ctx.url().param('https://example.com/catalog?page=2', 'page');

withParam

ctx.url().withParam(url, name, value) → string

Add or replace one query parameter.

const result = ctx.url().withParam('https://example.com/catalog', 'page', 2);

page

ctx.url().page(template, page) → string

Replace {page} in a template with a page number.

const result = ctx.url().page('https://example.com/catalog?page={page}', 2);