dt-utils / generateUrlWithQuery

Function: generateUrlWithQuery()

generateUrlWithQuery(pathname, queryParams): string

Defined in: generateUrlWithQuery/index.ts:32

Generate URL with query parameters.

Parameters

pathname

string

Base URL path (e.g., '/api/users')

queryParams

QueryParams = {}

Query parameters object (e.g., { id: 123, name: 'john' })

Returns

string

Complete URL string

Description

This utility function combines a base URL path with query parameters to create a complete URL string. It automatically handles parameter encoding and removes invalid values.

Example

import { generateUrlWithQuery } from 'dt-utils';

// Basic usage
generateUrlWithQuery('/api/users', { id: 123 }) // => '/api/users?id=123'

// Multiple parameters
generateUrlWithQuery('/search', { q: 'test', page: 1, sort: 'desc' }) // => '/search?q=test&page=1&sort=desc'

// Handles invalid values
generateUrlWithQuery('/api/data', { id: 123, name: null, status: undefined }) // => '/api/data?id=123'