@types/range-parser

What is @types/range-parser?

The @types/range-parser package provides TypeScript type definitions for the range-parser package. This allows TypeScript developers to use the range-parser package in a type-safe manner, ensuring that they are using the API correctly according to the expected types. The range-parser package is used to parse HTTP Range header fields, which are commonly used to specify a portion of a document to be returned by the server, enabling efficient partial data fetching.

What are @types/range-parser's main functionalities?

Parsing Range Headers

This feature allows you to parse the 'Range' header from HTTP requests. The example demonstrates parsing a range string 'bytes=0-499' assuming the total size is 1000. The result would be an array indicating the start and end of the range requested.

import rangeParser from 'range-parser';
const result = rangeParser(1000, 'bytes=0-499');

Other packages similar to @types/range-parser

content-range

Similar to @types/range-parser, this package deals with content ranges in HTTP headers. However, it focuses on generating and parsing Content-Range headers for responses, complementing the functionality provided by range-parser for requests.

README

Installation

npm install --save @types/range-parser

Summary

This package contains type definitions for range-parser (https://github.com/jshttp/range-parser).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/range-parser.

index.d.ts

/**
 * When ranges are returned, the array has a "type" property which is the type of
 * range that is required (most commonly, "bytes"). Each array element is an object
 * with a "start" and "end" property for the portion of the range.
 *
 * @returns `-1` when unsatisfiable and `-2` when syntactically invalid, ranges otherwise.
 */
declare function RangeParser(
    size: number,
    str: string,
    options?: RangeParser.Options,
): RangeParser.Result | RangeParser.Ranges;

declare namespace RangeParser {
    interface Ranges extends Array<Range> {
        type: string;
    }
    interface Range {
        start: number;
        end: number;
    }
    interface Options {
        /**
         * The "combine" option can be set to `true` and overlapping & adjacent ranges
         * will be combined into a single range.
         */
        combine?: boolean | undefined;
    }
    type ResultUnsatisfiable = -1;
    type ResultInvalid = -2;
    type Result = ResultUnsatisfiable | ResultInvalid;
}

export = RangeParser;

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Tomek Łaziuk.