format-fast v1.0.2

format-fast

Hi, I'm Yoni Calsin, I'd love you to give format-fast a chance, to shine inside your project, and to format a text string in a wonderful way, and of course with less code.

Format-fast is a function that allows you to replace certain words to make a string dynamically, and very easily !

🍉 Installation

First we will have to install, in order to use this wonderful package.

# Using npm
npm install --save format-fast

# Using yarn
yarn add format-fast

🌎 Usage

Format-fast use is-all-utils to validate the format of different characteristics !

First we import the function, as follows !

To use format-fast you can use the formatFast or f function, they are practically the same, only f is very short !

// For Typescript
import formatFast from 'format-fast';
// Or
import { f } from 'format-fast';

// Javascript
const formatFast = require('format-fast');
// or
const { f } = require('format-fast');

Individually

If you want to send just one piece of information !

const msg = "Hello, I'm '$0' years old";
f(msg, 20);
//=> Hello, I'm '20' years old

Array

The time has come to use format-parse, using an array

const msg = "The '$0' of user '$1' is not defined within the object '$2";

f(msg, ['name', 20, 'users']);
//=> The 'name' of user '20' is not defined within the object 'users

Object

Soon we will use it with an object !

const msg =
   "The '$property' of the user '$id' is not defined within the object '$data'";

f(msg, {
   property: 'name',
   id: 20,
   data: 'users',
});
//=> The 'name' of the user '20' is not defined within the object 'users'

Iteration function!

Function to modify the value, and the key when each object is iterated !

const msg = "Hi, I'm '$fullname', I'm '$age' years old";

const iterateItem = (value, key) => {
   console.log(value, key);
   // 0: Yoni Calsin, fullname
   // 1: age, age

   if (key == 'age') {
      if (value > 18) {
         value = 40;
      } else {
         value = 5;
      }
   }

   if (key == 'fullname') {
      value = `🎉 ${value}`;
   }

   return value;
};

f(
   msg,
   {
      fullname: 'Yoni Calsin',
      age: 20,
   },
   iterateItem,
);
// => Hi, I'm '🎉 Yoni Calsin', I'm '40' years old

f(
   msg,
   {
      fullname: 'Samuel Calsin',
      age: 10,
   },
   iterateItem,
);
// => Hi, I'm '🎉 Samuel Calsin', I'm '5' years old

Returning the iterateItem function, as an array, if you return an array of two values, you will be replacing the key, and the

const iterateItem = (value, key) => {
   // This will replace the values
   // this works if you return two values
   return [
      // For value
      value,
      // For key
      key,
   ];
};

Brackets

• %s is the value of the key

const msg = "Hi, I'm '{0}'.";

f(msg, ['Yoni Calsin'], '{%s}');

// => Hi, I'm 'Yoni Calsin'.

Otro ejemplo

const msg = "Hi, I'm '[[0]]'.";

f(msg, ['Yoni Calsin'], '[[%s]]');

// => Hi, I'm 'Yoni Calsin'.

f(msg, replaces, brackets);
// Or
f(msg, replaces, iterateFunction, brackets);

⭐ Support for

format-fast is an open source project licensed by MIT. You can grow thanks to the sponsors and the support of the amazing sponsors. If you want to join them, contact me here.

🎩 Stay in touch

• Github @yonicalsin
• Twitter @yonicalsin
• Instagram @yoni_calsin
• Medium @yonicalsin
• Dev @yonicalsin

🚀 Contributors

Thanks to the wonderful people who collaborate with me !

📜 License

format-fast under License MIT.