Function urlQueryEncode

  • Encode the properties of an object as a URL query string.

    If an object property has an array value, multiple URL parameters will be encoded for that property.

    The optional encoderFn argument is a function that accepts a string value and should return a URI-safe string for that value.

    Parameters

    • parameters: Record<string, any>

      an object to encode as URL parameters

    • Optional encoderFn: ((uriComponent) => string)

      an optional function to encode each URI component with; if not provided the built-in encodeURIComponent() function will be used

        • (uriComponent): string

        • Parameters

          • uriComponent: string | number | boolean

          Returns string

    Returns string

    the encoded query parameters

Settings

Member Visibility

Theme

Generated using TypeDoc