# stimmy

> Replace your string variables by your values easily.

Latest version **1.2.2** (published 2018-02-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install stimmy
pnpm add stimmy
yarn add stimmy
bun add stimmy
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2018-02-20 |
| First published | 2018-01-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.9 |
| Dependencies | 0 |
| Unpacked size | 34.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Dimitri DO BAIRRO |
| Maintainers | rimiti |
| Keywords | string, manipulator, manipulation, variable, replace |

## Links

- npm: https://www.npmjs.com/package/stimmy
- Repository: https://github.com/rimiti/stimmy
- Homepage: https://github.com/rimiti/stimmy#readme
- Issues: https://github.com/rimiti/stimmy/issues
- npm.io page: https://npm.io/package/stimmy

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.2.2 (latest) — 2018-02-20
- 1.2.1 — 2018-02-20
- 1.2.0 — 2018-02-20
- 1.1.0 — 2018-01-25
- 1.0.3 — 2018-01-15
- 1.0.2 — 2018-01-15
- 1.0.1 — 2018-01-15
- 1.0.0 — 2018-01-15
- 0.0.1 — 2018-01-13

## README

# stimmy

[![Dependencies][prod-dependencies-badge]][prod-dependencies]
[![Dependencies][dev-dependencies-badge]][dev-dependencies]
[![Code Climate score][codeclimate-score-badge]][codeclimate-score]
[![Codecov][coverage-badge]][coverage]
[![Code Climate issue][codeclimate-issues-badge]][codeclimate-issues]
[![Node.js version][nodejs-badge]][nodejs]
[![NPM version][npm-badge]][npm]
[![Build Status][travis-badge]][travis-ci]
[![Security version][security-version-badge]][security-version]
[![MIT License][license-badge]][LICENSE]
[![PRs Welcome][prs-badge]][prs]


## 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](#fromArray)
* [From an object](#fromObject)


## Examples

**From import**
```javascript
import stimmy from 'stimmy';
```

**From require**
```javascript
const stimmy = require('stimmy');
```

<a name="fromArray"/>

### From an array

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

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

<a name="fromObject"/>

### From an object

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

```javascript
  const str = stimmy('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](https://github.com/rimiti/stimmy/blob/master/LICENSE)

[prod-dependencies-badge]: https://david-dm.org/rimiti/stimmy/status.svg
[prod-dependencies]: https://david-dm.org/rimiti/stimmy
[dev-dependencies-badge]: https://david-dm.org/rimiti/stimmy/dev-status.svg
[dev-dependencies]: https://david-dm.org/rimiti/stimmy?type=dev
[security-version-badge]: https://nodesecurity.io/orgs/dim-solution/projects/1432f793-3a27-4a25-9274-fe30a07104f7/badge
[security-version]: https://nodesecurity.io/orgs/dim-solution/projects/1432f793-3a27-4a25-9274-fe30a07104f7
[codeclimate-score-badge]: https://api.codeclimate.com/v1/badges/4d4c1ba660e878509721/maintainability
[codeclimate-score]: https://codeclimate.com/github/rimiti/stimmy/maintainability
[coverage-badge]: https://codecov.io/gh/rimiti/stimmy/branch/master/graph/badge.svg
[coverage]: https://codecov.io/gh/rimiti/stimmy
[codeclimate-issues-badge]: https://codeclimate.com/github/rimiti/stimmy/badges/issue_count.svg
[codeclimate-issues]: https://codeclimate.com/github/rimiti/stimmy
[nodejs-badge]: https://img.shields.io/badge/node->=%206.9.0-blue.svg?style=flat-square
[nodejs]: https://nodejs.org/dist/latest-v6.x/docs/api/
[npm-badge]: https://img.shields.io/badge/npm->=%203.10.8-blue.svg?style=flat-square
[npm]: https://docs.npmjs.com/
[travis-badge]: https://travis-ci.org/rimiti/stimmy.svg?branch=master
[travis-ci]: https://travis-ci.org/rimiti/stimmy
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license]: https://github.com/rimiti/stimmy/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com

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