Class VariableParser<Data>

Parse Variables in a String

import { string, number } from "@rjweb/utils"

type Data = {
  something: number
}

const parser = new string.VariableParser<Data>()
  .variable(
    'round',
    (args) => args
      .required('number')
      .optional('decimals'),
    (data, args, invalid) => {
      const num = parseFloat(args.number)
      if (isNaN(num)) return invalid('Invalid Number')

      const decimals = args.decimals ? parseInt(args.decimals) : 2
      if (isNaN(decimals) || decimals > 6) return invalid('Invalid Decimal Amount')

      return number.round(num * data.something, decimals).toString()
    }
  )
  .variable(
    'echo',
    (args) => args
      .required('text'),
    (data, args) => {
      return args.text
    }
  )
  .compile()

await parser.validate('Hi', { something: 1 }) // { valid: true }
await parser.validate('Hi {{round}}', { something: 1 }) // { valid: false, error: ['Missing Required Arguments to `round`'] }
await parser.parse('I have {{round(10.32323463246, 4)}}{{echo(€\\, Sir.)}}', { something: 1 }) // 'I have 10.3232€, Sir.'
Copy

Since

1.8.3

Supports

nodejs, browser