@stryke/string-format 0.13.2 → 0.13.3

package/dist/period-split.mjs

@@ -1,2 +1,38 @@
-import{EMPTY_STRING as e}from"./types/src/base.mjs";import{upperCaseFirst as t}from"./upper-case-first.mjs";function n(e){return e?/^[a-z]+(?:\.[a-z0-9]+)*$/.test(e):!1}function r(r){if(!r||n(r))return r;let i=r?.replace(/[A-Z]+/g,n=>t(n)??e)?.split(/(?=[A-Z])|[\s._-]/).map(e=>e.toLowerCase())??[];return i.length===0?``:i.length===1?i[0]:i.reduce((e,t)=>`${e}.${t.toLowerCase()}`.toLowerCase())}export{n as isPeriodSplit,r as periodSplit};
+import { EMPTY_STRING } from "./types/src/base.mjs";
+import { upperCaseFirst } from "./upper-case-first.mjs";
+
+//#region src/period-split.ts
+/**
+* Check if the input string is in snake case.
+*
+* @remarks
+* Snake case is defined as all lowercase letters with underscores separating words - "this_is_an_example"
+*
+* @param input - The input string to check.
+* @returns True if the input is in snake case, false otherwise.
+*/
+function isPeriodSplit(input) {
+	return input ? /^[a-z]+(?:\.[a-z0-9]+)*$/.test(input) : false;
+}
+/**
+* Make all characters lowercase and add a period in between each word
+*
+* @remarks
+* "this.is.an.example"
+*
+* @param input - The input string.
+* @returns The period-split string.
+*/
+function periodSplit(input) {
+	if (!input || isPeriodSplit(input)) return input;
+	const parts = input?.replace(/[A-Z]+/g, (input$1) => upperCaseFirst(input$1) ?? EMPTY_STRING)?.split(/(?=[A-Z])|[\s._-]/).map((x) => x.toLowerCase()) ?? [];
+	if (parts.length === 0) return "";
+	if (parts.length === 1) return parts[0];
+	return parts.reduce((ret, part) => {
+		return `${ret}.${part.toLowerCase()}`.toLowerCase();
+	});
+}
+
+//#endregion
+export { isPeriodSplit, periodSplit };
 //# sourceMappingURL=period-split.mjs.map

package/dist/period-split.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"period-split.mjs","names":["input"],"sources":["../src/period-split.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { EMPTY_STRING } from \"@stryke/types\";\nimport { upperCaseFirst } from \"./upper-case-first\";\n\n/**\n * Check if the input string is in snake case.\n *\n * @remarks\n * Snake case is defined as all lowercase letters with underscores separating words - \"this_is_an_example\"\n *\n * @param input - The input string to check.\n * @returns True if the input is in snake case, false otherwise.\n */\nexport function isPeriodSplit(input: string | undefined): boolean {\n  return input ? /^[a-z]+(?:\\.[a-z0-9]+)*$/.test(input) : false;\n}\n\n/**\n * Make all characters lowercase and add a period in between each word\n *\n * @remarks\n * \"this.is.an.example\"\n *\n * @param input - The input string.\n * @returns The period-split string.\n */\nexport function periodSplit<T extends string | undefined>(input?: T): T {\n  if (!input || isPeriodSplit(input)) {\n    return input as T;\n  }\n\n  const parts =\n    input\n      ?.replace(\n        /[A-Z]+/g,\n        (input?: string) => upperCaseFirst(input) ?? EMPTY_STRING\n      )\n      ?.split(/(?=[A-Z])|[\\s._-]/)\n      .map(x => x.toLowerCase()) ?? [];\n  if (parts.length === 0) {\n    return \"\" as T;\n  }\n  if (parts.length === 1) {\n    return parts[0] as T;\n  }\n\n  return parts.reduce((ret: string, part: string) => {\n    return `${ret}.${part.toLowerCase()}`.toLowerCase();\n  }) as T;\n}\n"],"mappings":"4GA8BA,SAAgB,EAAc,EAAoC,CAChE,OAAO,EAAQ,2BAA2B,KAAK,EAAM,CAAG,GAY1D,SAAgB,EAA0C,EAAc,CACtE,GAAI,CAAC,GAAS,EAAc,EAAM,CAChC,OAAO,EAGT,IAAM,EACJ,GACI,QACA,UACC,GAAmB,EAAeA,EAAM,EAAI,EAC9C,EACC,MAAM,oBAAoB,CAC3B,IAAI,GAAK,EAAE,aAAa,CAAC,EAAI,EAAE,CAQpC,OAPI,EAAM,SAAW,EACZ,GAEL,EAAM,SAAW,EACZ,EAAM,GAGR,EAAM,QAAQ,EAAa,IACzB,GAAG,EAAI,GAAG,EAAK,aAAa,GAAG,aAAa,CACnD"}
+{"version":3,"file":"period-split.mjs","names":["input"],"sources":["../src/period-split.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { EMPTY_STRING } from \"@stryke/types\";\nimport { upperCaseFirst } from \"./upper-case-first\";\n\n/**\n * Check if the input string is in snake case.\n *\n * @remarks\n * Snake case is defined as all lowercase letters with underscores separating words - \"this_is_an_example\"\n *\n * @param input - The input string to check.\n * @returns True if the input is in snake case, false otherwise.\n */\nexport function isPeriodSplit(input: string | undefined): boolean {\n  return input ? /^[a-z]+(?:\\.[a-z0-9]+)*$/.test(input) : false;\n}\n\n/**\n * Make all characters lowercase and add a period in between each word\n *\n * @remarks\n * \"this.is.an.example\"\n *\n * @param input - The input string.\n * @returns The period-split string.\n */\nexport function periodSplit<T extends string | undefined>(input?: T): T {\n  if (!input || isPeriodSplit(input)) {\n    return input as T;\n  }\n\n  const parts =\n    input\n      ?.replace(\n        /[A-Z]+/g,\n        (input?: string) => upperCaseFirst(input) ?? EMPTY_STRING\n      )\n      ?.split(/(?=[A-Z])|[\\s._-]/)\n      .map(x => x.toLowerCase()) ?? [];\n  if (parts.length === 0) {\n    return \"\" as T;\n  }\n  if (parts.length === 1) {\n    return parts[0] as T;\n  }\n\n  return parts.reduce((ret: string, part: string) => {\n    return `${ret}.${part.toLowerCase()}`.toLowerCase();\n  }) as T;\n}\n"],"mappings":";;;;;;;;;;;;;AA8BA,SAAgB,cAAc,OAAoC;AAChE,QAAO,QAAQ,2BAA2B,KAAK,MAAM,GAAG;;;;;;;;;;;AAY1D,SAAgB,YAA0C,OAAc;AACtE,KAAI,CAAC,SAAS,cAAc,MAAM,CAChC,QAAO;CAGT,MAAM,QACJ,OACI,QACA,YACC,YAAmB,eAAeA,QAAM,IAAI,aAC9C,EACC,MAAM,oBAAoB,CAC3B,KAAI,MAAK,EAAE,aAAa,CAAC,IAAI,EAAE;AACpC,KAAI,MAAM,WAAW,EACnB,QAAO;AAET,KAAI,MAAM,WAAW,EACnB,QAAO,MAAM;AAGf,QAAO,MAAM,QAAQ,KAAa,SAAiB;AACjD,SAAO,GAAG,IAAI,GAAG,KAAK,aAAa,GAAG,aAAa;GACnD"}

package/dist/prepositions.cjs

@@ -1 +1,68 @@
-const e=`about.above.across.after.against.along.among.around.at.because of.before.behind.below.beneath.beside.besides.between.beyond.but.by.concerning.despite.down.during.except.excepting.for.from.in.in front of.inside.in spite of.instead of.into.like.near.of.off.on.onto.out.outside.over.past.regarding.since.through.throughout.to.toward.under.underneath.until.up.upon.up to.with.within.without.with regard to.with respect to`.split(`.`);exports.PREPOSITIONS=e;
+
+//#region src/prepositions.ts
+const PREPOSITIONS = [
+	"about",
+	"above",
+	"across",
+	"after",
+	"against",
+	"along",
+	"among",
+	"around",
+	"at",
+	"because of",
+	"before",
+	"behind",
+	"below",
+	"beneath",
+	"beside",
+	"besides",
+	"between",
+	"beyond",
+	"but",
+	"by",
+	"concerning",
+	"despite",
+	"down",
+	"during",
+	"except",
+	"excepting",
+	"for",
+	"from",
+	"in",
+	"in front of",
+	"inside",
+	"in spite of",
+	"instead of",
+	"into",
+	"like",
+	"near",
+	"of",
+	"off",
+	"on",
+	"onto",
+	"out",
+	"outside",
+	"over",
+	"past",
+	"regarding",
+	"since",
+	"through",
+	"throughout",
+	"to",
+	"toward",
+	"under",
+	"underneath",
+	"until",
+	"up",
+	"upon",
+	"up to",
+	"with",
+	"within",
+	"without",
+	"with regard to",
+	"with respect to"
+];
+
+//#endregion
+exports.PREPOSITIONS = PREPOSITIONS;

package/dist/prepositions.mjs

@@ -1,2 +1,68 @@
-const e=`about.above.across.after.against.along.among.around.at.because of.before.behind.below.beneath.beside.besides.between.beyond.but.by.concerning.despite.down.during.except.excepting.for.from.in.in front of.inside.in spite of.instead of.into.like.near.of.off.on.onto.out.outside.over.past.regarding.since.through.throughout.to.toward.under.underneath.until.up.upon.up to.with.within.without.with regard to.with respect to`.split(`.`);export{e as PREPOSITIONS};
+//#region src/prepositions.ts
+const PREPOSITIONS = [
+	"about",
+	"above",
+	"across",
+	"after",
+	"against",
+	"along",
+	"among",
+	"around",
+	"at",
+	"because of",
+	"before",
+	"behind",
+	"below",
+	"beneath",
+	"beside",
+	"besides",
+	"between",
+	"beyond",
+	"but",
+	"by",
+	"concerning",
+	"despite",
+	"down",
+	"during",
+	"except",
+	"excepting",
+	"for",
+	"from",
+	"in",
+	"in front of",
+	"inside",
+	"in spite of",
+	"instead of",
+	"into",
+	"like",
+	"near",
+	"of",
+	"off",
+	"on",
+	"onto",
+	"out",
+	"outside",
+	"over",
+	"past",
+	"regarding",
+	"since",
+	"through",
+	"throughout",
+	"to",
+	"toward",
+	"under",
+	"underneath",
+	"until",
+	"up",
+	"upon",
+	"up to",
+	"with",
+	"within",
+	"without",
+	"with regard to",
+	"with respect to"
+];
+
+//#endregion
+export { PREPOSITIONS };
 //# sourceMappingURL=prepositions.mjs.map

package/dist/prepositions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"prepositions.mjs","names":[],"sources":["../src/prepositions.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport const PREPOSITIONS = [\n  \"about\",\n  \"above\",\n  \"across\",\n  \"after\",\n  \"against\",\n  \"along\",\n  \"among\",\n  \"around\",\n  \"at\",\n  \"because of\",\n  \"before\",\n  \"behind\",\n  \"below\",\n  \"beneath\",\n  \"beside\",\n  \"besides\",\n  \"between\",\n  \"beyond\",\n  \"but\",\n  \"by\",\n  \"concerning\",\n  \"despite\",\n  \"down\",\n  \"during\",\n  \"except\",\n  \"excepting\",\n  \"for\",\n  \"from\",\n  \"in\",\n  \"in front of\",\n  \"inside\",\n  \"in spite of\",\n  \"instead of\",\n  \"into\",\n  \"like\",\n  \"near\",\n  \"of\",\n  \"off\",\n  \"on\",\n  \"onto\",\n  \"out\",\n  \"outside\",\n  \"over\",\n  \"past\",\n  \"regarding\",\n  \"since\",\n  \"through\",\n  \"throughout\",\n  \"to\",\n  \"toward\",\n  \"under\",\n  \"underneath\",\n  \"until\",\n  \"up\",\n  \"upon\",\n  \"up to\",\n  \"with\",\n  \"within\",\n  \"without\",\n  \"with regard to\",\n  \"with respect to\"\n];\n"],"mappings":"AAkBA,MAAa,EAAe,8aA8D3B"}
+{"version":3,"file":"prepositions.mjs","names":[],"sources":["../src/prepositions.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport const PREPOSITIONS = [\n  \"about\",\n  \"above\",\n  \"across\",\n  \"after\",\n  \"against\",\n  \"along\",\n  \"among\",\n  \"around\",\n  \"at\",\n  \"because of\",\n  \"before\",\n  \"behind\",\n  \"below\",\n  \"beneath\",\n  \"beside\",\n  \"besides\",\n  \"between\",\n  \"beyond\",\n  \"but\",\n  \"by\",\n  \"concerning\",\n  \"despite\",\n  \"down\",\n  \"during\",\n  \"except\",\n  \"excepting\",\n  \"for\",\n  \"from\",\n  \"in\",\n  \"in front of\",\n  \"inside\",\n  \"in spite of\",\n  \"instead of\",\n  \"into\",\n  \"like\",\n  \"near\",\n  \"of\",\n  \"off\",\n  \"on\",\n  \"onto\",\n  \"out\",\n  \"outside\",\n  \"over\",\n  \"past\",\n  \"regarding\",\n  \"since\",\n  \"through\",\n  \"throughout\",\n  \"to\",\n  \"toward\",\n  \"under\",\n  \"underneath\",\n  \"until\",\n  \"up\",\n  \"upon\",\n  \"up to\",\n  \"with\",\n  \"within\",\n  \"without\",\n  \"with regard to\",\n  \"with respect to\"\n];\n"],"mappings":";AAkBA,MAAa,eAAe;CAC1B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD"}

package/dist/pretty-bytes.cjs

@@ -1 +1,129 @@
-const e=[`B`,`kB`,`MB`,`GB`,`TB`,`PB`,`EB`,`ZB`,`YB`],t=[`B`,`KiB`,`MiB`,`GiB`,`TiB`,`PiB`,`EiB`,`ZiB`,`YiB`],n=[`b`,`kbit`,`Mbit`,`Gbit`,`Tbit`,`Pbit`,`Ebit`,`Zbit`,`Ybit`],r=[`b`,`kibit`,`Mibit`,`Gibit`,`Tibit`,`Pibit`,`Eibit`,`Zibit`,`Yibit`],i=(e,t,n={})=>{let r=e,i=t;return typeof i==`string`?(i||=process.env.STORM_LOCALE||`en-US`,Array.isArray(i)&&(r=e?.toLocaleString(i,n))):(i===!0||n!==void 0)&&(r=e?.toLocaleString(void 0,n)),String(r)};function a(a,o){let s=a;if(!Number.isFinite(s))throw TypeError(`Expected a finite number, got ${typeof s}: ${s}`);let c={bits:!1,binary:!1,space:!0,...o},l=c.bits?c.binary?r:n:c.binary?t:e,u=c.space?` `:``;if(c.signed&&s===0)return` 0${u}${l[0]}`;let d=s<0,f=d?`-`:c.signed?`+`:``;d&&(s=-s);let p;if(c.minimumFractionDigits!==void 0&&(p={minimumFractionDigits:c.minimumFractionDigits}),c.maximumFractionDigits!==void 0&&(p={maximumFractionDigits:c.maximumFractionDigits,...p}),s<1)return f+i(s,c.locale,p)+u+l[0];let m=Math.min(Math.floor(c.binary?Math.log(s)/Math.log(1024):Math.log10(s)/3),l.length-1);s/=(c.binary?1024:1e3)**m,p||(s=s.toPrecision(3));let h=i(Number(s),c.locale,p),g=l[m];return f+h+u+g}exports.prettyBytes=a,exports.toLocaleString=i;
+
+//#region src/pretty-bytes.ts
+const BYTE_UNITS = [
+	"B",
+	"kB",
+	"MB",
+	"GB",
+	"TB",
+	"PB",
+	"EB",
+	"ZB",
+	"YB"
+];
+const BIBYTE_UNITS = [
+	"B",
+	"KiB",
+	"MiB",
+	"GiB",
+	"TiB",
+	"PiB",
+	"EiB",
+	"ZiB",
+	"YiB"
+];
+const BIT_UNITS = [
+	"b",
+	"kbit",
+	"Mbit",
+	"Gbit",
+	"Tbit",
+	"Pbit",
+	"Ebit",
+	"Zbit",
+	"Ybit"
+];
+const BIBIT_UNITS = [
+	"b",
+	"kibit",
+	"Mibit",
+	"Gibit",
+	"Tibit",
+	"Pibit",
+	"Eibit",
+	"Zibit",
+	"Yibit"
+];
+/**
+* Formats the given number using `Number#toLocaleString`.
+*
+* @remarks
+* - If locale is a string, the value is expected to be a locale-key (for example: `de`).
+* - If locale is true, the system default locale is used for translation.
+* - If no value for locale is specified, the number is returned unmodified.
+*
+* @param number - The number to format.
+* @param locale - The locale to use for formatting the number.
+* @param options - The options to use for formatting the number.
+* @returns The formatted number.
+*/
+const toLocaleString = (number, locale, options = {}) => {
+	let result = number;
+	let _locale = locale;
+	if (typeof _locale === "string") {
+		if (!_locale) _locale = process.env.STORM_LOCALE || "en-US";
+		if (Array.isArray(_locale)) result = number?.toLocaleString(_locale, options);
+	} else if (_locale === true || options !== void 0) result = number?.toLocaleString(void 0, options);
+	return String(result);
+};
+/**
+* Convert bytes to a human readable string: `1337` → `1.34 kB`.
+*
+* @param number - The number to format.
+*
+* @example
+* ```ts
+* import { prettyBytes } from '@stryke/string-fns/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'
+* ```
+*
+* @param number - The number to format.
+* @param options - The options to use.
+* @returns The formatted string.
+*/
+function prettyBytes(number, options) {
+	let _number = number;
+	if (!Number.isFinite(_number)) throw new TypeError(`Expected a finite number, got ${typeof _number}: ${_number}`);
+	const opts = {
+		bits: false,
+		binary: false,
+		space: true,
+		...options
+	};
+	const UNITS = opts.bits ? opts.binary ? BIBIT_UNITS : BIT_UNITS : opts.binary ? BIBYTE_UNITS : BYTE_UNITS;
+	const separator = opts.space ? " " : "";
+	if (opts.signed && _number === 0) return ` 0${separator}${UNITS[0]}`;
+	const isNegative = _number < 0;
+	const prefix = isNegative ? "-" : opts.signed ? "+" : "";
+	if (isNegative) _number = -_number;
+	let localeOptions;
+	if (opts.minimumFractionDigits !== void 0) localeOptions = { minimumFractionDigits: opts.minimumFractionDigits };
+	if (opts.maximumFractionDigits !== void 0) localeOptions = {
+		maximumFractionDigits: opts.maximumFractionDigits,
+		...localeOptions
+	};
+	if (_number < 1) return prefix + toLocaleString(_number, opts.locale, localeOptions) + separator + UNITS[0];
+	const exponent = Math.min(Math.floor(opts.binary ? Math.log(_number) / Math.log(1024) : Math.log10(_number) / 3), UNITS.length - 1);
+	_number /= (opts.binary ? 1024 : 1e3) ** exponent;
+	if (!localeOptions) _number = _number.toPrecision(3);
+	const numberString = toLocaleString(Number(_number), opts.locale, localeOptions);
+	const unit = UNITS[exponent];
+	return prefix + numberString + separator + unit;
+}
+
+//#endregion
+exports.prettyBytes = prettyBytes;
+exports.toLocaleString = toLocaleString;

package/dist/pretty-bytes.mjs

@@ -1,2 +1,128 @@
-const e=[`B`,`kB`,`MB`,`GB`,`TB`,`PB`,`EB`,`ZB`,`YB`],t=[`B`,`KiB`,`MiB`,`GiB`,`TiB`,`PiB`,`EiB`,`ZiB`,`YiB`],n=[`b`,`kbit`,`Mbit`,`Gbit`,`Tbit`,`Pbit`,`Ebit`,`Zbit`,`Ybit`],r=[`b`,`kibit`,`Mibit`,`Gibit`,`Tibit`,`Pibit`,`Eibit`,`Zibit`,`Yibit`],i=(e,t,n={})=>{let r=e,i=t;return typeof i==`string`?(i||=process.env.STORM_LOCALE||`en-US`,Array.isArray(i)&&(r=e?.toLocaleString(i,n))):(i===!0||n!==void 0)&&(r=e?.toLocaleString(void 0,n)),String(r)};function a(a,o){let s=a;if(!Number.isFinite(s))throw TypeError(`Expected a finite number, got ${typeof s}: ${s}`);let c={bits:!1,binary:!1,space:!0,...o},l=c.bits?c.binary?r:n:c.binary?t:e,u=c.space?` `:``;if(c.signed&&s===0)return` 0${u}${l[0]}`;let d=s<0,f=d?`-`:c.signed?`+`:``;d&&(s=-s);let p;if(c.minimumFractionDigits!==void 0&&(p={minimumFractionDigits:c.minimumFractionDigits}),c.maximumFractionDigits!==void 0&&(p={maximumFractionDigits:c.maximumFractionDigits,...p}),s<1)return f+i(s,c.locale,p)+u+l[0];let m=Math.min(Math.floor(c.binary?Math.log(s)/Math.log(1024):Math.log10(s)/3),l.length-1);s/=(c.binary?1024:1e3)**m,p||(s=s.toPrecision(3));let h=i(Number(s),c.locale,p),g=l[m];return f+h+u+g}export{a as prettyBytes,i as toLocaleString};
+//#region src/pretty-bytes.ts
+const BYTE_UNITS = [
+	"B",
+	"kB",
+	"MB",
+	"GB",
+	"TB",
+	"PB",
+	"EB",
+	"ZB",
+	"YB"
+];
+const BIBYTE_UNITS = [
+	"B",
+	"KiB",
+	"MiB",
+	"GiB",
+	"TiB",
+	"PiB",
+	"EiB",
+	"ZiB",
+	"YiB"
+];
+const BIT_UNITS = [
+	"b",
+	"kbit",
+	"Mbit",
+	"Gbit",
+	"Tbit",
+	"Pbit",
+	"Ebit",
+	"Zbit",
+	"Ybit"
+];
+const BIBIT_UNITS = [
+	"b",
+	"kibit",
+	"Mibit",
+	"Gibit",
+	"Tibit",
+	"Pibit",
+	"Eibit",
+	"Zibit",
+	"Yibit"
+];
+/**
+* Formats the given number using `Number#toLocaleString`.
+*
+* @remarks
+* - If locale is a string, the value is expected to be a locale-key (for example: `de`).
+* - If locale is true, the system default locale is used for translation.
+* - If no value for locale is specified, the number is returned unmodified.
+*
+* @param number - The number to format.
+* @param locale - The locale to use for formatting the number.
+* @param options - The options to use for formatting the number.
+* @returns The formatted number.
+*/
+const toLocaleString = (number, locale, options = {}) => {
+	let result = number;
+	let _locale = locale;
+	if (typeof _locale === "string") {
+		if (!_locale) _locale = process.env.STORM_LOCALE || "en-US";
+		if (Array.isArray(_locale)) result = number?.toLocaleString(_locale, options);
+	} else if (_locale === true || options !== void 0) result = number?.toLocaleString(void 0, options);
+	return String(result);
+};
+/**
+* Convert bytes to a human readable string: `1337` → `1.34 kB`.
+*
+* @param number - The number to format.
+*
+* @example
+* ```ts
+* import { prettyBytes } from '@stryke/string-fns/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'
+* ```
+*
+* @param number - The number to format.
+* @param options - The options to use.
+* @returns The formatted string.
+*/
+function prettyBytes(number, options) {
+	let _number = number;
+	if (!Number.isFinite(_number)) throw new TypeError(`Expected a finite number, got ${typeof _number}: ${_number}`);
+	const opts = {
+		bits: false,
+		binary: false,
+		space: true,
+		...options
+	};
+	const UNITS = opts.bits ? opts.binary ? BIBIT_UNITS : BIT_UNITS : opts.binary ? BIBYTE_UNITS : BYTE_UNITS;
+	const separator = opts.space ? " " : "";
+	if (opts.signed && _number === 0) return ` 0${separator}${UNITS[0]}`;
+	const isNegative = _number < 0;
+	const prefix = isNegative ? "-" : opts.signed ? "+" : "";
+	if (isNegative) _number = -_number;
+	let localeOptions;
+	if (opts.minimumFractionDigits !== void 0) localeOptions = { minimumFractionDigits: opts.minimumFractionDigits };
+	if (opts.maximumFractionDigits !== void 0) localeOptions = {
+		maximumFractionDigits: opts.maximumFractionDigits,
+		...localeOptions
+	};
+	if (_number < 1) return prefix + toLocaleString(_number, opts.locale, localeOptions) + separator + UNITS[0];
+	const exponent = Math.min(Math.floor(opts.binary ? Math.log(_number) / Math.log(1024) : Math.log10(_number) / 3), UNITS.length - 1);
+	_number /= (opts.binary ? 1024 : 1e3) ** exponent;
+	if (!localeOptions) _number = _number.toPrecision(3);
+	const numberString = toLocaleString(Number(_number), opts.locale, localeOptions);
+	const unit = UNITS[exponent];
+	return prefix + numberString + separator + unit;
+}
+
+//#endregion
+export { prettyBytes, toLocaleString };
 //# sourceMappingURL=pretty-bytes.mjs.map

package/dist/pretty-bytes.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"pretty-bytes.mjs","names":["_number: string | number"],"sources":["../src/pretty-bytes.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport interface Options {\n  /**\n   * Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.\n   *\n   * @defaultValue false\n   */\n  readonly signed?: boolean;\n\n  /**\n   * - If `false`: Output won't be localized.\n   * - If `true`: Localize the output using the system/browser locale.\n   * - If `string`: Expects a [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)\n   * - If `string[]`: Expects a list of [BCP 47 language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)\n   *\n   * @defaultValue false\n   */\n  readonly locale?: boolean | string | readonly string[];\n\n  /**\n   * 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).\n   *\n   * @defaultValue false\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * prettyBytes(1337, {bits: true});\n   * //=> '1.34 kbit'\n   * ```\n   */\n  readonly bits?: boolean;\n\n  /**\n   * 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.\n   *\n   * @defaultValue false\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * prettyBytes(1000, {binary: true});\n   * //=> '1000 bit'\n   *\n   * prettyBytes(1024, {binary: true});\n   * //=> '1 kiB'\n   * ```\n   */\n  readonly binary?: boolean;\n\n  /**\n   * The minimum number of fraction digits to display.\n   *\n   * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.\n   *\n   * @defaultValue undefined\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * // Show the number with at least 3 fractional digits\n   * prettyBytes(1900, {minimumFractionDigits: 3});\n   * //=> '1.900 kB'\n   *\n   * prettyBytes(1900);\n   * //=> '1.9 kB'\n   * ```\n   */\n  readonly minimumFractionDigits?: number;\n\n  /**\n   * The maximum number of fraction digits to display.\n   *\n   * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.\n   *\n   * @defaultValue undefined\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * // Show the number with at most 1 fractional digit\n   * prettyBytes(1920, {maximumFractionDigits: 1});\n   * //=> '1.9 kB'\n   *\n   * prettyBytes(1920);\n   * //=> '1.92 kB'\n   * ```\n   */\n  readonly maximumFractionDigits?: number;\n\n  /**\n   * Put a space between the number and unit.\n   *\n   * @defaultValue true\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * prettyBytes(1920, {space: false});\n   * //=> '1.9kB'\n   *\n   * prettyBytes(1920);\n   * //=> '1.92 kB'\n   * ```\n   */\n  readonly space?: boolean;\n}\n\nconst BYTE_UNITS = [\"B\", \"kB\", \"MB\", \"GB\", \"TB\", \"PB\", \"EB\", \"ZB\", \"YB\"];\nconst BIBYTE_UNITS = [\n  \"B\",\n  \"KiB\",\n  \"MiB\",\n  \"GiB\",\n  \"TiB\",\n  \"PiB\",\n  \"EiB\",\n  \"ZiB\",\n  \"YiB\"\n];\nconst BIT_UNITS = [\n  \"b\",\n  \"kbit\",\n  \"Mbit\",\n  \"Gbit\",\n  \"Tbit\",\n  \"Pbit\",\n  \"Ebit\",\n  \"Zbit\",\n  \"Ybit\"\n];\nconst BIBIT_UNITS = [\n  \"b\",\n  \"kibit\",\n  \"Mibit\",\n  \"Gibit\",\n  \"Tibit\",\n  \"Pibit\",\n  \"Eibit\",\n  \"Zibit\",\n  \"Yibit\"\n];\n\n/**\n * Formats the given number using `Number#toLocaleString`.\n *\n * @remarks\n * - If locale is a string, the value is expected to be a locale-key (for example: `de`).\n * - If locale is true, the system default locale is used for translation.\n * - If no value for locale is specified, the number is returned unmodified.\n *\n * @param number - The number to format.\n * @param locale - The locale to use for formatting the number.\n * @param options - The options to use for formatting the number.\n * @returns The formatted number.\n */\nexport const toLocaleString = (\n  number?: number | string,\n  locale?: string | readonly string[] | boolean,\n  options: Options = {}\n): string => {\n  let result = number;\n  let _locale = locale;\n  if (typeof _locale === \"string\") {\n    if (!_locale) {\n      _locale = process.env.STORM_LOCALE || \"en-US\";\n    }\n    if (Array.isArray(_locale)) {\n      result = number?.toLocaleString(_locale, options);\n    }\n  } else if (_locale === true || options !== undefined) {\n    result = number?.toLocaleString(undefined, options);\n  }\n\n  return String(result);\n};\n\n/**\n * Convert bytes to a human readable string: `1337` → `1.34 kB`.\n *\n * @param number - The number to format.\n *\n * @example\n * ```ts\n * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n *\n * prettyBytes(1337);\n * //=> '1.34 kB'\n *\n * prettyBytes(100);\n * //=> '100 B'\n *\n * // Display file size differences\n * prettyBytes(42, {signed: true});\n * //=> '+42 B'\n *\n * // Localized output using German locale\n * prettyBytes(1337, {locale: 'de'});\n * //=> '1,34 kB'\n * ```\n *\n * @param number - The number to format.\n * @param options - The options to use.\n * @returns The formatted string.\n */\nexport function prettyBytes(number: number, options?: Options): string {\n  let _number: string | number = number;\n  if (!Number.isFinite(_number)) {\n    throw new TypeError(\n      `Expected a finite number, got ${typeof _number}: ${_number}`\n    );\n  }\n\n  const opts = {\n    bits: false,\n    binary: false,\n    space: true,\n    ...options\n  };\n\n  const UNITS = opts.bits\n    ? opts.binary\n      ? BIBIT_UNITS\n      : BIT_UNITS\n    : opts.binary\n      ? BIBYTE_UNITS\n      : BYTE_UNITS;\n\n  const separator = opts.space ? \" \" : \"\";\n\n  if (opts.signed && _number === 0) {\n    return ` 0${separator}${UNITS[0]}`;\n  }\n\n  const isNegative = _number < 0;\n\n  const prefix = isNegative ? \"-\" : opts.signed ? \"+\" : \"\";\n\n  if (isNegative) {\n    _number = -_number;\n  }\n\n  let localeOptions;\n\n  if (opts.minimumFractionDigits !== undefined) {\n    localeOptions = { minimumFractionDigits: opts.minimumFractionDigits };\n  }\n\n  if (opts.maximumFractionDigits !== undefined) {\n    localeOptions = {\n      maximumFractionDigits: opts.maximumFractionDigits,\n      ...localeOptions\n    };\n  }\n\n  if (_number < 1) {\n    const numberString = toLocaleString(_number, opts.locale, localeOptions);\n\n    return prefix + numberString + separator + UNITS[0];\n  }\n\n  const exponent = Math.min(\n    Math.floor(\n      opts.binary ? Math.log(_number) / Math.log(1024) : Math.log10(_number) / 3\n    ),\n    UNITS.length - 1\n  );\n  _number /= (opts.binary ? 1024 : 1000) ** exponent;\n\n  if (!localeOptions) {\n    _number = _number.toPrecision(3);\n  }\n\n  const numberString = toLocaleString(\n    Number(_number),\n    opts.locale,\n    localeOptions\n  );\n\n  const unit = UNITS[exponent];\n\n  return prefix + numberString + separator + unit;\n}\n"],"mappings":"AAkIA,MAAM,EAAa,CAAC,IAAK,KAAM,KAAM,KAAM,KAAM,KAAM,KAAM,KAAM,KAAK,CAClE,EAAe,CACnB,IACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACD,CACK,EAAY,CAChB,IACA,OACA,OACA,OACA,OACA,OACA,OACA,OACA,OACD,CACK,EAAc,CAClB,IACA,QACA,QACA,QACA,QACA,QACA,QACA,QACA,QACD,CAeY,GACX,EACA,EACA,EAAmB,EAAE,GACV,CACX,IAAI,EAAS,EACT,EAAU,EAYd,OAXI,OAAO,GAAY,UACrB,AACE,IAAU,QAAQ,IAAI,cAAgB,QAEpC,MAAM,QAAQ,EAAQ,GACxB,EAAS,GAAQ,eAAe,EAAS,EAAQ,IAE1C,IAAY,IAAQ,IAAY,IAAA,MACzC,EAAS,GAAQ,eAAe,IAAA,GAAW,EAAQ,EAG9C,OAAO,EAAO,EA+BvB,SAAgB,EAAY,EAAgB,EAA2B,CACrE,IAAIA,EAA2B,EAC/B,GAAI,CAAC,OAAO,SAAS,EAAQ,CAC3B,MAAU,UACR,iCAAiC,OAAO,EAAQ,IAAI,IACrD,CAGH,IAAM,EAAO,CACX,KAAM,GACN,OAAQ,GACR,MAAO,GACP,GAAG,EACJ,CAEK,EAAQ,EAAK,KACf,EAAK,OACH,EACA,EACF,EAAK,OACH,EACA,EAEA,EAAY,EAAK,MAAQ,IAAM,GAErC,GAAI,EAAK,QAAU,IAAY,EAC7B,MAAO,KAAK,IAAY,EAAM,KAGhC,IAAM,EAAa,EAAU,EAEvB,EAAS,EAAa,IAAM,EAAK,OAAS,IAAM,GAElD,IACF,EAAU,CAAC,GAGb,IAAI,EAaJ,GAXI,EAAK,wBAA0B,IAAA,KACjC,EAAgB,CAAE,sBAAuB,EAAK,sBAAuB,EAGnE,EAAK,wBAA0B,IAAA,KACjC,EAAgB,CACd,sBAAuB,EAAK,sBAC5B,GAAG,EACJ,EAGC,EAAU,EAGZ,OAAO,EAFc,EAAe,EAAS,EAAK,OAAQ,EAAc,CAEzC,EAAY,EAAM,GAGnD,IAAM,EAAW,KAAK,IACpB,KAAK,MACH,EAAK,OAAS,KAAK,IAAI,EAAQ,CAAG,KAAK,IAAI,KAAK,CAAG,KAAK,MAAM,EAAQ,CAAG,EAC1E,CACD,EAAM,OAAS,EAChB,CACD,IAAY,EAAK,OAAS,KAAO,MAAS,EAErC,IACH,EAAU,EAAQ,YAAY,EAAE,EAGlC,IAAM,EAAe,EACnB,OAAO,EAAQ,CACf,EAAK,OACL,EACD,CAEK,EAAO,EAAM,GAEnB,OAAO,EAAS,EAAe,EAAY"}
+{"version":3,"file":"pretty-bytes.mjs","names":["_number: string | number"],"sources":["../src/pretty-bytes.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nexport interface Options {\n  /**\n   * Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.\n   *\n   * @defaultValue false\n   */\n  readonly signed?: boolean;\n\n  /**\n   * - If `false`: Output won't be localized.\n   * - If `true`: Localize the output using the system/browser locale.\n   * - If `string`: Expects a [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)\n   * - If `string[]`: Expects a list of [BCP 47 language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (For example: `en`, `de`, …)\n   *\n   * @defaultValue false\n   */\n  readonly locale?: boolean | string | readonly string[];\n\n  /**\n   * 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).\n   *\n   * @defaultValue false\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * prettyBytes(1337, {bits: true});\n   * //=> '1.34 kbit'\n   * ```\n   */\n  readonly bits?: boolean;\n\n  /**\n   * 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.\n   *\n   * @defaultValue false\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * prettyBytes(1000, {binary: true});\n   * //=> '1000 bit'\n   *\n   * prettyBytes(1024, {binary: true});\n   * //=> '1 kiB'\n   * ```\n   */\n  readonly binary?: boolean;\n\n  /**\n   * The minimum number of fraction digits to display.\n   *\n   * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.\n   *\n   * @defaultValue undefined\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * // Show the number with at least 3 fractional digits\n   * prettyBytes(1900, {minimumFractionDigits: 3});\n   * //=> '1.900 kB'\n   *\n   * prettyBytes(1900);\n   * //=> '1.9 kB'\n   * ```\n   */\n  readonly minimumFractionDigits?: number;\n\n  /**\n   * The maximum number of fraction digits to display.\n   *\n   * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.\n   *\n   * @defaultValue undefined\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * // Show the number with at most 1 fractional digit\n   * prettyBytes(1920, {maximumFractionDigits: 1});\n   * //=> '1.9 kB'\n   *\n   * prettyBytes(1920);\n   * //=> '1.92 kB'\n   * ```\n   */\n  readonly maximumFractionDigits?: number;\n\n  /**\n   * Put a space between the number and unit.\n   *\n   * @defaultValue true\n   *\n   * @example\n   * ```ts\n   * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n   *\n   * prettyBytes(1920, {space: false});\n   * //=> '1.9kB'\n   *\n   * prettyBytes(1920);\n   * //=> '1.92 kB'\n   * ```\n   */\n  readonly space?: boolean;\n}\n\nconst BYTE_UNITS = [\"B\", \"kB\", \"MB\", \"GB\", \"TB\", \"PB\", \"EB\", \"ZB\", \"YB\"];\nconst BIBYTE_UNITS = [\n  \"B\",\n  \"KiB\",\n  \"MiB\",\n  \"GiB\",\n  \"TiB\",\n  \"PiB\",\n  \"EiB\",\n  \"ZiB\",\n  \"YiB\"\n];\nconst BIT_UNITS = [\n  \"b\",\n  \"kbit\",\n  \"Mbit\",\n  \"Gbit\",\n  \"Tbit\",\n  \"Pbit\",\n  \"Ebit\",\n  \"Zbit\",\n  \"Ybit\"\n];\nconst BIBIT_UNITS = [\n  \"b\",\n  \"kibit\",\n  \"Mibit\",\n  \"Gibit\",\n  \"Tibit\",\n  \"Pibit\",\n  \"Eibit\",\n  \"Zibit\",\n  \"Yibit\"\n];\n\n/**\n * Formats the given number using `Number#toLocaleString`.\n *\n * @remarks\n * - If locale is a string, the value is expected to be a locale-key (for example: `de`).\n * - If locale is true, the system default locale is used for translation.\n * - If no value for locale is specified, the number is returned unmodified.\n *\n * @param number - The number to format.\n * @param locale - The locale to use for formatting the number.\n * @param options - The options to use for formatting the number.\n * @returns The formatted number.\n */\nexport const toLocaleString = (\n  number?: number | string,\n  locale?: string | readonly string[] | boolean,\n  options: Options = {}\n): string => {\n  let result = number;\n  let _locale = locale;\n  if (typeof _locale === \"string\") {\n    if (!_locale) {\n      _locale = process.env.STORM_LOCALE || \"en-US\";\n    }\n    if (Array.isArray(_locale)) {\n      result = number?.toLocaleString(_locale, options);\n    }\n  } else if (_locale === true || options !== undefined) {\n    result = number?.toLocaleString(undefined, options);\n  }\n\n  return String(result);\n};\n\n/**\n * Convert bytes to a human readable string: `1337` → `1.34 kB`.\n *\n * @param number - The number to format.\n *\n * @example\n * ```ts\n * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';\n *\n * prettyBytes(1337);\n * //=> '1.34 kB'\n *\n * prettyBytes(100);\n * //=> '100 B'\n *\n * // Display file size differences\n * prettyBytes(42, {signed: true});\n * //=> '+42 B'\n *\n * // Localized output using German locale\n * prettyBytes(1337, {locale: 'de'});\n * //=> '1,34 kB'\n * ```\n *\n * @param number - The number to format.\n * @param options - The options to use.\n * @returns The formatted string.\n */\nexport function prettyBytes(number: number, options?: Options): string {\n  let _number: string | number = number;\n  if (!Number.isFinite(_number)) {\n    throw new TypeError(\n      `Expected a finite number, got ${typeof _number}: ${_number}`\n    );\n  }\n\n  const opts = {\n    bits: false,\n    binary: false,\n    space: true,\n    ...options\n  };\n\n  const UNITS = opts.bits\n    ? opts.binary\n      ? BIBIT_UNITS\n      : BIT_UNITS\n    : opts.binary\n      ? BIBYTE_UNITS\n      : BYTE_UNITS;\n\n  const separator = opts.space ? \" \" : \"\";\n\n  if (opts.signed && _number === 0) {\n    return ` 0${separator}${UNITS[0]}`;\n  }\n\n  const isNegative = _number < 0;\n\n  const prefix = isNegative ? \"-\" : opts.signed ? \"+\" : \"\";\n\n  if (isNegative) {\n    _number = -_number;\n  }\n\n  let localeOptions;\n\n  if (opts.minimumFractionDigits !== undefined) {\n    localeOptions = { minimumFractionDigits: opts.minimumFractionDigits };\n  }\n\n  if (opts.maximumFractionDigits !== undefined) {\n    localeOptions = {\n      maximumFractionDigits: opts.maximumFractionDigits,\n      ...localeOptions\n    };\n  }\n\n  if (_number < 1) {\n    const numberString = toLocaleString(_number, opts.locale, localeOptions);\n\n    return prefix + numberString + separator + UNITS[0];\n  }\n\n  const exponent = Math.min(\n    Math.floor(\n      opts.binary ? Math.log(_number) / Math.log(1024) : Math.log10(_number) / 3\n    ),\n    UNITS.length - 1\n  );\n  _number /= (opts.binary ? 1024 : 1000) ** exponent;\n\n  if (!localeOptions) {\n    _number = _number.toPrecision(3);\n  }\n\n  const numberString = toLocaleString(\n    Number(_number),\n    opts.locale,\n    localeOptions\n  );\n\n  const unit = UNITS[exponent];\n\n  return prefix + numberString + separator + unit;\n}\n"],"mappings":";AAkIA,MAAM,aAAa;CAAC;CAAK;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAM;CAAK;AACxE,MAAM,eAAe;CACnB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD;AACD,MAAM,YAAY;CAChB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD;AACD,MAAM,cAAc;CAClB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACD;;;;;;;;;;;;;;AAeD,MAAa,kBACX,QACA,QACA,UAAmB,EAAE,KACV;CACX,IAAI,SAAS;CACb,IAAI,UAAU;AACd,KAAI,OAAO,YAAY,UAAU;AAC/B,MAAI,CAAC,QACH,WAAU,QAAQ,IAAI,gBAAgB;AAExC,MAAI,MAAM,QAAQ,QAAQ,CACxB,UAAS,QAAQ,eAAe,SAAS,QAAQ;YAE1C,YAAY,QAAQ,YAAY,OACzC,UAAS,QAAQ,eAAe,QAAW,QAAQ;AAGrD,QAAO,OAAO,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BvB,SAAgB,YAAY,QAAgB,SAA2B;CACrE,IAAIA,UAA2B;AAC/B,KAAI,CAAC,OAAO,SAAS,QAAQ,CAC3B,OAAM,IAAI,UACR,iCAAiC,OAAO,QAAQ,IAAI,UACrD;CAGH,MAAM,OAAO;EACX,MAAM;EACN,QAAQ;EACR,OAAO;EACP,GAAG;EACJ;CAED,MAAM,QAAQ,KAAK,OACf,KAAK,SACH,cACA,YACF,KAAK,SACH,eACA;CAEN,MAAM,YAAY,KAAK,QAAQ,MAAM;AAErC,KAAI,KAAK,UAAU,YAAY,EAC7B,QAAO,KAAK,YAAY,MAAM;CAGhC,MAAM,aAAa,UAAU;CAE7B,MAAM,SAAS,aAAa,MAAM,KAAK,SAAS,MAAM;AAEtD,KAAI,WACF,WAAU,CAAC;CAGb,IAAI;AAEJ,KAAI,KAAK,0BAA0B,OACjC,iBAAgB,EAAE,uBAAuB,KAAK,uBAAuB;AAGvE,KAAI,KAAK,0BAA0B,OACjC,iBAAgB;EACd,uBAAuB,KAAK;EAC5B,GAAG;EACJ;AAGH,KAAI,UAAU,EAGZ,QAAO,SAFc,eAAe,SAAS,KAAK,QAAQ,cAAc,GAEzC,YAAY,MAAM;CAGnD,MAAM,WAAW,KAAK,IACpB,KAAK,MACH,KAAK,SAAS,KAAK,IAAI,QAAQ,GAAG,KAAK,IAAI,KAAK,GAAG,KAAK,MAAM,QAAQ,GAAG,EAC1E,EACD,MAAM,SAAS,EAChB;AACD,aAAY,KAAK,SAAS,OAAO,QAAS;AAE1C,KAAI,CAAC,cACH,WAAU,QAAQ,YAAY,EAAE;CAGlC,MAAM,eAAe,eACnB,OAAO,QAAQ,EACf,KAAK,QACL,cACD;CAED,MAAM,OAAO,MAAM;AAEnB,QAAO,SAAS,eAAe,YAAY"}

package/dist/snake-case.cjs

@@ -1 +1,42 @@
-const e=require(`./types/src/base.cjs`),t=require(`./upper-case-first.cjs`),n=require(`./constant-case.cjs`);function r(e){return e?/^[a-z]+(?:_[a-z0-9]+)*$/.test(e):!1}function i(i,a){if(r(i)||i===void 0)return i;if(n.isConstantCase(i))return i.toLowerCase();let o=i?.replace(/[A-Z]+/g,n=>t.upperCaseFirst(n)??e.EMPTY_STRING).split(/(?=[A-Z])|[\s._-]/).map(e=>e.toLowerCase())??[];if(o.length===0)return``;if(o.length===1)return o[0];let s=o.reduce((e,t)=>`${e}_${t.toLowerCase()}`);return a?.splitOnNumber===!1?s:s.replace(/[A-Z]\d/i,e=>`${e[0]}_${e[1]}`)}exports.isSnakeCase=r,exports.snakeCase=i;
+const require_base = require('./types/src/base.cjs');
+const require_upper_case_first = require('./upper-case-first.cjs');
+const require_constant_case = require('./constant-case.cjs');
+
+//#region src/snake-case.ts
+/**
+* Check if the input string is in snake case.
+*
+* @remarks
+* Snake case is defined as all lowercase letters with underscores separating words - "this_is_an_example"
+*
+* @param input - The input string to check.
+* @returns True if the input is in snake case, false otherwise.
+*/
+function isSnakeCase(input) {
+	return input ? /^[a-z]+(?:_[a-z0-9]+)*$/.test(input) : false;
+}
+/**
+* Convert the input string to snake case.
+*
+*  @remarks
+* Snake case is defined as all lowercase letters with underscores separating words - "this_is_an_example"
+*
+* @param input - The input string.
+* @param options - Options to control the behavior of the function.
+* @returns The snake-cased string.
+*/
+function snakeCase(input, options) {
+	if (isSnakeCase(input) || input === void 0) return input;
+	if (require_constant_case.isConstantCase(input)) return input.toLowerCase();
+	const parts = input?.replace(/[A-Z]+/g, (input$1) => require_upper_case_first.upperCaseFirst(input$1) ?? require_base.EMPTY_STRING).split(/(?=[A-Z])|[\s._-]/).map((x) => x.toLowerCase()) ?? [];
+	if (parts.length === 0) return "";
+	if (parts.length === 1) return parts[0];
+	const result = parts.reduce((ret, part) => {
+		return `${ret}_${part.toLowerCase()}`;
+	});
+	return options?.splitOnNumber === false ? result : result.replace(/[A-Z]\d/i, (val) => `${val[0]}_${val[1]}`);
+}
+
+//#endregion
+exports.isSnakeCase = isSnakeCase;
+exports.snakeCase = snakeCase;

package/dist/snake-case.mjs

@@ -1,2 +1,42 @@
-import{EMPTY_STRING as e}from"./types/src/base.mjs";import{upperCaseFirst as t}from"./upper-case-first.mjs";import{isConstantCase as n}from"./constant-case.mjs";function r(e){return e?/^[a-z]+(?:_[a-z0-9]+)*$/.test(e):!1}function i(i,a){if(r(i)||i===void 0)return i;if(n(i))return i.toLowerCase();let o=i?.replace(/[A-Z]+/g,n=>t(n)??e).split(/(?=[A-Z])|[\s._-]/).map(e=>e.toLowerCase())??[];if(o.length===0)return``;if(o.length===1)return o[0];let s=o.reduce((e,t)=>`${e}_${t.toLowerCase()}`);return a?.splitOnNumber===!1?s:s.replace(/[A-Z]\d/i,e=>`${e[0]}_${e[1]}`)}export{r as isSnakeCase,i as snakeCase};
+import { EMPTY_STRING } from "./types/src/base.mjs";
+import { upperCaseFirst } from "./upper-case-first.mjs";
+import { isConstantCase } from "./constant-case.mjs";
+
+//#region src/snake-case.ts
+/**
+* Check if the input string is in snake case.
+*
+* @remarks
+* Snake case is defined as all lowercase letters with underscores separating words - "this_is_an_example"
+*
+* @param input - The input string to check.
+* @returns True if the input is in snake case, false otherwise.
+*/
+function isSnakeCase(input) {
+	return input ? /^[a-z]+(?:_[a-z0-9]+)*$/.test(input) : false;
+}
+/**
+* Convert the input string to snake case.
+*
+*  @remarks
+* Snake case is defined as all lowercase letters with underscores separating words - "this_is_an_example"
+*
+* @param input - The input string.
+* @param options - Options to control the behavior of the function.
+* @returns The snake-cased string.
+*/
+function snakeCase(input, options) {
+	if (isSnakeCase(input) || input === void 0) return input;
+	if (isConstantCase(input)) return input.toLowerCase();
+	const parts = input?.replace(/[A-Z]+/g, (input$1) => upperCaseFirst(input$1) ?? EMPTY_STRING).split(/(?=[A-Z])|[\s._-]/).map((x) => x.toLowerCase()) ?? [];
+	if (parts.length === 0) return "";
+	if (parts.length === 1) return parts[0];
+	const result = parts.reduce((ret, part) => {
+		return `${ret}_${part.toLowerCase()}`;
+	});
+	return options?.splitOnNumber === false ? result : result.replace(/[A-Z]\d/i, (val) => `${val[0]}_${val[1]}`);
+}
+
+//#endregion
+export { isSnakeCase, snakeCase };
 //# sourceMappingURL=snake-case.mjs.map

package/dist/snake-case.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"snake-case.mjs","names":["input"],"sources":["../src/snake-case.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { EMPTY_STRING } from \"@stryke/types\";\nimport { isConstantCase } from \"./constant-case\";\nimport { upperCaseFirst } from \"./upper-case-first\";\n\nexport interface SnakeCaseOptions {\n  splitOnNumber: boolean;\n}\n\n/**\n * Check if the input string is in snake case.\n *\n * @remarks\n * Snake case is defined as all lowercase letters with underscores separating words - \"this_is_an_example\"\n *\n * @param input - The input string to check.\n * @returns True if the input is in snake case, false otherwise.\n */\nexport function isSnakeCase(input: string | undefined): boolean {\n  return input ? /^[a-z]+(?:_[a-z0-9]+)*$/.test(input) : false;\n}\n\n/**\n * Convert the input string to snake case.\n *\n *  @remarks\n * Snake case is defined as all lowercase letters with underscores separating words - \"this_is_an_example\"\n *\n * @param input - The input string.\n * @param options - Options to control the behavior of the function.\n * @returns The snake-cased string.\n */\nexport function snakeCase<T extends string | undefined>(\n  input: T,\n  options?: SnakeCaseOptions\n): T {\n  if (isSnakeCase(input) || input === undefined) {\n    return input;\n  }\n\n  if (isConstantCase(input)) {\n    return input.toLowerCase() as T;\n  }\n\n  const parts =\n    input\n      ?.replace(\n        /[A-Z]+/g,\n        (input?: string) => upperCaseFirst(input) ?? EMPTY_STRING\n      )\n      .split(/(?=[A-Z])|[\\s._-]/)\n      .map((x: string) => x.toLowerCase()) ?? [];\n  if (parts.length === 0) {\n    return \"\" as T;\n  }\n  if (parts.length === 1) {\n    return parts[0] as T;\n  }\n  const result = parts.reduce((ret: string, part: string) => {\n    return `${ret}_${part.toLowerCase()}`;\n  });\n\n  return (\n    options?.splitOnNumber === false\n      ? result\n      : result.replace(/[A-Z]\\d/i, (val: string) => `${val[0]}_${val[1]}`)\n  ) as T;\n}\n"],"mappings":"iKAmCA,SAAgB,EAAY,EAAoC,CAC9D,OAAO,EAAQ,0BAA0B,KAAK,EAAM,CAAG,GAazD,SAAgB,EACd,EACA,EACG,CACH,GAAI,EAAY,EAAM,EAAI,IAAU,IAAA,GAClC,OAAO,EAGT,GAAI,EAAe,EAAM,CACvB,OAAO,EAAM,aAAa,CAG5B,IAAM,EACJ,GACI,QACA,UACC,GAAmB,EAAeA,EAAM,EAAI,EAC9C,CACA,MAAM,oBAAoB,CAC1B,IAAK,GAAc,EAAE,aAAa,CAAC,EAAI,EAAE,CAC9C,GAAI,EAAM,SAAW,EACnB,MAAO,GAET,GAAI,EAAM,SAAW,EACnB,OAAO,EAAM,GAEf,IAAM,EAAS,EAAM,QAAQ,EAAa,IACjC,GAAG,EAAI,GAAG,EAAK,aAAa,GACnC,CAEF,OACE,GAAS,gBAAkB,GACvB,EACA,EAAO,QAAQ,WAAa,GAAgB,GAAG,EAAI,GAAG,GAAG,EAAI,KAAK"}
+{"version":3,"file":"snake-case.mjs","names":["input"],"sources":["../src/snake-case.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                       ⚡ Storm Software - Stryke\n\n This code was released as part of the Stryke project. Stryke\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/stryke.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/stryke\n Documentation:            https://docs.stormsoftware.com/projects/stryke\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { EMPTY_STRING } from \"@stryke/types\";\nimport { isConstantCase } from \"./constant-case\";\nimport { upperCaseFirst } from \"./upper-case-first\";\n\nexport interface SnakeCaseOptions {\n  splitOnNumber: boolean;\n}\n\n/**\n * Check if the input string is in snake case.\n *\n * @remarks\n * Snake case is defined as all lowercase letters with underscores separating words - \"this_is_an_example\"\n *\n * @param input - The input string to check.\n * @returns True if the input is in snake case, false otherwise.\n */\nexport function isSnakeCase(input: string | undefined): boolean {\n  return input ? /^[a-z]+(?:_[a-z0-9]+)*$/.test(input) : false;\n}\n\n/**\n * Convert the input string to snake case.\n *\n *  @remarks\n * Snake case is defined as all lowercase letters with underscores separating words - \"this_is_an_example\"\n *\n * @param input - The input string.\n * @param options - Options to control the behavior of the function.\n * @returns The snake-cased string.\n */\nexport function snakeCase<T extends string | undefined>(\n  input: T,\n  options?: SnakeCaseOptions\n): T {\n  if (isSnakeCase(input) || input === undefined) {\n    return input;\n  }\n\n  if (isConstantCase(input)) {\n    return input.toLowerCase() as T;\n  }\n\n  const parts =\n    input\n      ?.replace(\n        /[A-Z]+/g,\n        (input?: string) => upperCaseFirst(input) ?? EMPTY_STRING\n      )\n      .split(/(?=[A-Z])|[\\s._-]/)\n      .map((x: string) => x.toLowerCase()) ?? [];\n  if (parts.length === 0) {\n    return \"\" as T;\n  }\n  if (parts.length === 1) {\n    return parts[0] as T;\n  }\n  const result = parts.reduce((ret: string, part: string) => {\n    return `${ret}_${part.toLowerCase()}`;\n  });\n\n  return (\n    options?.splitOnNumber === false\n      ? result\n      : result.replace(/[A-Z]\\d/i, (val: string) => `${val[0]}_${val[1]}`)\n  ) as T;\n}\n"],"mappings":";;;;;;;;;;;;;;AAmCA,SAAgB,YAAY,OAAoC;AAC9D,QAAO,QAAQ,0BAA0B,KAAK,MAAM,GAAG;;;;;;;;;;;;AAazD,SAAgB,UACd,OACA,SACG;AACH,KAAI,YAAY,MAAM,IAAI,UAAU,OAClC,QAAO;AAGT,KAAI,eAAe,MAAM,CACvB,QAAO,MAAM,aAAa;CAG5B,MAAM,QACJ,OACI,QACA,YACC,YAAmB,eAAeA,QAAM,IAAI,aAC9C,CACA,MAAM,oBAAoB,CAC1B,KAAK,MAAc,EAAE,aAAa,CAAC,IAAI,EAAE;AAC9C,KAAI,MAAM,WAAW,EACnB,QAAO;AAET,KAAI,MAAM,WAAW,EACnB,QAAO,MAAM;CAEf,MAAM,SAAS,MAAM,QAAQ,KAAa,SAAiB;AACzD,SAAO,GAAG,IAAI,GAAG,KAAK,aAAa;GACnC;AAEF,QACE,SAAS,kBAAkB,QACvB,SACA,OAAO,QAAQ,aAAa,QAAgB,GAAG,IAAI,GAAG,GAAG,IAAI,KAAK"}