@types/file-size

Installation

npm install --save @types/file-size

Summary

This package contains type definitions for file-size (https://github.com/Nijikokun/file-size).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/file-size.

index.d.ts

interface Options {
    fixed?: number | undefined;
    spacer?: string | undefined;
}

type Spec = "si" | "iec" | "jedec";

type Unit = "B" | "KB" | "MB" | "GB" | "TB" | "PB" | "EB" | "ZB" | "YB";

interface Bits {
    result: number;
    fixed: string;
}

interface Calculated {
    suffix: string;
    magnitude: number;
    result: number;
    fixed: string;
    bits: Bits;
}

interface Result {
    human(spec?: Spec): string;
    to(unit: Unit, spec?: Spec): string;
    calculate(spec?: Spec): Calculated;
}

declare function fileSize<T extends Options>(bytes: number, options?: T): Required<T> & Result;

export as namespace filesize;

export = fileSize;

Additional Details

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

Credits

These definitions were written by Richie Bendall.