# format-unicorn

> Stack Exchange's string format function.

Latest version **1.1.1** (published 2017-08-04) · Fair license · 0 weekly downloads

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

## Install

```sh
npm install format-unicorn
pnpm add format-unicorn
yarn add format-unicorn
bun add format-unicorn
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2017-08-04 |
| First published | 2014-10-20 |
| Weekly downloads | 0 |
| License | Fair |
| TypeScript types | separate (@types/format-unicorn) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Talles L |
| Maintainers | talles |
| Keywords | string, format, formatunicorn, stackexchange |

## Links

- npm: https://www.npmjs.com/package/format-unicorn
- Repository: https://github.com/tallesl/node-format-unicorn
- Homepage: https://github.com/tallesl/node-format-unicorn#readme
- Issues: https://github.com/tallesl/node-format-unicorn/issues
- npm.io page: https://npm.io/package/format-unicorn

## 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.1.1 (latest) — 2017-08-04
- 1.1.0 — 2015-01-28
- 1.0.1 — 2014-11-09
- 1.0.0 — 2014-10-20

## README

# :rainbow: Format Unicorn

[![][build-img]][build]
[![][coverage-img]][coverage]
[![][dependencies-img]][dependencies]
[![][devdependencies-img]][devdependencies]
[![][version-img]][version]

A string format function made and used by Stack Exchange on their various websites. [*][meta] [*][so]

[build]:               https://travis-ci.org/tallesl/format-unicorn
[build-img]:           https://travis-ci.org/tallesl/format-unicorn.svg
[coverage]:            https://coveralls.io/r/tallesl/format-unicorn
[coverage-img]:        https://coveralls.io/repos/tallesl/format-unicorn/badge.svg
[dependencies]:        https://david-dm.org/tallesl/format-unicorn
[dependencies-img]:    https://david-dm.org/tallesl/format-unicorn.svg
[devdependencies]:     https://david-dm.org/tallesl/format-unicorn#info=devDependencies
[devdependencies-img]: https://david-dm.org/tallesl/format-unicorn/dev-status.svg
[version]:             http://badge.fury.io/js/format-unicorn
[version-img]:         https://badge.fury.io/js/format-unicorn.svg
[meta]:                http://meta.stackexchange.com/q/207128
[so]:                  http://stackoverflow.com/a/18234317/1316620

## Usage

```
$ npm install format-unicorn
(...)
$ node
> require('format-unicorn') // this adds formatUnicorn to String.prototype
{}
> 'We are not in {place} anymore.'.formatUnicorn({ place: 'Kansas' })
'We are not in Kansas anymore.'
> let formatUnicorn = require('format-unicorn/safe') // 'safer' version if you don't wanna mess with String's prototype
undefined
> formatUnicorn('We are not in {place} anymore.', { place: 'Kansas' })
'We are not in Kansas anymore.'
```

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