stimmy

Description

This module provides a string variables replacer.

Install

$ npm install stimmy --save

Features

• Can replace variables from an object.
• Can replace variables from an array.

Documentation

• From an array
• From an object

Examples

From import

import stimmy from 'stimmy';

From require

const stimmy = require('stimmy');

init pattern

const myReplacer = stimmy(); // defaults to ('{','}')
const myReplacer2 = stimmy('{{', '}}')

From an array

  const str = myReplacer('This {0} is {1}!', ['module', 'awesome']);
  // This module is awesome!

  const str = myReplacer('{0}% of code coverage, it\'s {1}...', [100, 'so amazing']);
  // 100% of code coverage, it's so amazing...

From an object

  const str = myReplacer('{timmy} My hobby is {hobby}...', {timmy: 'Timmmmmmmyy !!', hobby: 'running'});
  // Timmmmmmmyy !! My hobby is running...

  const str = myReplacer('My name is {name}, I\'m {age}.', {name: 'stimmy', age: 25});
  // My name is stimmy, I'm 25.

Scripts

Run using npm run <script> command.

clean - remove coverage data, Jest cache and transpiled files,
lint - lint source files and tests,
typecheck - check type annotations,
test - lint, typecheck and run tests with coverage,
test-only - run tests with coverage,
test:watch - interactive watch mode to automatically re-run tests,
build - compile source files,
build:watch - interactive watch mode, compile sources on change.

License

MIT © Dimitri DO BAIRRO