@omnicar/sam-format v1.0.0
SAM-format
Library for formatting data according to locale and options given.
Installation (for development)
yarn
or npm i
(examples below are using yarn
)
Installation on clients
yarn add omnicar/sam-format#0.0.1
Where #0.0.1
indicates the Github
release tag.
Usage
First call initFormats
.
const options = {
countryCode: TIsoCountry,
currencyCode: TCurrency,
language: IsoLocale
}
initFormats(options)
Example:
initFormats({
countryCode: 'DK',
currencyCode: 'DKK',
language: 'da-DK'
})
Formatters
There are 4 formatters:
formatMileage(value, opts)
showDecimals
(true | false) show decimals in formatted number
symbolDisplayType
(APPEND | PREPEND | NONE) where to put symbol related to number type
formatCurrency(value, opts)
showDecimals
(true | false) show decimals in formatted number
symbolDisplayType
(APPEND | PREPEND | NONE) where to put symbol related to number type
formatNumber(value, showDecimals)
showDecimals
(true | false) show decimals in formatted number
formatDate(value, opts)
showTime
(true | false) append time in formatted date
rawFormat
(string) pass date format string to format with
example: formatDate(new Date(2018-01-23), {rawFormat: 'YYYYMMDD'})
// '20189123'
Tests
To run jest
tests either run:
yarn test
or to run tests in watch mode run:
yarn test-watch
Compile application (tsc
):
yarn tsc
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago