Class URLBuilder

A utility class that can be used to build URLs. This makes it useful for implementing HttpRequest.

Hierarchy

URLBuilder

Index

Constructors

Methods

build queryParam queryParams

Constructors

constructor

new URLBuilder(url): URLBuilder
Parameters
- url: string
  
  The base URL. It should not contain any query string yet.
Returns URLBuilder

Methods

build

build(): string
Builds a full URL.

Returns string
A URL built from the base URL and all added query parameters.

queryParam

queryParam(name, value?): URLBuilder
Adds a query parameter. Does nothing if the value is undefined.
Parameters
- name: string
  
  The name for the query parameter.
- Optional value: string | number | boolean
  
  The value for the query parameter.
Returns URLBuilder
This URL builder object.

queryParams

queryParams(name, values?): URLBuilder
Adds several query parameters with the same name. Does nothing if the value is undefined.
Parameters
- name: string
  
  The name for each of the query parameters.
- Optional values: string[] | number[] | boolean[]
  
  The values for the query parameters.
Returns URLBuilder
This URL builder object.