An open API service indexing awesome lists of open source software.

https://github.com/letscooee/url-builder

Very simple & lightweight TypeScript library to provide utility for building or parsing the URLs
https://github.com/letscooee/url-builder

browser typescript typescript-library url url-parser

Last synced: about 1 year ago
JSON representation

Very simple & lightweight TypeScript library to provide utility for building or parsing the URLs

Awesome Lists containing this project

README

          

# URL Builder

[![npm version](https://badge.fury.io/js/%40letscooee%2Furl-builder.svg)](https://badge.fury.io/js/%40letscooee%2Furl-builder)
![](https://github.com/letscooee/url-builder/workflows/Build%20And%20Test%20Cases/badge.svg)

A simple wrapper for TypeScript to build & parse a URL.

## Installation

```shell script
npm i @letscooee/url-builder
```

## Usage

```typescript
import {URLBuilder} from '@letscooee/url-builder';

const urlBuilder = new URLBuilder('https://example.com/try?foo=bar&age=20');
urlBuilder.setQueryParam('foo', 'bar-new');
urlBuilder.appendQueryParam('name', 'Jon');

console.log(urlBuilder.toString() === 'https://example.com/try?foo=bar-new&age=20&name=Jon');
console.log(urlBuilder.getQueryParam('foo') === 'bar-new');

urlBuilder.setPath('/save');
urlBuilder.setQueryString('name=Jon&country=India');

console.log(urlBuilder.toString() === 'https://example.com/save?name=Jon&country=India');

urlBuilder.clearQueryParams();
console.log(urlBuilder.toString() === 'https://example.com/save');
```

## Release

```shell script
npm publish --access public
```