# bzz

> Template strings formatter for avoiding indentation side effect

Latest version **0.2.4** (published 2016-12-26) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2016-12-26 |
| First published | 2016-12-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dima Paloskin |
| Maintainers | paloskin |

## Links

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

## Dependencies (1)

- [detect-node](https://npm.io/package/detect-node.md) ^2.0.3

## Recent versions

- 0.2.4 (latest) — 2016-12-26
- 0.2.3 — 2016-12-26
- 0.2.2 — 2016-12-26
- 0.2.1 — 2016-12-26
- 0.2.0 — 2016-12-26
- 0.1.0 — 2016-12-26
- 0.0.0 — 2016-12-26

## README

# bzz
> Template strings formatter for avoiding indentation side effect. Format string according minimum found identation and passed gitter. 

[![npm version](https://badge.fury.io/js/bzz.svg)](https://www.npmjs.com/package/bzz)
[![Build Status](https://travis-ci.org/dimapaloskin/bzz.svg?branch=master)](https://travis-ci.org/dimapaloskin/bzz)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

![bzz output](https://raw.githubusercontent.com/dimapaloskin/bzz/master/media/bzz.png)

## Installation

```
npm install --save bzz
```

## API

### bzz(templateString, [defaultGitter]);

**defaultGitter** set a minimum identation for passed string. **Default:** 0

## Usage examples

```js

const bzz = require('bzz');

// the fist string's line will be removed
const str = bzz(`
    Hello
      world
`);  // <-- the last line will be removed too

console.log(str);

```
Output:
```
Hello
  world
```

---

```js

const bzz = require('bzz');

const str = bzz(` this line will be removed so not affect anything
      Meow
        Moo
      Arf-arf
`, 2);

console.log(str);

```
Output:
```
  Meow
    Moo
  Arf-arf
```

#### Author
[Dmitry Pavlovsky](http://palosk.in)

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