Module "strings/index"

Index

Type aliases

Variables

knownFormatProviders

Functions

Type aliases

StringFormatProvider

StringFormatProvider: (val: any, match: string) => any

A string format provider function.

param: The input value.
param: The original match value.
returns: The output value.

Type declaration

- (val: any, match: string): any
- Parameters
  - val: any
  - match: string
  Returns any

StringFormatProviderList

StringFormatProviderList: {}

A list of string format providers.

Type declaration

[name: string]: StringFormatProvider

Variables

Let knownFormatProviders

knownFormatProviders: StringFormatProviderList

Functions

format

format(formatStr: any, ...args: any[]): string

- Defined in src/strings/index.ts:47
Formats a string.

Parameters
- formatStr: any
  
  The value that represents the format string.
- Rest ...args: any[]
Returns string

The formated string.

formatArray

formatArray(formatStr: any, args: Enumerable.Sequence<any>): string

- Defined in src/strings/index.ts:59
Formats a string.

Parameters
- formatStr: any
  
  The value that represents the format string.
- args: Enumerable.Sequence<any>
Returns string

The formated string.

getDefaultStringFormatProviders

getDefaultStringFormatProviders(): StringFormatProviderList

- Defined in src/strings/index.ts:113
Returns a (new) list of default string format providers, grouped by name.

Returns StringFormatProviderList

The new list.

registerStringFormatProviders

registerStringFormatProviders(providers?: StringFormatProviderList, withDefaults?: boolean): void

- Defined in src/strings/index.ts:157
Registers a new list of global string format providers.

Parameters
- Optional providers: StringFormatProviderList
- Optional withDefaults: boolean
Returns void

Generated using TypeDoc