@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.713.0 (2024-12-16)

Features

• client-dlm: This release adds support for Local Zones in Amazon Data Lifecycle Manager EBS snapshot lifecycle policies. (36c9b5a)
• client-ec2: This release adds support for EBS local snapshots in AWS Dedicated Local Zones, which allows you to store snapshots of EBS volumes locally in Dedicated Local Zones. (0a3b2ac)
• client-greengrassv2: Add support for runtime in GetCoreDevice and ListCoreDevices APIs. (8ea87b4)
• client-medialive: AWS Elemental MediaLive adds three new features: MediaPackage v2 endpoint support for live stream delivery, KLV metadata passthrough in CMAF Ingest output groups, and Metadata Name Modifier in CMAF Ingest output groups for customizing metadata track names in output streams. (7567d64)
• client-rds: This release adds support for the "MYSQL_CACHING_SHA2_PASSWORD" enum value for RDS Proxy ClientPasswordAuthType. (8afc56c)
• clients: update command documentation examples as of 2024-12-16 (fbec847)
• credential-providers: make credential providers aware of caller client region (#6726) (a65995f)