parse-it

Configurable string templating, without separators.

☁️ Installation

# Using npm
npm install --save parse-it

# Using yarn
yarn add parse-it

📋 Example

const parseIt = require("parse-it");

// Replace strings
console.log(parseIt("Hello WORLD!", { WORLD: "Mars" }));
// => Hello Mars!

// Use functions
console.log(parseIt("Random number: random", { random: () => Math.random() }));
// => Random number: 0.21168493130244315

// Using as class
var Parser = parseIt.Parser;

// Display a date
var p = new Parser({
    d: function (d) { return d.getDate() }
  , M: function (d) { return d.getMonth() }
  , YYYY: function (d) { return d.getFullYear() }
});

console.log(p.run("d/M/YYYY", [new Date(1989, 11, 20)]));
// => 20/11/1989

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

ParseIt(obj)

The ParseIt class. It can be used to use the same data object but with different formats/arguments.

Params

• Object obj: An object containing the fields to replace.

parseIt(format, args)

run Replaces the fields in the format string with data coming from the data object.

Params

• String format: The format input.
• Array args: An array of arguments to be passed to the replace function (stored in the obj object).

Return

• String The result as string.

parseIt(format, obj, args)

A wrapper around the ParseIt class. The ParseIt constructor is accessible using parseIt.Parser.

Params

• String format: The format input.
• Object obj: An object containing the fields to replace.
• Array args: An array of arguments to be passed to the replace function (stored in the obj object).

Return

• String The result as string.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• formatoid

📜 License

MIT © Ionică Bizău