Sitelet https://github.com/codingcommons/typesafe-i18n/tree/main/packages/formatters
Skip to content

formatters

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

formatters

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
example
example
 
 
src
src
 
 
README.md
README.md
 
 
esbuild.ts
esbuild.ts
 
 
generateTreeShakableIndexFile.ts
generateTreeShakableIndexFile.ts
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

typesafe-i18n Formatters

You can also format values you pass as an argument to typesafe-i18n.

Setup

See here on more information how to set up typesafe-i18n.

manual installation

npm install typesafe-i18n

Example

You can find an example how to configure and use formatters here.

You can run the example by opening the folder in your terminal and running:

npm run dev

Specify a formatter

You can specify your own formatters, that take an argument as an input and returns another value.

For more information about the LLL object, read the usage section of the main repository.

const formatters = {
   custom: (value) => (value * 4.2) - 7
}

LLL("For input '{0}' I get '{0|custom}' as a result", 100)
// => "For input '100' I get '413' as a result"

chaining formatters

If you need to apply multiple formatters to the same argument, you can chain them by using the pipe | operator:

const formatters = {
   sqrt: (value) => Math.sqrt(value),
   round: (value) => Math.round(value),
}

LLL('Result: {0|sqrt|round}', 5)
// => 'Result: 2'

The formatters get applied from left to right. So in this example 5 will be the input for the sqrt formatter, that will return 2.23606797749979. This value then gets passed to the round formatter that will output 2.

builtin formatters

You can also use a few builtin formatters:

date

A wrapper for Intl.DateTimeFormat.

import { date } from 'typesafe-i18n/formatters'

const formatters = {
   weekday: date('en', { weekday: 'long' })
}

LLL('Today is {0|weekday}', new Date())
// => 'Today is friday'

See here if you want to use this formatter in a Node.JS environment.

time

Same as the date-formatter

import { time } from 'typesafe-i18n/formatters'

const formatters = {
   timeShort: time('en', { timeStyle: 'short' })
}

LLL('Next meeting: {0|timeShort}', meetingTime)
// => 'Next meeting: 8:00 AM'

number

A wrapper for Intl.NumberFormat

import { number } from 'typesafe-i18n/formatters'

const formatters = {
   currency: number('en', { style: 'currency', currency: 'EUR' })
}

LLL('Your balance is {0|currency}', 12345)
// => 'your balance is €12,345.00'

See here if you want to use this formatter in a Node.JS environment.

replace

A wrapper for String.prototype.replace

import { replace } from 'typesafe-i18n/formatters'

const formatters = {
   noSpaces: replace(/\s/g, '-')
}

LLL('The link is: https://www.xyz.com/{0|noSpaces}', 'super cool product')
// => 'The link is: https://www.xyz.com/super-cool-product'

identity

Returns the variable without modifications

import { identity } from 'typesafe-i18n/formatters'

const formatters = {
   myFormatter: identity // (value) => value
}

LLL('Hello {name|myFormatter}', { name: 'John' })
// => 'Hello John'

ignore

Ignores the variable and returns an empty string.

import { ignore } from 'typesafe-i18n/formatters'

const formatters = {
   myFormatter: ignore // () => ''
}

LLL('Hello {name|myFormatter}', { name: 'John' })
// => 'Hello '

uppercase

A wrapper for String.prototype.toUpperCase

import { uppercase } from 'typesafe-i18n/formatters'

const formatters = {
   upper: uppercase
}

LLL('I said: {0|upper}', 'hello')
// => 'I said: HELLO'

lowercase

A wrapper for String.prototype.toLowerCase

import { lowercase } from 'typesafe-i18n/formatters'

const formatters = {
   lower: lowercase
}

LLL('He said: {0|lower}', 'SOMETHING')
// => 'He said: something'