Skip to content
This repository has been archived by the owner on Oct 5, 2023. It is now read-only.
/ variable-parser Public archive

Variable Parser helps you translate in-string variables to preset values.

License

Notifications You must be signed in to change notification settings

TMWare/variable-parser

Repository files navigation

Variable Parser

Variable Parser helps you translate in-string variables (i.e. {something} like this, where something would be a variable) to values.

Getting Started

Installation

With npm: npm install --save @tmware/variable-parser

With yarn: yarn add @tmware/variable-parser

Usage

const VariableParser = require('@tmware/variable-parser')

const YourParser = new VariableParser() // initialize without data
const YourParser = new VariableParser({
  testVariable: 'World',
  anotherOne: 'Hello',
  someNumber: 69
})
// initialize with data
console.log(
  YourParser.parse(
    '{anotherOne} {testVariable}! some text to show you that this works. {someNumber}'
  )
)
// => 'Hello World! some text to show you that this works. 69'

More advanced examples

Custom indicators (those things around the variables. default: {})

const YourParser = new VariableParser({ someVariable: 3 }, '[]')

const result = YourParser.parse('[someVariable]')

console.log(result)
// => '3'
// Note: This is still a string

License

Please refer to the LICENSE file.