@serenity-is/corelib / Locale

Interface: Locale

Interface for a locale, similar to .NET's CultureInfo

Hierarchy

• NumberFormat

• DateFormat

  ↳ Locale

Table of contents

Properties

• amDesignator
• currencySymbol
• dateFormat
• dateOrder
• dateSeparator
• dateTimeFormat
• dayNames
• decimalDigits
• decimalSeparator
• firstDayOfWeek
• groupSeparator
• minimizedDayNames
• monthNames
• nanSymbol
• negativeSign
• percentSymbol
• pmDesignator
• positiveSign
• shortDayNames
• shortMonthNames
• stringCompare
• timeSeparator
• toUpper

Properties

amDesignator

• Optional amDesignator: string

AM designator

Inherited from

DateFormat.amDesignator

Defined in

src/base/formatting.ts:34

---

currencySymbol

• Optional currencySymbol: string

Currency symbol

Inherited from

NumberFormat.currencySymbol

Defined in

src/base/formatting.ts:20

---

dateFormat

• Optional dateFormat: string

Default date format string

Inherited from

DateFormat.dateFormat

Defined in

src/base/formatting.ts:28

---

dateOrder

• Optional dateOrder: string

Date order, like dmy, or ymd

Inherited from

DateFormat.dateOrder

Defined in

src/base/formatting.ts:30

---

dateSeparator

• Optional dateSeparator: string

Date separator

Inherited from

DateFormat.dateSeparator

Defined in

src/base/formatting.ts:26

---

dateTimeFormat

• Optional dateTimeFormat: string

Default date time format string

Inherited from

DateFormat.dateTimeFormat

Defined in

src/base/formatting.ts:32

---

dayNames

• Optional dayNames: string[]

Array of day names

Inherited from

DateFormat.dayNames

Defined in

src/base/formatting.ts:42

---

decimalDigits

• Optional decimalDigits: number

Number of digits after decimal separator

Inherited from

NumberFormat.decimalDigits

Defined in

src/base/formatting.ts:10

---

decimalSeparator

• decimalSeparator: string

Decimal separator

Inherited from

NumberFormat.decimalSeparator

Defined in

src/base/formatting.ts:6

---

firstDayOfWeek

• Optional firstDayOfWeek: number

First day of week, 0 = Sunday, 1 = Monday

Inherited from

DateFormat.firstDayOfWeek

Defined in

src/base/formatting.ts:40

---

groupSeparator

• Optional groupSeparator: string

Group separator

Inherited from

NumberFormat.groupSeparator

Defined in

src/base/formatting.ts:8

---

minimizedDayNames

• Optional minimizedDayNames: string[]

Array of two letter day names

Inherited from

DateFormat.minimizedDayNames

Defined in

src/base/formatting.ts:46

---

monthNames

• Optional monthNames: string[]

Array of month names

Inherited from

DateFormat.monthNames

Defined in

src/base/formatting.ts:48

---

nanSymbol

• Optional nanSymbol: string

Zero symbol

Inherited from

NumberFormat.nanSymbol

Defined in

src/base/formatting.ts:16

---

negativeSign

• Optional negativeSign: string

Negative sign

Inherited from

NumberFormat.negativeSign

Defined in

src/base/formatting.ts:14

---

percentSymbol

• Optional percentSymbol: string

Percentage symbol

Inherited from

NumberFormat.percentSymbol

Defined in

src/base/formatting.ts:18

---

pmDesignator

• Optional pmDesignator: string

PM designator

Inherited from

DateFormat.pmDesignator

Defined in

src/base/formatting.ts:36

---

positiveSign

• Optional positiveSign: string

Positive sign

Inherited from

NumberFormat.positiveSign

Defined in

src/base/formatting.ts:12

---

shortDayNames

• Optional shortDayNames: string[]

Array of short day names

Inherited from

DateFormat.shortDayNames

Defined in

src/base/formatting.ts:44

---

shortMonthNames

• Optional shortMonthNames: string[]

Array of short month names

Inherited from

DateFormat.shortMonthNames

Defined in

src/base/formatting.ts:50

---

stringCompare

• Optional stringCompare: (a: string, b: string) => number

Locale string comparison function, similar to .NET's StringComparer

Type declaration

▸ (a, b): number

Parameters

Name	Type
a	string
b	string

Returns

number

Defined in

src/base/formatting.ts:56

---

timeSeparator

• Optional timeSeparator: string

Time separator

Inherited from

DateFormat.timeSeparator

Defined in

src/base/formatting.ts:38

---

toUpper

• Optional toUpper: (a: string) => string

Locale string to upper case function

Type declaration

▸ (a): string

Parameters

Name	Type
a	string

Returns

string

Defined in

src/base/formatting.ts:58