@aws-sdk/util-user-agent-browser

What is @aws-sdk/util-user-agent-browser?

@aws-sdk/util-user-agent-browser is a utility package from the AWS SDK for JavaScript that helps in constructing and managing user-agent strings for browser environments. This is particularly useful for tracking and identifying the usage of different AWS SDK clients and services in web applications.

What are @aws-sdk/util-user-agent-browser's main functionalities?

Constructing User-Agent Strings

This feature allows you to construct a default user-agent string that can be used in HTTP requests made by AWS SDK clients. The user-agent string includes information about the SDK version, platform, and other relevant details.

const { defaultUserAgent } = require('@aws-sdk/util-user-agent-browser');
const userAgent = defaultUserAgent();
console.log(userAgent);

Customizing User-Agent Strings

This feature allows you to customize the user-agent string by adding additional information such as application-specific details. This can be useful for tracking and debugging purposes.

const { defaultUserAgent } = require('@aws-sdk/util-user-agent-browser');
const customUserAgent = defaultUserAgent({ custom: 'myApp/1.0.0' });
console.log(customUserAgent);

Other packages similar to @aws-sdk/util-user-agent-browser

useragent

The 'useragent' package is a comprehensive library for parsing and handling user-agent strings. It provides detailed information about the browser, operating system, and device. Compared to @aws-sdk/util-user-agent-browser, 'useragent' offers more extensive parsing capabilities but is not specifically tailored for AWS SDK usage.

ua-parser-js

The 'ua-parser-js' package is a lightweight JavaScript library for parsing user-agent strings. It can identify the browser, engine, OS, and device from a user-agent string. While it offers similar functionality in terms of parsing user-agent strings, it does not provide the AWS-specific customizations available in @aws-sdk/util-user-agent-browser.

README

@aws-sdk/util-user-agent-browser

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.731.0 (2025-01-17)

Bug Fixes

• credential-providers: supply backup credentials to fromTemporaryCredentials (#6817) (891e091)
• fix key ordering for code generation build (#6821) (67c0a58)
• nested-clients: fix inliner build script (#6820) (a818f3e)

Features

• client-bedrock-runtime: Allow hyphens in tool name for Converse and ConverseStream APIs (71256d8)
• client-ec2: Release u7i-6tb.112xlarge, u7i-8tb.112xlarge, u7inh-32tb.480xlarge, p5e.48xlarge, p5en.48xlarge, f2.12xlarge, f2.48xlarge, trn2.48xlarge instance types. (8fa946c)
• client-notifications: Added support for Managed Notifications, integration with AWS Organization and added aggregation summaries for Aggregate Notifications (53d862b)
• clients: update client endpoints as of 2025-01-17 (3995e76)