GuidesChangelogTypeScript API ReferencePython v2 API Reference

UrlBuilder

Helper class that builds URLs from a baseUrl and given query parameters

Hierarchy

  • UrlBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

  • new UrlBuilder(url: string, hasQuery?: boolean): UrlBuilder

Properties

hasQuery

hasQuery: boolean = false

url

url: string

Methods

appendQuery

  • appendQuery(key: string, value?: string | number | boolean | string[] | number[], operator?: string): void

  • Appends a query parameter to the URL, either using '&key=value' or '?key=value' depending on the hasQuery parameter.

    Escapes all strings using encodeURIComponent.

    String arrays are concatenated using commas.

    Parameters

    • key: string

      The key of the query parameter.

    • Optional value: string | number | boolean | string[] | number[]

      The value of the query parameter.

    • operator: string = "="

    Returns void

Static stringifyQuery

  • stringifyQuery(values: ): string

Static toString

  • toString(param: string | number): string

olp- sdk- dataservice- api

Url Builder