Skip to content

Tweaking types and removing any usage #172

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

Merged
merged 1 commit into from Aug 7, 2023
Merged
Show file tree
Hide file tree
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
33 changes: 15 additions & 18 deletions types/constants.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,20 @@ export const SI_KBYTE: "kB";
export const SPACE: " ";
export const STRING: "string";
export const ZERO: "0";
export namespace STRINGS {
namespace symbol {
namespace iec {
const bits: string[];
const bytes: string[];

export const STRINGS: {
symbol: {
iec: {
bits: string[],
bytes: string[]
},
jedec: {
bits: string[],
bytes: string[],
}
namespace jedec {
const bits_1: string[];
export { bits_1 as bits };
const bytes_1: string[];
export { bytes_1 as bytes };
}
}
namespace fullform {
const iec_1: string[];
export { iec_1 as iec };
const jedec_1: string[];
export { jedec_1 as jedec };
},
fullform: {
iec: string[],
jedec: string[]
}
}
}
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';
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very important to not change the behaviour of.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are correct. This was also not changed, but rather I overlooked the case that if other options are given and NOT output it also should return string and not force the setting of output. I will wait on the issue opener to create a PR, otherwise I can if wanted.

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): 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): (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