# trim-buffer

> Removes whitespace and line-terminator characters from buffer edges

Latest version **5.0.0** (published 2021-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install trim-buffer
pnpm add trim-buffer
yarn add trim-buffer
bun add trim-buffer
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2021-11-07 |
| First published | 2021-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 302 |
| Author | Ran Cohen |
| Maintainers | rannn505 |

## Links

- npm: https://www.npmjs.com/package/trim-buffer
- Repository: https://github.com/rannn505/child-shell
- Homepage: https://github.com/rannn505/child-shell/tree/master/packages/trim-buffer#readme
- Issues: https://github.com/rannn505/child-shell/issues
- npm.io page: https://npm.io/package/trim-buffer

## Recent versions

- 5.0.0 (latest) — 2021-11-07
- 5.0.0-next.3 (next) — 2021-01-27

## README

# `trim-buffer`

> Removes whitespace and line-terminator characters from buffer edges

## Installation

```bash
$ npm i -S trim-buffer
$ yarn add trim-buffer
```

## Usage

```js
import { EOL } from 'os';
import { trimBufferStart, trimBufferEnd, trimBuffer } from 'trim-buffer';

const trimmable = Buffer.from(` trimme${EOL}`); // Buffer(8) [32, 116, 114, 105, 109, 109, 101, 10]
trimBufferStart(trimmable); // Buffer(7) [116, 114, 105, 109, 109, 101, 10]
trimBufferEnd(trimmable); // Buffer(7) [32, 116, 114, 105, 109, 109, 101]
trimBuffer(trimmable); // Buffer(6) [116, 114, 105, 109, 109, 101]
```

## API

> Whitespace in this context is all the whitespace characters (space, tab, no-break space, etc.) and all the line terminator characters (LF, CR, etc.).

### `trimBufferStart(buffer: Buffer): Buffer`

The `trimBufferStart()` method return the buffer stripped of whitespace from its left end. `trimBufferStart()` do not affect the value of the buffer itself.
Exactly what [String.prototype.trimStart()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimStart) does, just for buffers.

### `trimBufferEnd(buffer: Buffer): Buffer`

The `trimBufferEnd()` method return the buffer stripped of whitespace from its right end. `trimBufferEnd()` do not affect the value of the buffer itself.
Exactly what [String.prototype.trimEnd()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimEnd) does, just for buffers.

### `trimBuffer(buffer: Buffer): Buffer`

The `trimBuffer()` method return the buffer stripped of whitespace both ends. `trimBuffer()` do not affect the value of the buffer itself.
Exactly what [String.prototype.trim()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trim) does, just for buffers.

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