array format
Updated on August 22, 2024Source codeTests
createArrayFormat is a pipe that transforms an array to a string formatted by Intl.ListFormat.
Create format
Call createArrayFormat with the Intl.ListFormat constructor's parameters to create your format function.
Creating new Intl instances can be expensive, so createArrayFormat implements some performance improvements:
- Each time you call
createArrayFormat, it checks to see if you have already created aListFormatinstance with the same parameters. If you have, it reuses that instance. - Each time you call your
formatfunction, it reuses the sameListFormatinstance.
import { createArrayFormat as createFormat } from '@baleada/logic'
// The first time you call `createFormat`, it creates a new
// `ListFormat` instance, and returns the `format` function.
const format = createFormat(
'en',
{ style: 'long', type: 'conjunction' }
)
format(['one', 'two', 'three']) // 'one, two, and three'
// In a distant part of your app, you might call `createFormat`
// again with the same parameters. `createFormat` will check for
// deep equality between the parameters you pass and any parameters
// that have been passed before.
//
// In this case, parameters are deeply equal, so `createFormat`
// will internally reuse the original `ListFormat` instance,
// boosting your app's performance:
const formatAgain = createFormat(
'en',
{ style: 'long', type: 'conjunction' }
)
formatAgain(['one', 'two', 'three']) // 'one, two, and three'
