@momsfriendlydevco/formatters v1.2.3

@MomsFriendlyDevCo/Formatters

Collection of string formatters in ES6 exportable format.

All formatters are usable as either sub-methods or individual stand-alone libraries:

// Import as global formatter object
import formatters from '@momsfriendlydevco/formatters';

formatters.bytes(1024); //= "1kb"

// Import just the function
import {bytes} from '@momsfriendlydevco/formatters';

bytes(1024); //= "1kb"

// Import function, but prefixed
import {formatBytes} from '@momsfriendlydevco/formatters';

formatBytes(1024); //= "1kb"

Formatters

As above all formatters are either camel cased from the main module, exported as the same or can be addressed as format${MODULE}.

bytes(value)

Return a short, human readable byte string. Also available as formatBytes()

import {bytes} from '@momsfriendlydevco/formatters';

bytes(1024); //= "1kb"

list(value) / listAnd(value) / listOr(value)

Combine a list of strings into a readable list. Also available as listAnd(), listOr(), formatList(), formatListAnd(), formatListOr()

import {list, listOr} from '@momsfriendlydevco/formatters';

list(['Foo', 'Bar', 'Baz']); //= "Foo, Bar and Baz"
listOr(['Foo', 'Bar', 'Baz']); //= "Foo, Bar or Baz"

list(['foo', 'bar', 'baz'], {cutoff: 2}); //= "foo, bar and 1 other"

Options are:

number(value)

Return a formatted number. Also available as formatNumber()

import {number} from '@momsfriendlydevco/formatters';

number(1024); //= "1,024"

percentage(value)

Return a formatted number. Also available as formatPercentage()

import {number} from '@momsfriendlydevco/percentage';

percentage(10.2382412314); //= "10.24%"

plural(value)

Try to pluralize a word (if it is necessary). Also available as formatPlural()

Note that this function can be called in numerous ways:

// Pluralize a single word
pluralize('item') //= "items"

// Pluralize conditionally based on value
pluralize(1, 'item') //= "item"
pluralize(10, 'item') //= "items"
pluralize(1, 'item', {prefix: true}) //= "1 item"
pluralize(10, 'item', {prefix: true}) //= "10 items"

// Specify pluralization rules (pipes)
pluralize(1, 'item|items') //= "item"
pluralize(3, 'item|items') //= "items"
pluralize(1, 'item|items', {prefix: true}) //= "1 item"
pluralize(10, 'item|items', {prefix: true}) //= "10 items"

// Specify pluralization rules (braces)
pluralize(1, 'item[s]') //= "item"
pluralize(3, 'item[s]') //= "items"
pluralize(1, 'pe[erson|ople]') //= "person"
pluralize(3, 'pe[erson|ople]') //= "people"

Supported options are:

relativeTime(value, options)

Return a short string indicating a relative time. Also available as formatRelativeTime()

import {relativeTime} from '@momsfriendlydevco/formatters';

number(Date.now() - 1000); //= 1s
number(Date.now() + 1000 * 60); //= 1m
number(Date.now() + 1000 * 60 * 60); //= 1h

Supported options are:

format(value)

Apply the above functions to a string or array of strings using square braces to denote markup.

Notes:

• Any attribute within square brackets are passed onto that formatter - e.g. 10[% dp=2] actually calls formatPercentage(10, {dp: 2})
• Attributes specified without a value are assumed to specify true - e.g. [list or quote]foo,bar,baz[/list] -> formatList(['foo', 'bar', 'baz'], {or: true, quote: true})
• All [list]...[/list] markups expect a CSV (and will auto truncate spacing)
• Usage of [#] is limited to one list per string, if you need more prove format() an array of strings which will be concatted.

Utilities

config.setLocale(newLocale)

Chanegs the default locale for all modules. Note that this function has to return a Promise as some sub-modules need to dynamically load locale libraries.

import formatters from '@momsfriendlydevco/formatters';

formatters.setLocale('de');

formatters.relativeTime(Date.now() - 1000 * 60 * 60); //= 1 Std.