Skip to main content

url-encode

$url-encode​

Percent-encodes a string for safe use as a URL component (query param value, path segment, etc.). Encodes all characters except unreserved URI characters (A–Z a–z 0–9 - _ . ! ~ * ' ( )).

Use {$url-encode: {full: true}} to encode a complete URL instead of a component — this preserves ://, /, ?, &, =, and other structural characters rather than encoding them.

Non-string inputs are coerced to string before encoding.

Parameters​

  • full (boolean, optional, default false): Use full-URL encoding (encodeURI) rather than component encoding (encodeURIComponent).

Example​

// Encode a query parameter value
new Schema('string').transformer('$url-encode')
// 'hello world & more' → 'hello%20world%20%26%20more'

// Encode a full URL, preserving structural characters
new Schema('string').transformer({'$url-encode': {full: true}})
// 'https://example.com/path with spaces' → 'https://example.com/path%20with%20spaces'

// Build an encoded query string from an object
new Schema('object', {
  q: new Schema('string').transformer('$url-encode'),
  page: new Schema('number'),
})