@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.374.0 (2023-07-20)

Bug Fixes

• packages: fix migrated package imports (#4990) (d800f78)

Features

• client-codecatalyst: This release adds support for updating and deleting spaces and projects in Amazon CodeCatalyst. It also adds support for creating, getting, and deleting source repositories in CodeCatalyst projects. (05a9f89)
• client-connectcases: This release adds the ability to assign a case to a queue or user. (f47d6f4)
• client-lex-models-v2: This release updates type for Channel field in SessionSpecification and UtteranceSpecification (1f77d0a)
• client-route53resolver: This release adds support for Route 53 On Outposts, a new feature that allows customers to run Route 53 Resolver and Resolver endpoints locally on their Outposts. (8acc64c)
• client-s3: Improve performance of S3 clients by simplifying and optimizing endpoint resolution. (72eb598)
• client-sagemaker-featurestore-runtime: Cross account support for SageMaker Feature Store (b0593ab)
• client-sagemaker: Cross account support for SageMaker Feature Store (e4918c1)
• client-securitylake: Adding support for Tags on Create and Resource Tagging API. (596636d)
• client-transcribe: Added API argument --toxicity-detection to startTranscriptionJob API, which allows users to view toxicity scores of submitted audio. (9e7552a)
• smithy-client: update client defaults provider (830cb06)