Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

build-url-params

dwashkarma109MIT0.0.5TypeScript support: included

A utility to build URLs with query parameters

build-parmas, url-params, query-params, parameters

readme

build-url-params

A lightweight utility to build URLs with query parameters, automatically filtering out empty (""), null, and undefined values.

📦 Installation

Install the package using npm:

npm install build-url-params

Or with Yarn:

yarn add build-url-params

🚀 Usage

Import the function:

import { buildUrlWithParams } from "build-url-params";

const url = "https://example.com";
const params = {
  search: "query",
  page: 1,
  filter: null,
  sort: undefined,
};

const result = buildUrlWithParams(url, params);
console.log(result); // "https://example.com?search=query&page=1"

✅ Features

  • Automatically removes null, undefined, and empty string values
  • Supports basic query parameter encoding
  • Tiny, fast, and dependency-free

🧪 Examples

buildUrlWithParams("https://api.site.com", {
  name: "Dwash_Karma",
  role: "admin",
});
// Output: "https://api.site.com?name=Dwash_Karma&role=admin"

📄 License

MIT

🤝 Contributing

Contributions, issues, and feature requests are welcome!