utils/url

Documentation

• source: utils/url.ts

Overview

Classes

URL

encode()

URL-encodes the input string, typically used for encoding query parameter values.

static encode(input: string, charset: string): string;

Parameter	Type	Description
input	string	The string to be encoded.
charset	string	The character set (e.g., 'UTF-8', 'ISO-8859-1') to use for encoding. Defaults to the system's preferred encoding if omitted.

Returns

• Type: string
• Description: The URL-encoded string.

decode()

URL-decodes the input string, typically used for decoding query parameter values.

static decode(input: string, charset: string): string;

Parameter	Type	Description
input	string	The string to be decoded.
charset	string	The character set (e.g., 'UTF-8', 'ISO-8859-1') that was used for encoding. Defaults to the system's preferred encoding if omitted.

Returns

• Type: string
• Description: The URL-decoded string.

escape()

Escapes the input string using general URL escaping rules. This is typically equivalent to `encodeURIComponent` and is suitable for encoding query parameter values.

static escape(input: string): string;

Parameter	Type	Description
input	string	The string to escape.

Returns

• Type: string
• Description: The escaped string.

escapePath()

Escapes the input string specifically for use as a URL path segment. It typically preserves path delimiters like `/` that might otherwise be escaped in standard URL encoding.

static escapePath(input: string): string;

Parameter	Type	Description
input	string	The path string to escape.

Returns

• Type: string
• Description: The escaped path string.

escapeForm()

Escapes the input string according to the rules for HTML Form Data (application/x-www-form-urlencoded). This typically replaces spaces with `+` instead of `%20`.

static escapeForm(input: string): string;

Parameter	Type	Description
input	string	The form data string to escape.

Returns

• Type: string
• Description: The escaped form data string.