@simple_merchant/sd-formatter

Simple Dealer standard formatting library

Usage no npm install needed!

<script type="module">
  import simpleMerchantSdFormatter from 'https://cdn.skypack.dev/@simple_merchant/sd-formatter';
</script>

README

Description

A functional formatting library that follows SD Standard rules for displaying data.

Installation

Add this as a dependency to your project using npm with

$ npm i @simple_merchant/sd-formatter

or using Yarn with

$ yarn add @simple_merchant/sd-formatter

Usage

See the complete documentation

Currency

import { currency, currencyOptions } from '***/***' // standard compose function

const amount = 123.45
currency(amount) //=> '$123.45'

// with diffent currency
currency(amount, {currency: 'GHS'}) //=> 'GHS 123.45'

// with currencyOptions constants 
currency(amount, { currency: currencyOptions.currency.GBP }) //=> '£123.45'

Date

import { date, dateOptions } from '***/***'

const currentDate = '2021-10-13T22:16:18.032Z'

date(currentDate)//=> 'October 13, 2021'

//With options
date(currentDate, {
  year: dateOptions.year.DIGIT // '2-digit', 
  month: dateOptions.month.SHORT // 'short', 
  day: dateOptions.day.NUMERIC // 'numeric', 
  weekday: dateOptions.weekend.LONG // 'long',
})//=> 'Wednesday, Oct 13, 21'

NumberFormat

import { numberFormat, numberFormatOptions } from '***/***'

//Phone formatting
const phoneNumber = '1234567890'
numberFormat(phoneNumber, formatOptions.PHONE)//=> '123-456-7890'

//SSN formatting
const ssn = '123456789'
numberFormat(phoneNumber, formatOptions.SSN)//=> '123-45-6789'

Currency Parameters

  • amount: An integer or a float for the amount to be formatted.

  • options:

    • currency: The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro, or "CNY" for the Chinese RMB — see the Current currency & funds code list. The default value is USD.
    • local: A string with a BCP 47 language tag, or an array of such strings. For the general form and interpretation of the locale argument, see the Intl page. The default value is en-US.

Date Parameters

  • date: A date string or Date object.
  • options: Using the dateOptions relative to the options
    • year: NUMERIC | DIGIT | undefined,
    • month: LONG | NUMERIC | DIGIT | NARROW' | SHORT | undefined,
    • day: NUMERIC | DIGIT | undefined
    • weekend: LONG | NARROW | SHORT | undefined,

Format Parameters

  • value: the string or number to formatted
  • options: Using the numberFormatOptions
    • PHONE: For phone number formatting
    • SSN: For social security number formatting