Skip to main content

@rtorcato/js-common / formatting

formatting

Functions​

padZero()​

padZero(value, length?): string

Defined in: formatting/index.ts:7

Pads a string or number with leading zeros to a given length.

Parameters​

value​

string | number

The value to pad.

length?​

number = 2

The desired length.

Returns​

string

The padded string.

formatNumber()​

formatNumber(num, locale?): string

Defined in: formatting/index.ts:17

Formats a number with thousands separators.

Parameters​

num​

number

The number to format.

locale?​

string = 'en-US'

Optional locale string (default: 'en-US').

Returns​

string

The formatted string.

formatPercent()​

formatPercent(value, fractionDigits?): string

Defined in: formatting/index.ts:27

Formats a number as a percentage string.

Parameters​

value​

number

The value to format (e.g. 0.25 for 25%).

fractionDigits?​

number = 0

Number of decimal places (default: 0).

Returns​

string

The formatted percentage string.

formatDate()​

formatDate(date): string

Defined in: formatting/index.ts:36

Formats a Date as YYYY-MM-DD.

Parameters​

date​

Date

The date to format.

Returns​

string

The formatted date string.

formatTime()​

formatTime(date): string

Defined in: formatting/index.ts:45

Formats a Date as HH:MM:SS.

Parameters​

date​

Date

The date to format.

Returns​

string

The formatted time string.

formatDateTime()​

formatDateTime(date): string

Defined in: formatting/index.ts:54

Formats a Date as YYYY-MM-DD HH:MM:SS.

Parameters​

date​

Date

The date to format.

Returns​

string

The formatted date-time string.