# string-template

> A simple string template function based on named or indexed arguments

Latest version **1.0.0** (published 2016-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install string-template
pnpm add string-template
yarn add string-template
bun add string-template
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-01-07 |
| First published | 2013-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/string-template) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 279 |
| Author | Matt-Esch |
| Maintainers | mattesch |
| Keywords | template, string, format, replace, arguments |

## Links

- npm: https://www.npmjs.com/package/string-template
- Repository: https://github.com/Matt-Esch/string-template
- Issues: https://github.com/Matt-Esch/string-template/issues
- npm.io page: https://npm.io/package/string-template

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2016-01-07
- 0.2.1 — 2015-05-06
- 0.2.0 — 2014-05-12
- 0.1.3 — 2013-11-18
- 0.1.2 — 2013-11-18
- 0.1.1 — 2013-09-30
- 0.1.0 — 2013-09-30

## README

# string-template

[![build status][1]][2] [![dependency status][3]][4] [![coverage report][9]][10] [![stability index][15]][16]

[![npm stats][13]][14]

[![browser support][5]][6]

  A simple string template function based on named or indexed arguments

## Example

```js
var format = require("string-template")
var greeting

// Format using an object hash with keys matching [0-9a-zA-Z]+

greeting = format("Hello {name}, you have {count} unread messages", {
    name: "Robert",
    count: 12
})
// greeting -> "Hello Robert, you have 12 unread messages"


// Format using a number indexed array

greeting = format("Hello {0}, you have {1} unread messages", ["Robert", 12])
// greeting -> "Hello Robert, you have 12 unread messages"


// Format using optional arguments

greeting = format("Hello {0}, you have {1} unread messages",
     "Robert",
     12)
// greeting -> "Hello Robert, you have 12 unread messages"


// Escape {} pairs by using double {{}}

var text = format("{{0}}")
// text -> "{0}"

```

## Compiling templates

`string-template` exposes two template compiling options for when you need the
additional performance. Arguments passed to the compiled template are of the
same structure as the main `string-template` function, so either a single
object/array or a list of arguments.

```js
var compile = require("string-template/compile")

var greetingTemplate = compile("Hello {0}, you have {1} unread messages")

var greeting = greetingTemplate("Robert", 12)
// -> "Hello Robert, you have 12 unread messages"
```

Passing a truthy second argument to `compile` will opt into using `new Function`
to generate a function. The function returned contains a literal string
concatenation statement, interleaving the correct arguments you have passed in.

```js
var compile = require("string-template/compile")

var greetingTemplate = compile("Hello {0}, you have {1} unread messages", true)
// -> greetingTemplate generated using new Function

var greeting = greetingTemplate(["Robert", 12])
// -> "Hello Robert, you have 12 unread messages"
```

## Installation

`npm install string-template`

## Contributors

 - Matt-Esch

## MIT Licenced

  [1]: https://secure.travis-ci.org/Matt-Esch/string-template.svg
  [2]: https://travis-ci.org/Matt-Esch/string-template
  [3]: https://david-dm.org/Matt-Esch/string-template.svg
  [4]: https://david-dm.org/Matt-Esch/string-template
  [5]: https://ci.testling.com/Matt-Esch/string-template.svg
  [6]: https://ci.testling.com/Matt-Esch/string-template
  [9]: https://coveralls.io/repos/Matt-Esch/string-template/badge.svg
  [10]: https://coveralls.io/r/Matt-Esch/string-template
  [13]: https://nodei.co/npm/string-template.png?downloads=true&stars=true
  [14]: https://nodei.co/npm/string-template
  [15]: http://hughsk.github.io/stability-badges/dist/unstable.svg
  [16]: http://github.com/hughsk/stability-badges

  [7]: https://badge.fury.io/js/string-template.svg
  [8]: https://badge.fury.io/js/string-template
  [11]: https://gemnasium.com/Matt-Esch/string-template.svg
  [12]: https://gemnasium.com/Matt-Esch/string-template

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