Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sindresorhus/pad-stream

Pad each line in a stream
https://github.com/sindresorhus/pad-stream

Last synced: 4 months ago
JSON representation

Pad each line in a stream

Awesome Lists containing this project

README

        

# pad-stream

> Pad each line in a stream

## Install

```sh
npm install pad-stream
```

## Usage

```js
// pad.js
import padStream from 'pad-stream';

process.stdin.pipe(padStream(2, '>')).pipe(process.stdout);
```

```
$ echo 'foo\nbar' | node pad.js
>>foo
>>bar
```

## API

### padStream(count, indent?)

Returns a [transform stream](https://nodejs.org/api/stream.html#stream_duplex_and_transform_streams).

#### count

Type: `number` *(integer)*

The number of times to repeat `indent`.

#### indent

Type: `string`\
Default: `' '`

The string to use as indent.

## Related

- [indent-string](https://github.com/sindresorhus/indent-string) - Indent each line in a string
- [indent-string-cli](https://github.com/sindresorhus/indent-string-cli) - Indent each line in some text or stdin