@aws-sdk/util-body-length-node

What is @aws-sdk/util-body-length-node?

The @aws-sdk/util-body-length-node package is a utility module from the AWS SDK for JavaScript (v3). It is designed to calculate the body length of HTTP requests in Node.js environments. This is particularly useful when working with AWS services that require content-length headers for request validation. The package provides a straightforward API to accurately determine the length of various types of request bodies, including Buffer, Blob, and string objects.

What are @aws-sdk/util-body-length-node's main functionalities?

Calculate Buffer Body Length

This feature allows you to calculate the length of a Buffer object. It is useful when you need to determine the size of a binary file or data stream before sending it in an HTTP request.

const { calculateBodyLength } = require('@aws-sdk/util-body-length-node');
const buffer = Buffer.from('Hello World');
const length = calculateBodyLength(buffer);
console.log(length); // Outputs: 11

Calculate String Body Length

This feature enables the calculation of the length of a string. It's beneficial when dealing with textual data, ensuring you can set the correct content-length header for HTTP requests.

const { calculateBodyLength } = require('@aws-sdk/util-body-length-node');
const stringBody = 'Hello World';
const length = calculateBodyLength(stringBody);
console.log(length); // Outputs: 11

Other packages similar to @aws-sdk/util-body-length-node

content-length

The 'content-length' package offers functionality to calculate the content length of given data. It supports strings, buffers, and streams. Compared to @aws-sdk/util-body-length-node, it provides broader support for different types of data, including streams, but it is not specifically optimized for or tied to AWS SDK usage.

byte-length

The 'byte-length' package is another utility for calculating the byte length of strings in various encodings. While it focuses on string data and supports multiple encodings, @aws-sdk/util-body-length-node is more focused on AWS SDK integration and supports both Buffer and string types directly.

README

@aws-sdk/util-body-length-node

Determines the length of a request body in node.js

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.4.0 (2021-01-28)

Bug Fixes

• allow packages/types in gitignore (#1942) (b4b6fad)
• credential-provider-cognito-identity: remove duplicate declarationDir (#1944) (d75488a)
• generate-clients: call mergeManifest when constructor.name is Object (#1937) (601c03b)

Features

• middleware-stack: allow adding middleware to override an existing one (#1964) (9c21f14), closes #1883
• util-dynamodb: add option to convert class instance to map (#1969) (1783c69)
• run prettier in parallel in generate-clients (#1949) (878617a)
• use downlevel-dts to generate TS 3.4 compatible types (#1943) (63ad215)