# simple-placeholder-replacer

> A simple placeholder replacer

Latest version **1.1.0** (published 2021-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-placeholder-replacer
pnpm add simple-placeholder-replacer
yarn add simple-placeholder-replacer
bun add simple-placeholder-replacer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-03-15 |
| First published | 2021-03-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Benoit Wauthier |
| Maintainers | benoit_wauthier |
| Keywords | Placeholder, replacer |

## Links

- npm: https://www.npmjs.com/package/simple-placeholder-replacer
- npm.io page: https://npm.io/package/simple-placeholder-replacer

## Dependencies (1)

- [moment](https://npm.io/package/moment.md) ^2.29.1

## Recent versions

- 1.1.0 (latest) — 2021-03-15
- 1.0.0 — 2021-03-12

## README

# simple-placeholder-replacer
[![Build Status](https://travis-ci.com/BenoitWauthier/simple-placeholder-replacer.svg?branch=master)](https://travis-ci.com/github/BenoitWauthier/simple-placeholder-replacer)
[![Coverage Status](https://coveralls.io/repos/github/BenoitWauthier/simple-placeholder-replacer/badge.svg)](https://coveralls.io/github/BenoitWauthier/simple-placeholder-replacer)
![dependencies Status](https://img.shields.io/david/BenoitWauthier/simple-placeholder-replacer)
![devDependencies Status](https://img.shields.io/david/dev/BenoitWauthier/simple-placeholder-replacer?label=devDependencies)
[![Known Vulnerabilities](https://snyk.io/test/github/BenoitWauthier/simple-placeholder-replacer/badge.svg)](https://snyk.io/test/github/BenoitWauthier/simple-placeholder-replacer)

![Npm version](https://img.shields.io/npm/v/simple-placeholder-replacer?label=latest-version)
![Npm downloads](https://img.shields.io/npm/dm/simple-placeholder-replacer)
![Npm download size](https://img.shields.io/bundlephobia/min/simple-placeholder-replacer)
![Last Commit](https://img.shields.io/github/last-commit/BenoitWauthier/simple-placeholder-replacer)
![Contributors](https://img.shields.io/github/contributors/BenoitWauthier/simple-placeholder-replacer)

A library to replace placeholders in a json/string object. 
You have to use double curly brackets {{placeholderKey}} to identify the placeholder and proivide a map with pairs of key / value where the key is the name of the placeholder (case doesn't matter) and value is the replacement value for that placeholder.
The library can also handle date / date time placeholders that are {{now}} or {{today}} (again case doesn't matter) and that can be configured with the following options :

- a number of units to add / subtract to the system date / time 
    e.g. {{today+1d}}  -> will cause the library to replace this tag with the system date + one day
    Note that the unit is not mandatory, days will be the unit by default for {{today}} and hours for {{now}}
    
    Available units for {{today}} are :
    
        - d / D : days
        - m / M : months
        - y / Y : years
        - w / W : weeks
        
    Available units for {{now}} are :
    
        - h / H : hours
        - m / M : minutes
        - s / S : seconds
        
- the desired output format for the date / date time
    e.g. {{now=HH:MM:SS}} -> will output the current time
    Note that the format must be compatible with formats recognized by the moment js library
    
    Default formats are :
    
        - {{today}} -> YYYY-MM-DD
        - {{now}}   -> YYYY-MM-DDTHH:MM:SS

## Installation

To install with npm:

```
npm i simple-placeholder-replacer --save
```

## Usage

Usage with node:

```
var replacePlaceholders = require('simple-placeholder-replacer');

replacePlaceholders('I want {{myPlaceholder}} to be replaced', {myPlaceholder: 'this placeholder'});

--> 'I want this placeholder to be replaced'

replacePlaceholders({"myDate": "{{today+1m=DD MM YYYY}}"});

--> assulming today is the 11-03-2021 : {"myDate": "11 04 2021"}

```

## Release

```
npm version major / minor / patch
git push origin ${tagName}

```

## License

This is licensed under an MIT License. [See details](LICENSE)

---
_Source: https://npm.io/package/simple-placeholder-replacer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._