@hapi/ammo

What is @hapi/ammo?

@hapi/ammo is a utility library for HTTP payload processing, specifically designed to handle HTTP payload ranges. It is part of the hapi ecosystem and is used to parse and validate HTTP Range headers, which are often used for partial content delivery.

What are @hapi/ammo's main functionalities?

Range Parsing

This feature allows you to parse the 'Range' HTTP header and determine the byte ranges requested by the client. The `Ammo.header` function takes the range header and the total length of the resource, returning an array of ranges.

const Ammo = require('@hapi/ammo');

const rangeHeader = 'bytes=0-4,9-15';
const length = 20;
const ranges = Ammo.header(rangeHeader, length);

console.log(ranges);

Range Validation

This feature validates the parsed ranges to ensure they are within the bounds of the resource length. If the ranges are valid, it returns an array of ranges; otherwise, it returns null.

const Ammo = require('@hapi/ammo');

const rangeHeader = 'bytes=0-4,9-15';
const length = 20;
const ranges = Ammo.header(rangeHeader, length);

if (ranges) {
  console.log('Valid ranges:', ranges);
} else {
  console.log('Invalid range header');
}

Other packages similar to @hapi/ammo

range-parser

The 'range-parser' package is a utility for parsing HTTP Range headers. It provides similar functionality to @hapi/ammo by parsing range headers and returning the requested ranges. However, it is a more lightweight and standalone package compared to @hapi/ammo, which is part of the larger hapi ecosystem.

README

@hapi/ammo

HTTP Range processing utilities.

ammo is part of the hapi ecosystem and was designed to work seamlessly with the hapi web framework and its other components (but works great on its own or with other frameworks). If you are using a different web framework and find this module useful, check out hapi – they work even better together.

Visit the hapi.dev Developer Portal for tutorials, documentation, and support

Useful resources

• Documentation and API
• Versions status (builds, dependencies, node versions, licenses, eol)
• Project policies
• Free and commercial support options