ratelimit-header-parser/dist/index.d.ts

Parse RateLimit headers of various forms, including the combined form from draft 7 of the IETF standard, into a normalized format.

// Generated by dts-bundle-generator v8.0.1

import { IncomingHttpHeaders, OutgoingHttpHeaders, ServerResponse } from 'node:http';

export type RateLimit = {
	limit: number;
	used: number;
	remaining: number;
	reset?: Date;
};
export type RateLimitOptions = {
	reset?: "date" | "unix" | "seconds" | "milliseconds";
};
export type ResponseObject = ServerResponse | Response;
export type HeadersObject = IncomingHttpHeaders | OutgoingHttpHeaders | Headers | {
	[key: string]: string | string[];
};
export type ResponseOrHeadersObject = ResponseObject | HeadersObject;
export declare function parseRateLimit(input: ResponseOrHeadersObject, options?: RateLimitOptions): RateLimit | undefined;

export {};