@aws-sdk/util-format-url

What is @aws-sdk/util-format-url?

@aws-sdk/util-format-url is a utility package from AWS SDK for JavaScript that provides functions to format URLs. It is particularly useful when working with AWS services and needing to construct or manipulate URLs in a consistent and reliable manner.

What are @aws-sdk/util-format-url's main functionalities?

formatUrl

The `formatUrl` function constructs a URL string from an object containing URL components such as protocol, hostname, path, and query parameters.

{"import":"import { formatUrl } from '@aws-sdk/util-format-url';","example":"const url = formatUrl({ protocol: 'https', hostname: 'example.com', path: '/path', query: { key: 'value' } });\nconsole.log(url); // Outputs: 'https://example.com/path?key=value'"}

Other packages similar to @aws-sdk/util-format-url

url

The 'url' package is a Node.js core module that provides utilities for URL resolution and parsing. It offers similar functionalities to @aws-sdk/util-format-url, such as constructing and parsing URLs, but it is more general-purpose and not specifically tailored for AWS services.

query-string

The 'query-string' package is a utility for parsing and stringifying URL query strings. It provides more advanced features for handling query parameters compared to @aws-sdk/util-format-url, but it does not handle the full URL construction.

url-parse

The 'url-parse' package is a lightweight URL parser that works in both Node.js and the browser. It offers similar URL parsing and formatting capabilities as @aws-sdk/util-format-url but is designed to be more lightweight and versatile.

README

@aws-sdk/util-format-url

Changelog

3.609.0 (2024-07-02)

Features

• client-ec2: Documentation updates for Elastic Compute Cloud (EC2). (c155b9e)
• client-fms: Increases Customer API's ManagedServiceData length (b5ca023)
• client-s3: Added response overrides to Head Object requests. (ac9f3d2)