Website Structure

Frontend-Learner/node_modules/pretty-bytes/index.d.ts

@@ -0,0 +1,181 @@
+export type Options = {
+	/**
+	Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.
+
+	@default false
+	*/
+	readonly signed?: boolean;
+
+	/**
+	- If `false`: Output won't be localized.
+	- If `true`: Localize the output using the system/browser locale.
+	- If `string`: Expects a [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)
+	- If `string[]`: Expects a list of [BCP 47 language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)
+
+	@default false
+	*/
+	readonly locale?: boolean | string | readonly string[];
+
+	/**
+	Format the number as [bits](https://en.wikipedia.org/wiki/Bit) instead of [bytes](https://en.wikipedia.org/wiki/Byte). This can be useful when, for example, referring to [bit rate](https://en.wikipedia.org/wiki/Bit_rate).
+
+	@default false
+
+	@example
+	```
+	import prettyBytes from 'pretty-bytes';
+
+	prettyBytes(1337, {bits: true});
+	//=> '1.34 kbit'
+	```
+	*/
+	readonly bits?: boolean;
+
+	/**
+	Format the number using the [Binary Prefix](https://en.wikipedia.org/wiki/Binary_prefix) instead of the [SI Prefix](https://en.wikipedia.org/wiki/SI_prefix). This can be useful for presenting memory amounts. However, this should not be used for presenting file sizes.
+
+	@default false
+
+	@example
+	```
+	import prettyBytes from 'pretty-bytes';
+
+	prettyBytes(1000, {binary: true});
+	//=> '1000 B'
+
+	prettyBytes(1024, {binary: true});
+	//=> '1 KiB'
+	```
+	*/
+	readonly binary?: boolean;
+
+	/**
+	The minimum number of fraction digits to display.
+
+	@default undefined
+
+	If neither `minimumFractionDigits` nor `maximumFractionDigits` is set, the default behavior is to round to 3 significant digits.
+
+	Note: When `minimumFractionDigits` or `maximumFractionDigits` is specified, values are truncated instead of rounded to provide more intuitive results for file sizes.
+
+	@example
+	```
+	import prettyBytes from 'pretty-bytes';
+
+	// Show the number with at least 3 fractional digits
+	prettyBytes(1900, {minimumFractionDigits: 3});
+	//=> '1.900 kB'
+
+	prettyBytes(1900);
+	//=> '1.9 kB'
+	```
+	*/
+	readonly minimumFractionDigits?: number;
+
+	/**
+	The maximum number of fraction digits to display.
+
+	@default undefined
+
+	If neither `minimumFractionDigits` nor `maximumFractionDigits` is set, the default behavior is to round to 3 significant digits.
+
+	Note: When `minimumFractionDigits` or `maximumFractionDigits` is specified, values are truncated instead of rounded to provide more intuitive results for file sizes.
+
+	@example
+	```
+	import prettyBytes from 'pretty-bytes';
+
+	// Show the number with at most 1 fractional digit
+	prettyBytes(1920, {maximumFractionDigits: 1});
+	//=> '1.9 kB'
+
+	prettyBytes(1920);
+	//=> '1.92 kB'
+	```
+	*/
+	readonly maximumFractionDigits?: number;
+
+	/**
+	Put a space between the number and unit.
+
+	@default true
+
+	@example
+	```
+	import prettyBytes from 'pretty-bytes';
+
+	prettyBytes(1920, {space: false});
+	//=> '1.92kB'
+
+	prettyBytes(1920);
+	//=> '1.92 kB'
+	```
+	*/
+	readonly space?: boolean;
+
+	/**
+	Use a non-breaking space instead of a regular space to prevent the unit from wrapping to a new line.
+
+	Has no effect when `space` is `false`.
+
+	@default false
+	*/
+	readonly nonBreakingSpace?: boolean;
+
+	/**
+	Pad the output to a fixed width by right-aligning it.
+
+	Useful for creating aligned columns in tables or progress bars.
+
+	If the output is longer than the specified width, no padding is applied.
+
+	Must be a non-negative integer. Throws a `TypeError` for invalid values.
+
+	@default undefined
+
+	@example
+	```
+	import prettyBytes from 'pretty-bytes';
+
+	prettyBytes(1337, {fixedWidth: 10});
+	//=> '   1.34 kB'
+
+	prettyBytes(100_000, {fixedWidth: 10});
+	//=> '  100 kB'
+
+	// Useful for progress bars and tables
+	[1000, 10_000, 100_000].map(bytes => prettyBytes(bytes, {fixedWidth: 8}));
+	//=> ['   1 kB', '  10 kB', ' 100 kB']
+	```
+	*/
+	readonly fixedWidth?: number;
+};
+
+/**
+Convert bytes to a human readable string: `1337` → `1.34 kB`.
+
+@param number - The number to format.
+
+@example
+```
+import prettyBytes from 'pretty-bytes';
+
+prettyBytes(1337);
+//=> '1.34 kB'
+
+prettyBytes(100);
+//=> '100 B'
+
+// Display file size differences
+prettyBytes(42, {signed: true});
+//=> '+42 B'
+
+// Localized output using German locale
+prettyBytes(1337, {locale: 'de'});
+//=> '1,34 kB'
+```
+*/
+export default function prettyBytes(
+	number: number | bigint,
+	options?: Options
+): string;