Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow passing options without output property #174

Merged
merged 1 commit into from
Aug 12, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 55 additions & 24 deletions types/filesize.d.ts
Original file line number Diff line number Diff line change
@@ -1,32 +1,63 @@
export interface FileSizeOptions {
interface FileSizeOptionsBase {
base?: number;
bits?: boolean;
exponent?: number;
fullform?: boolean;
fullforms?: string[];
locale?: string | boolean;
localeOptions?: Intl.DateTimeFormatOptions;
pad?: boolean;
base?: number;
precision?: number;
round?: number;
locale?: string;
localeOptions?: {};
roundingMethod?: 'round' | 'floor' | 'ceil';
separator?: string;
spacer?: string;
symbols?: {};
standard?: 'iec' | 'jedec';
output?: 'array' | 'exponent' | 'object' | 'string';
fullform?: boolean;
fullforms?: any[];
exponent?: number;
roundingMethod?: 'round' | 'floor' | 'ceil';
precision?: number;
symbols?: {
iec: {
bits: string[],
bytes: string[]
},
jedec: {
bits: string[],
bytes: string[]
}
};
}

interface FileSizeOptionsArray extends FileSizeOptionsBase {
output: 'array'
}

interface FileSizeOptionsExponent extends FileSizeOptionsBase {
output: 'exponent'
}

export function filesize(arg: any, { bits, pad, base, round, locale, localeOptions, separator, spacer, symbols, standard, output, fullform, fullforms, exponent, roundingMethod, precision }?: FileSizeOptions): string | number | any[] | {
value: any;
symbol: any;
exponent: number;
unit: string;
};

export function partial({ bits, pad, base, round, locale, localeOptions, separator, spacer, symbols, standard, output, fullform, fullforms, exponent, roundingMethod, precision }?: FileSizeOptions): (arg: any) => string | number | any[] | {
value: any;
symbol: any;
exponent: number;
unit: string;
};
interface FileSizeOptionsObject extends FileSizeOptionsBase {
output: 'object'
}

interface FileSizeOptionsString extends FileSizeOptionsBase {
output: 'string'
}

interface FileSizeReturnObject {
value: string,
symbol: string,
exponent: number,
unit: string,
}

type FileSizeReturnArray = [ number, string ]

export function filesize(byteCount: number, options: FileSizeOptionsString | FileSizeOptionsBase): string
export function filesize(byteCount: number, options: FileSizeOptionsArray): FileSizeReturnArray
export function filesize(byteCount: number, options: FileSizeOptionsExponent): number
export function filesize(byteCount: number, options: FileSizeOptionsObject): FileSizeReturnObject
export function filesize(byteCount: number): string

export function partial(options: FileSizeOptionsString | FileSizeOptionsBase): (byteCount: number) => string
export function partial(options: FileSizeOptionsArray): (byteCount: number) => FileSizeReturnArray
export function partial(options: FileSizeOptionsExponent): (byteCount: number) => number
export function partial(options: FileSizeOptionsObject): (byteCount: number) => FileSizeReturnObject
export function partial(): (byteCount: number) => string