@omnicar/sam-format

Library for formatting different kinds of data according to type and locale

Usage no npm install needed!

<script type="module">
  import omnicarSamFormat from 'https://cdn.skypack.dev/@omnicar/sam-format';
</script>

README

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 init to initialize formatters (locale data etc).

These parameters are available:

  • isoName - (da-DK | sv-SE | fi-FI | nb-NO) identifier for locale

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