Class DotNetLocaleSettings

Represents locale-specific formatting settings for dates, times, and numbers.

Provides culture-specific separators and formatting options that determine how numbers, currencies, dates, and times are formatted and parsed.

Example

// Use invariant culture (en-US)
const invariant = DotNetLocaleSettings.createInvariant();

// Use specific locale
const french = DotNetLocaleSettings.create('fr-FR');
console.log(french.decimalSeparator);  // ","
console.log(french.thousandSeparator);  // " "

// Use current system locale
const current = DotNetLocaleSettings.current;

Constructors

constructor

new DotNetLocaleSettings(localeName?: string): DotNetLocaleSettings
Creates a new DotNetLocaleSettings instance.
Parameters
- OptionallocaleName: string
  Optional locale name (e.g., "en-US", "fr-FR"). If undefined, uses the system's current locale.
Returns DotNetLocaleSettings
Example
```
// System locale
const settings = new DotNetLocaleSettings(undefined);

// Specific locale
const french = new DotNetLocaleSettings('fr-FR');
```
- Defined in locale-settings.ts:141

Properties

`Readonly`currencyString

currencyString: string

Currency symbol for this locale (e.g., "$", "€", "£").

`Readonly`dateSeparator

dateSeparator: string

Character used between date components (e.g., "/", "-", ".").

`Readonly`decimalSeparator

decimalSeparator: string

Character used for decimal point (e.g., "." or ",").

`Readonly`defaultCurrency

defaultCurrency: NumberFormat

Pre-configured number formatter for currency values.

`Readonly`defaultDecimal

defaultDecimal: NumberFormat

Pre-configured number formatter for high-precision decimal values.

`Readonly`defaultFloat

defaultFloat: NumberFormat

Pre-configured number formatter for floating-point values.

`Readonly`id

id: string

The locale identifier (same as name).

`Readonly`name

name: string

The locale name (e.g., "en-US", "fr-FR").

`Readonly`thousandSeparator

thousandSeparator: string

Character used for thousands grouping (e.g., "," or "." or " ").

`Readonly`timeSeparator

timeSeparator: string

Character used between time components (typically ":").

`Static` `Readonly`current

current: DotNetLocaleSettings = ...

Singleton instance for current system locale. Uses the locale settings from the runtime environment.

`Static` `Readonly`invariant

invariant: DotNetLocaleSettings = ...

Singleton instance for invariant culture (en-US). Provides consistent formatting across all systems.

Methods

boolToStr

boolToStr(value: boolean): string
Converts a boolean to a string.
Parameters
- value: boolean
  The boolean value.
Returns string
"true" or "false".
Example
```
settings.boolToStr(true);   // "true"
settings.boolToStr(false);  // "false"
```
- Defined in locale-settings.ts:249

dateToStr

dateToStr(value: Date, options?: DateTimeFormatOptions): string
Converts a Date to a string using locale-specific formatting.
Parameters
- value: Date
  The Date to format.
- Optionaloptions: DateTimeFormatOptions
  Optional Intl.DateTimeFormatOptions for custom formatting.
Returns string
The formatted date string.
Example
```
const settings = DotNetLocaleSettings.create('en-US');
settings.dateToStr(new Date(2024, 6, 5), { dateStyle: 'short' });  // "7/5/2024"
```
- Defined in locale-settings.ts:233

numberToStr

numberToStr(value: number | bigint, options?: NumberFormatOptions): string
Converts a number or bigint to a string using locale-specific formatting.
Parameters
- value: number | bigint
  The number or bigint to format.
- Optionaloptions: NumberFormatOptions
  Optional Intl.NumberFormatOptions for custom formatting.
Returns string
The formatted number string.
Example
```
const settings = DotNetLocaleSettings.create('en-US');
settings.numberToStr(1234.56);  // "1,234.56"
settings.numberToStr(1234.56, { minimumFractionDigits: 2 });  // "1,234.56"
```
- Defined in locale-settings.ts:213

toLowerChar

toLowerChar(char: string): string
Convert a single character to lowercase using culture-specific rules. Handles special cases like Turkish 'I' → 'ı' vs Turkish 'İ' → 'i'.
Parameters
- char: string
  The character to convert to lowercase.
Returns string
The lowercased character.
Example
```
const usSettings = DotNetLocaleSettings.create('en-US');
usSettings.toLowerChar('I');  // "i"

const trSettings = DotNetLocaleSettings.create('tr-TR');
trSettings.toLowerChar('I');  // "ı" (Turkish dotless i)
trSettings.toLowerChar('İ');  // "i" (Turkish dotted i)
```
- Defined in locale-settings.ts:431

toUpperChar

toUpperChar(char: string): string
Convert a single character to uppercase using culture-specific rules. Handles special cases like Turkish 'i' → 'İ' vs standard 'i' → 'I'.
Parameters
- char: string
  The character to convert to uppercase.
Returns string
The uppercased character.
Example
```
const usSettings = DotNetLocaleSettings.create('en-US');
usSettings.toUpperChar('i');  // "I"

const trSettings = DotNetLocaleSettings.create('tr-TR');
trSettings.toUpperChar('i');  // "İ" (Turkish dotted I)
```
- Defined in locale-settings.ts:389

tryStrToBigInt

tryStrToBigInt(value: string): Result<bigint>
Attempts to parse a BigInt from a string.
Parameters
- value: string
  The string to parse. Must contain only digits and an optional leading +/- sign.
Returns Result<bigint>
A Result containing the parsed BigInt if successful, or an error if parsing fails.
Example
```
settings.tryStrToBigInt('12345678901234567890');  // Ok(12345678901234567890n)
settings.tryStrToBigInt('-999');  // Ok(-999n)
```
- Defined in locale-settings.ts:313

tryStrToBool

tryStrToBool(value: string): Result<boolean>
Attempts to parse a boolean value from a string.
Parameters
- value: string
  The string to parse. Accepts: "true", "1", "yes" (case-insensitive) for true, and "false", "0", "no" for false.
Returns Result<boolean>
A Result containing the boolean value if successful, or an error if parsing fails.
Example
```
settings.tryStrToBool('yes');    // Ok(true)
settings.tryStrToBool('false');  // Ok(false)
settings.tryStrToBool('invalid');  // Err("Invalid boolean string")
```
- Defined in locale-settings.ts:267

tryStrToDate

tryStrToDate(value: string): Result<Date>
Attempts to parse a Date from a string.
Parameters
- value: string
  The string to parse. Accepts various date formats understood by JavaScript Date constructor.
Returns Result<Date>
A Result containing the parsed Date if successful, or an error if parsing fails.
Example
```
settings.tryStrToDate('2024-07-05');  // Ok(Date)
settings.tryStrToDate('July 5, 2024');  // Ok(Date)
settings.tryStrToDate('invalid');  // Err("Invalid date string")
```
- Defined in locale-settings.ts:366

tryStrToInt

tryStrToInt(value: string): Result<number>
Attempts to parse an integer from a string.
Parameters
- value: string
  The string to parse. Must contain only digits and an optional leading +/- sign.
Returns Result<number>
A Result containing the parsed integer if successful, or an error if parsing fails.
Example
```
settings.tryStrToInt('123');    // Ok(123)
settings.tryStrToInt('-456');   // Ok(-456)
settings.tryStrToInt('12.34');  // Err("Invalid integer string")
```
- Defined in locale-settings.ts:291

tryStrToNumber

tryStrToNumber(value: string): Result<number>
Attempts to parse a number from a string using locale-specific formatting. Handles currency symbols, thousands separators, and locale-specific decimal separators.
Parameters
- value: string
  The string to parse.
Returns Result<number>
A Result containing the parsed number if successful, or an error if parsing fails.
Example
```
const usSettings = DotNetLocaleSettings.create('en-US');
usSettings.tryStrToNumber('1,234.56');  // Ok(1234.56)
usSettings.tryStrToNumber('$1,234.56');  // Ok(1234.56)

const frSettings = DotNetLocaleSettings.create('fr-FR');
frSettings.tryStrToNumber('1 234,56');  // Ok(1234.56)
```
- Defined in locale-settings.ts:341

`Static`create

create(localeName: string): DotNetLocaleSettings
Creates a DotNetLocaleSettings instance for the specified locale.
Parameters
- localeName: string
  The locale name (e.g., "en-US", "fr-FR", "de-DE").
Returns DotNetLocaleSettings
A new DotNetLocaleSettings instance configured for the specified locale.
Example
```
const usSettings = DotNetLocaleSettings.create('en-US');
const frSettings = DotNetLocaleSettings.create('fr-FR');
```
- Defined in locale-settings.ts:178

`Static`createInvariant

createInvariant(): DotNetLocaleSettings
Creates a DotNetLocaleSettings instance for the invariant culture (en-US). The invariant culture provides consistent formatting across all systems.

Returns DotNetLocaleSettings
A new DotNetLocaleSettings instance configured for invariant culture.
Example
```
const settings = DotNetLocaleSettings.createInvariant();
console.log(settings.decimalSeparator);  // "."
console.log(settings.thousandSeparator);  // ","
```
- Defined in locale-settings.ts:195

Class DotNetLocaleSettings

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DotNetLocaleSettings

Example

Properties

ReadonlycurrencyString

ReadonlydateSeparator

ReadonlydecimalSeparator

ReadonlydefaultCurrency

ReadonlydefaultDecimal

ReadonlydefaultFloat

Readonlyid

Readonlyname

ReadonlythousandSeparator

ReadonlytimeSeparator

Static Readonlycurrent

Static Readonlyinvariant

Methods

boolToStr

Parameters

Returns string

Example

dateToStr

Parameters

Returns string

Example

numberToStr

Parameters

Returns string

Example

toLowerChar

Parameters

Returns string

Example

toUpperChar

Parameters

Returns string

Example

tryStrToBigInt

Parameters

Returns Result<bigint>

Example

tryStrToBool

Parameters

Returns Result<boolean>

Example

tryStrToDate

Parameters

Returns Result<Date>

Example

tryStrToInt

Parameters

Returns Result<number>

Example

tryStrToNumber

Parameters

Returns Result<number>

Example

Staticcreate

Parameters

Returns DotNetLocaleSettings

Example

StaticcreateInvariant

Returns DotNetLocaleSettings

Example

Settings

On This Page

`Readonly`currencyString

`Readonly`dateSeparator

`Readonly`decimalSeparator

`Readonly`defaultCurrency

`Readonly`defaultDecimal

`Readonly`defaultFloat

`Readonly`id

`Readonly`name

`Readonly`thousandSeparator

`Readonly`timeSeparator

`Static` `Readonly`current

`Static` `Readonly`invariant

`Static`create

`Static`createInvariant