format-string-by-pattern

format-string-by-pattern

Overview

This module consists on a function that receives a pattern and a value and returns this value formatted according to the pattern.

Why?

I had to write a specific function to format every value I needed and that sucks, so I decided to try write a function to format any value based on any pattern. This is my attempt. 😃

Other solutions

I don't know any other solutions to this problem. If you do, feel free to open a PR adding it to the README.md.

Usage

const formatStringByPattern = require('format-string-by-pattern');

formatStringByPattern('YYYY-MM-DD', '20180508');
// '2018-05-08'

formatStringByPattern('2018-05-08', '20151217');
// '2015-12-17'

// It works with curry too
const someFormat = formatStringByPattern('00.00');
someFormat(1234);
// 12.34

NOTE: The returned value will be sliced to the size of the pattern.

This library is pretty useful with forms, where you need to parse the input values. See the usage with the react-final-form library here.

API

formatStringByPattern(pattern, valueToFormat)

Returns a string.

pattern

Type: string

A string where anything that is not a number or letter will be treated as a separator.

valueToFormat

Type: string or number

A value to be formatted.

License

MIT © Arthur Denner