This package can help you format your strings easily with placeholders. Comes in handy when you are importing the strings from another module.
When you're importing a string from a module, it is not possible to use $-based placeholders because the variables serving as the placeholders may not exist in the module where the strings are declared. To solve this, we came up with Vanes.
Using Vanes, you can place any keyword as your placeholder as long as you tie them in with braces (Remember: no spaces between the braces and the keyword). When you import the string in your other module, just pass that string and a comma separated key-value object where keys are the placeholders in the string and values are the variables or constants you want to replace them with.
And, voila! Vanes will return you a string with all the values replaced.
Install from command line:
npm install --save vanes
Or
Install via package.json:
Add the following to your package.json file under dependencies
"vanes": "1.1.0"
const vanes = require('vanes');
let str = `Hello, {var}!`;
let value = 'World';
let result = vanes(str, {var: value});
console.log(result)
//Output - Hello, World!vanes(string, {key: value})
-
string: input string with placeholders in it
-
key: variable serving as the placeholder in the string
-
value: variable name/constant value that needs to replace the placeholder(key) in the string
Multiple key-value pairs can be sent separated by comma.
Unit testing has been added as part of the latest release.
To run the test case, download the package and run npm test.
Vanes is published under the MIT license. For more information, see the accompanying LICENSE file.
If you find this package useful, please consider giving a star to this project on Github.
And, if you are willing to buy me a coffee, that would be awesome. :)
