@aws-sdk/util-uri-escape

What is @aws-sdk/util-uri-escape?

The @aws-sdk/util-uri-escape package is part of the AWS SDK for JavaScript and provides utilities for encoding and decoding URI components. It's specifically designed to handle the quirks of URI encoding in a way that's compatible with AWS service expectations. This can be particularly useful when working with AWS services that require specific encoding of URIs for API requests.

What are @aws-sdk/util-uri-escape's main functionalities?

URI encoding

This feature allows you to encode URI components to ensure they are safe to transmit over the network. It is particularly useful for encoding paths and query parameters that may contain characters which have special meanings in URIs.

"import { escapeUri } from '@aws-sdk/util-uri-escape';\nconst encodedUri = escapeUri('/path/to resource?queryParam=value');"

URI decoding

This feature enables the decoding of URI components. It's useful for parsing encoded URIs to retrieve the original data. This can be particularly important when handling encoded URIs received from web requests or other sources.

"import { unescapeUri } from '@aws-sdk/util-uri-escape';\nconst decodedUri = unescapeUri('%2Fpath%2Fto%20resource%3FqueryParam%3Dvalue');"

Other packages similar to @aws-sdk/util-uri-escape

querystring

The querystring package provides utilities for parsing and formatting URL query strings. It's similar to @aws-sdk/util-uri-escape in that it deals with URL encoding and decoding, but it focuses specifically on the query string portion of the URL.

README

@aws-sdk/util-uri-escape

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.1.0 (2020-12-23)

Bug Fixes

• clients: default region and credential provider (#1834) (bc79ab5)
• clients: populate sdkId in serviceId and default to use arnNamespace as signingName (#1786) (0011af2)
• clients: remove retry headers for several services (#1789) (fc98d2d)
• clients: update endpoint provider (#1824) (64d2210)
• clients: use signing name from auth sigv4 trait (#1835) (e539302)
• codegen: strip names from enums (#1837) (0711503)
• lib-storage: cleanup stream listeners to prevent memory leak (3d36682)
• middleware-user-agent: add middleware to final step of build (#1833) (e7dce39)
• signature-v4: add secrets to signing key cache key (#1776) (8785ad4)
• util-waiter: fix compiling error with waiter (#1812) (ca1f0d6), closes #1803
• log requestId, extendedRequestId, cfId in $metadata (#1819) (f2a47e8)

Features

• credential-provider-node: use credential_process from profile (#1773) (842e2a0), closes #1772
• standardize user agent value (#1775) (388b180)
• cucumber: use waiters in integration tests (#1792) (e151aee)
• middleware-logger: log clientName, commandName, input, output (#1788) (4f9e56f)