@types/range-parser
Advanced tools
Package description
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.
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');This package provides functionality to fetch partial content from HTTP resources. It is similar to @types/range-parser in that it deals with HTTP ranges, but it focuses more on the fetching aspect rather than just parsing the range headers.
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
npm install --save @types/range-parser
This package contains type definitions for range-parser (https://github.com/jshttp/range-parser).
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/range-parser.
/**
* 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;
These definitions were written by Tomek Łaziuk.
FAQs
TypeScript definitions for range-parser
The npm package @types/range-parser receives a total of 17,230,462 weekly downloads. As such, @types/range-parser popularity was classified as popular.
We found that @types/range-parser demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.