Hook useFormatter

The useFormatter hook returns formatterNumber and formatterIban objects for use in an application.

import { useFormatter, LoggerBrowser } from '@bitrix24/b24jssdk'

const { formatterIban, formatterNumber } = useFormatter()
const $logger = LoggerBrowser.build('Test', import.meta.env?.DEV === true)

$logger.info(formatterIban.printFormat('IT60X0542811101000000123456', ' '))
// IT60 X054 2811 1010 0000 0123 456 ////

$logger.info(formatterNumber.format(15678.987, B24LangList.de)) // 15.678,99 ///

FormatterIban

Provides methods for working with IBAN, including validation and conversion to BBAN.

Methods

isValid

isValid(
	iban: string
): boolean

Checks if the IBAN is valid.

printFormat

printFormat(
	iban: string,
	separator?: string
): string

Formats the IBAN with the specified separator.

electronicFormat

electronicFormat(
	iban: string
): string

Converts the IBAN to electronic format.

toBBAN

toBBAN(
	iban: string,
	separator?: string
): string

Converts the IBAN to BBAN.

fromBBAN

fromBBAN(
	countryCode: string,
	bban: string
): string

Converts BBAN to IBAN.

isValidBBAN

isValidBBAN(
	countryCode: string,
	bban: string
): boolean

Checks if the BBAN is valid.

$logger.info(
	formatterIban.printFormat('IT60X0542811101000000123456', ' ')
)
// IT60 X054 2811 1010 0000 0123 456 ////

TIP

You can test working with formatterIban in this example.

FormatterNumbers

Provides methods for formatting numbers based on locale.

Methods

setDefLocale

setDefLocale(
	locale: string
): void

Sets the default locale.

format

format(
	value: number,
	locale?: string
): string

Formats the number based on the specified locale.

$logger.info(
	formatterNumber.format(15678.987, B24LangList.en)
) // 15,678.99 ///

$logger.info(
	formatterNumber.format(15678.987, B24LangList.de)
) // 15.678,99 ///

$logger.info(
	formatterNumber.format(15678.987, B24LangList.ru)
) // 15 678,99 ///