@stryke/string-format 0.12.13 → 0.12.21

package/dist/pretty-bytes.d.ts

@@ -1,148 +0,0 @@
-export interface Options {
-    /**
-     * Include plus sign for positive numbers. If the difference is exactly zero a space character will be prepended instead for better alignment.
-     *
-     * @defaultValue 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`, …)
-     *
-     * @defaultValue 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).
-     *
-     * @defaultValue false
-     *
-     * @example
-     * ```ts
-     * import { prettyBytes } from '@stryke/string-fns/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.
-     *
-     * @defaultValue false
-     *
-     * @example
-     * ```ts
-     * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';
-     *
-     * prettyBytes(1000, {binary: true});
-     * //=> '1000 bit'
-     *
-     * prettyBytes(1024, {binary: true});
-     * //=> '1 kiB'
-     * ```
-     */
-    readonly binary?: boolean;
-    /**
-     * The minimum number of fraction digits to display.
-     *
-     * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.
-     *
-     * @defaultValue undefined
-     *
-     * @example
-     * ```ts
-     * import { prettyBytes } from '@stryke/string-fns/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.
-     *
-     * If neither `minimumFractionDigits` or `maximumFractionDigits` are set, the default behavior is to round to 3 significant digits.
-     *
-     * @defaultValue undefined
-     *
-     * @example
-     * ```ts
-     * import { prettyBytes } from '@stryke/string-fns/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.
-     *
-     * @defaultValue true
-     *
-     * @example
-     * ```ts
-     * import { prettyBytes } from '@stryke/string-fns/pretty-bytes';
-     *
-     * prettyBytes(1920, {space: false});
-     * //=> '1.9kB'
-     *
-     * prettyBytes(1920);
-     * //=> '1.92 kB'
-     * ```
-     */
-    readonly space?: boolean;
-}
-/**
- * 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.
- */
-export declare const toLocaleString: (number?: number | string, locale?: string | readonly string[] | boolean, options?: Options) => string;
-/**
- * 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.
- */
-export declare function prettyBytes(number: number, options?: Options): string;

package/dist/special-cases.d.ts

@@ -1 +0,0 @@
-export declare const SPECIAL_CASES: string[];

package/dist/title-case.d.ts

@@ -1,9 +0,0 @@
-import type { FormatSpecialCasesOptions } from "./format-special-cases";
-/**
- * Convert a string to title case.
- *
- * @param input - The input string to convert.
- * @param options - Options for formatting special cases.
- * @returns The title cased string.
- */
-export declare function titleCase<T extends string | undefined>(input: T, options?: FormatSpecialCasesOptions): T;

package/dist/upper-case-first.d.ts

@@ -1,10 +0,0 @@
-/**
- * Upper case the first character of an input string.
- *
- *  @remarks
- * "Thisisanexample"
- *
- * @param input - The input string.
- * @returns The capitalized string.
- */
-export declare function upperCaseFirst<T extends string | undefined>(input?: T): T;