Convert localeOptions to minimumFractionDigits and maximumFractionDig…

…its.

index.d.ts

@@ -19,25 +19,6 @@ declare namespace prettyBytes {
 		*/
 		readonly locale?: boolean | string | readonly string[];
 
-		/**
-		[NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat) international localization options.
-
-		The options `minimumFractionDigits` and `maximumFractionDigits` can be used to control the number of fractional digits displayed.
-
-		@default undefined
-
-		```
-		import prettyBytes = require('pretty-bytes');
-
-		prettyBytes(1900, {localeOptions: {maximumFractionDigits: 1}});
-		//=> '1.9 kB'
-
-		prettyBytes(1900, {localeOptions: {minimumFractionDigits: 3}});
-		//=> '1.900 kB'
-		```
-		*/
-		readonly localeOptions?: object;
-
 		/**
 		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).
 
@@ -70,6 +51,35 @@ declare namespace prettyBytes {
 		```
 		*/
 		readonly binary?: boolean;
+
+		/**
+		The minimum number of fraction digits to display.
+
+		@default undefined
+
+		```
+		import prettyBytes = require('pretty-bytes');
+
+		prettyBytes(1900, {minimumFractionDigits: 3});
+		//=> '1.900 kB'
+		```
+		*/
+		readonly minimumFractionDigits?: number;
+
+
+		/**
+		The maximum number of fraction digits to display.
+
+		@default undefined
+
+		```
+		import prettyBytes = require('pretty-bytes');
+
+		prettyBytes(1900, {maximumFractionDigits: 1});
+		//=> '1.9 kB'
+		```
+		*/
+		readonly maximumFractionDigits?: number;
 	}
 }
 

index.js

@@ -87,22 +87,34 @@ module.exports = (number, options) => {
 		number = -number;
 	}
 
-	const locale = !options.locale && options.localeOptions ? true : options.locale;
+	// eslint-disable-next-line prefer-destructuring
+	let locale = options.locale;
+	let localeOptions;
+
+	if (options.minimumFractionDigits !== undefined) {
+		localeOptions = {minimumFractionDigits: options.minimumFractionDigits};
+		locale = locale || true;
+	}
+
+	if (options.maximumFractionDigits !== undefined) {
+		localeOptions = {...localeOptions, maximumFractionDigits: options.maximumFractionDigits};
+		locale = locale || true;
+	}
 
 	if (number < 1) {
-		const numberString = toLocaleString(number, locale, options.localeOptions);
+		const numberString = toLocaleString(number, locale, localeOptions);
 		return prefix + numberString + ' ' + UNITS[0];
 	}
 
 	const exponent = Math.min(Math.floor(options.binary ? Math.log(number) / Math.log(1024) : Math.log10(number) / 3), UNITS.length - 1);
 	// eslint-disable-next-line unicorn/prefer-exponentiation-operator
 	number /= Math.pow(options.binary ? 1024 : 1000, exponent);
 
-	if (!options.localeOptions) {
+	if (!localeOptions) {
 		number = number.toPrecision(3);
 	}
 
-	const numberString = toLocaleString(Number(number), locale, options.localeOptions);
+	const numberString = toLocaleString(Number(number), locale, localeOptions);
 
 	const unit = UNITS[exponent];
 

readme.md

@@ -85,25 +85,36 @@ Default: `false` *(No localization)*
 
 **Note:** Localization should generally work in browsers. Node.js needs to be [built](https://github.com/nodejs/node/wiki/Intl) with `full-icu` or `system-icu`. Alternatively, the [`full-icu`](https://github.com/unicode-org/full-icu-npm) module can be used to provide support at runtime. [Node.js 13](https://nodejs.org/en/blog/release/v13.0.0/) and later ships with ICU by default.
 
-##### localeOptions
+##### minimumFractionDigits
 
-Type: `object`\
+Type: `number`\
 Default: `undefined`
 
-[NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat) international localization options. The options `minimumFractionDigits` and `maximumFractionDigits` can be used to control the number of fractional digits displayed.
+The minimum number of fraction digits to display.
 
 ```js
 const prettyBytes = require('pretty-bytes');
 
-// Show number with at most 1 fractional digit
-prettyBytes(1900, {localeOptions: {maximumFractionDigits: 1}});
-//=> '1.9 kB'
-
 // Show number with at least 3 fractional digits
-prettyBytes(1900, {localeOptions: {minimumFractionDigits: 3}});
+prettyBytes(1900, {minimumFractionDigits: 3});
 //=> '1.900 kB'
 ```
 
+##### maximumFractionDigits
+
+Type: `number`\
+Default: `undefined`
+
+The maximum number of fraction digits to display.
+
+```js
+const prettyBytes = require('pretty-bytes');
+
+// Show number with at most 1 fractional digit
+prettyBytes(1900, {maximumFractionDigits: 1});
+//=> '1.9 kB'
+```
+
 ## Related
 
 - [pretty-bytes-cli](https://github.com/sindresorhus/pretty-bytes-cli) - CLI for this module

test.js

@@ -74,18 +74,6 @@ test('locale option', t => {
 	}
 });
 
-test('localeOptions option', t => {
-	t.is(prettyBytes(1900, {localeOptions: {maximumFractionDigits: 1}}), '1.9 kB');
-	t.is(prettyBytes(1900, {localeOptions: {minimumFractionDigits: 3}}), '1.900 kB');
-	t.is(prettyBytes(1911, {localeOptions: {maximumFractionDigits: 1}}), '1.9 kB');
-	t.is(prettyBytes(1111, {localeOptions: {maximumFractionDigits: 2}}), '1.11 kB');
-	t.is(prettyBytes(1019, {localeOptions: {maximumFractionDigits: 3}}), '1.019 kB');
-	t.is(prettyBytes(1001, {localeOptions: {maximumFractionDigits: 3}}), '1.001 kB');
-	t.is(prettyBytes(4001, {localeOptions: {maximumFractionDigits: 3}, binary: true}), '3.907 kiB');
-	t.is(prettyBytes(18717, {localeOptions: {maximumFractionDigits: 2}, binary: true}), '18.28 kiB');
-	t.is(prettyBytes(18717, {localeOptions: {maximumFractionDigits: 4}, binary: true}), '18.2783 kiB');
-});
-
 test('signed option', t => {
 	t.is(prettyBytes(42, {signed: true}), '+42 B');
 	t.is(prettyBytes(-13, {signed: true}), '-13 B');
@@ -125,3 +113,15 @@ test('bits and binary option', t => {
 	t.is(prettyBytes(1025, {bits: true, binary: true}), '1 kibit');
 	t.is(prettyBytes(1e6, {bits: true, binary: true}), '977 kibit');
 });
+
+test('fraction digits option', t => {
+	t.is(prettyBytes(1900, {maximumFractionDigits: 1}), '1.9 kB');
+	t.is(prettyBytes(1900, {minimumFractionDigits: 3}), '1.900 kB');
+	t.is(prettyBytes(1911, {maximumFractionDigits: 1}), '1.9 kB');
+	t.is(prettyBytes(1111, {maximumFractionDigits: 2}), '1.11 kB');
+	t.is(prettyBytes(1019, {maximumFractionDigits: 3}), '1.019 kB');
+	t.is(prettyBytes(1001, {maximumFractionDigits: 3}), '1.001 kB');
+	t.is(prettyBytes(4001, {maximumFractionDigits: 3, binary: true}), '3.907 kiB');
+	t.is(prettyBytes(18717, {maximumFractionDigits: 2, binary: true}), '18.28 kiB');
+	t.is(prettyBytes(18717, {maximumFractionDigits: 4, binary: true}), '18.2783 kiB');
+});