Module Format

The CLR Format main module and namespace.

The StringConstructor.format method exposes the core API of the project. Optional configuration methods are stored in the Format.Config sub-module.

Index

Modules

Interfaces

FormatItemOptions

Variables

Functions

Variables

Private CultureInfo

CultureInfo: CultureInfo

Private formatItemRegExp

formatItemRegExp: RegExp

Private padding

padding: Padding

Private paddingDirection

paddingDirection: Direction

Functions

Private applyAlignment

applyAlignment(formattedString: string, options: FormatItemOptions): string

- Defined in core/Format.ts:194
Parameters
- formattedString: string
- options: FormatItemOptions
Returns string

Private applyFormatting

applyFormatting(provider: FormatProvider, args: Object[], options: FormatItemOptions): string

- Defined in core/Format.ts:171
Parameters
- provider: FormatProvider
- args: Object[]
- options: FormatItemOptions
Returns string

Private getBracesCount

getBracesCount(formatItem: string, braceChar: string): number

- Defined in core/Format.ts:146
Parameters
- formatItem: string
- braceChar: string
Returns number

innerComponentFormat

innerComponentFormat(formatStringComponent: string, value: Object, provider?: FormatProvider): string

- Defined in core/Format.ts:105
Converts the object's value to string based on the format specified and returns it.

Parameters
- formatStringComponent: string
  
  A format string component (part of the composite format string). See: https://msdn.microsoft.com/library/txafckwd.aspx
- value: Object
  
  The object to format.
- Optional provider: FormatProvider
  
  An object that supplies culture-specific formatting information.
Returns string

The string representation of the object's value, formatted as specified by the format string component and provider.

innerFormat

innerFormat(provider: FormatProvider, format: string, args: Object[]): string

- Defined in core/Format.ts:79
Converts the value of objects to strings based on the formats specified and inserts them into another string.

This project-internal (but externally visible) version does not support arbitrary argument overloads.

Parameters
- provider: FormatProvider
  
  An object that supplies culture-specific formatting information.
- format: string
  
  A composite format string. See: https://msdn.microsoft.com/library/txafckwd.aspx
- args: Object[]
  
  An array of arguments that contains zero or more objects to format.
Returns string

A copy of the format string in which the format items have been replaced by the string representation of the corresponding objects in args.

Private isFullyEscaped

isFullyEscaped(formatItem: string): boolean

- Defined in core/Format.ts:158
Parameters
- formatItem: string
Returns boolean

Private padBraces

padBraces(formattedString: string, escapedBracesCount: number, paddingChar: string): string

- Defined in core/Format.ts:209
Parameters
- formattedString: string
- escapedBracesCount: number
- paddingChar: string
Returns string

Private replaceFormatItem

replaceFormatItem(provider: FormatProvider, args: Object[], options: FormatItemOptions): string

- Defined in core/Format.ts:124
Parameters
- provider: FormatProvider
- args: Object[]
- options: FormatItemOptions
Returns string

setCulture

setCulture(locale: string): void

- Defined in core/Format.ts:51
Sets the current default culture (the CurrentCulture property) based on the supplied locale parameter.

Parameters
- locale: string
  
  A string holding a BCP 47 language tag.
Returns void

setCurrency

setCurrency(currencyCode: string): void

- Defined in core/Format.ts:61
Sets the current default currency (the CurrentCurrency property) based on the supplied currency code.

Parameters
- currencyCode: string
  
  The currency to use in currency formatting. See current currency & funds code list.
Returns void

Generated using TypeDoc