UNPKG

fetch-api-progress

Version:
31 lines (30 loc) 984 B
export type FetchProgressEvent = { /** * The number of bytes that have been loaded so far. */ readonly loaded: number; } & ({ /** * A Boolean value indicating whether the total size of the data being transferred is known. */ readonly lengthComputable: false; } | { /** * A Boolean value indicating whether the total size of the data being transferred is known. */ readonly lengthComputable: true; /** * The total number of bytes to be loaded. This value is only available if lengthComputable is true. */ readonly total: number; }); /** * Creates a fetch progress event object that describes the current progress (upload or download) of a fetch request. * @param options The progress event data. * @returns An object that contains the progress event data. */ export declare function createProgressEvent(options: { lengthComputable: boolean; loaded: number; total?: number; }): FetchProgressEvent;