npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

url-search-query

v1.0.8

Published

This JavaScript code defines a function addQueryToUrl that adds query parameters to a given URL. It handles strings, numbers, booleans, dates, and arrays of these types, while ignoring functions and invalid types. The function also ensures that the final

Downloads

10

Readme

URL Query Parameter Adder

This TypeScript package provides a utility function to add query parameters to a given URL. It handles various types of values including strings, numbers, booleans, dates, and arrays of these types. It also ensures the URL does not exceed typical browser length limits.

Installation

To install the package, you can use npm or yarn:

with npm:

npm install url-search-query

with yarn:

yarn add url-search-query

Usage

addQueryToUrl

The addQueryToUrl function appends query parameters to a URL.

Parameters

  • url (string): The base URL to which query parameters will be added.
  • query (Record<string, any>): An object representing the query parameters to be added.

Returns

  • A string representing the final URL with the added query parameters.

Example

import { addQueryToUrl } from 'url-search-query';

const query = { 
  view: 'dashboard', 
  component: 'widget', 
  users: ['1', '2'], 
  count: 5, 
  isActive: true, 
  date: new Date('2024-07-17'), 
  invalidProp: { key: 'value' }, 
  func: () => {} 
};
const url = 'https://example.com/?model=new';
const newUrl = addQueryToUrl(url, query);

console.log(newUrl);
// Output: https://example.com/?model=new&view=dashboard&component=widget&users=1&users=2&count=5&isActive=true&date=2024-07-17T00:00:00.000Z

Development

Prerequisites

  • Node.js
  • npm or yarn

Installation

Clone the repository and install dependencies:

git clone https://github.com/MariannaMilovanova/url-search-query.git
cd url-search-query
npm install

Or with yarn:

yarn install

Running Tests

To run the tests, use the following command:

npm test

Or with yarn:

yarn test

Building

To build the project, use the following command:

npm run build

Or with yarn:

yarn build

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.