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

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

@aws-sdk/util-user-agent-node is a utility package from the AWS SDK for JavaScript. It is used to construct and manage user-agent strings for AWS SDK clients running in Node.js environments. This helps in identifying the SDK version, environment, and other relevant information when making requests to AWS services.

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

Constructing User-Agent String

This feature allows you to construct a default user-agent string that includes information about the SDK version and the runtime environment.

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

Customizing User-Agent String

This feature allows you to customize the user-agent string by adding additional information, such as application-specific details.

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

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

useragent

The 'useragent' package is a comprehensive library for parsing user-agent strings in Node.js. It provides detailed information about the browser, operating system, and device. Unlike @aws-sdk/util-user-agent-node, which is focused on constructing user-agent strings for AWS SDK clients, 'useragent' is more general-purpose and can be used in a variety of applications.

ua-parser-js

The 'ua-parser-js' package is a JavaScript library for parsing user-agent strings and extracting detailed information about the browser, engine, OS, CPU, and device. It is similar to 'useragent' but is designed to be lightweight and fast. While @aws-sdk/util-user-agent-node is specialized for AWS SDK clients, 'ua-parser-js' is suitable for broader use cases.

README

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

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.282.0 (2023-03-01)

Features

• client-codecatalyst: Published Dev Environments StopDevEnvironmentSession API (6458cf1)
• client-pricing: This release adds 2 new APIs - ListPriceLists which returns a list of applicable price lists, and GetPriceListFileUrl which outputs a URL to retrieve your price lists from the generated file from ListPriceLists (f7201bf)
• client-s3outposts: S3 on Outposts introduces a new API ListOutpostsWithS3, with this API you can list all your Outposts with S3 capacity. (9b55483)
• clients: update client endpoints as of 2023-03-01 (a52821d)
• protocol-http: use lowercase keys in Fields class (#4450) (e0db41d)