# trimmer

> Trim any characters from either side of a string.

Latest version **2.0.0** (published 2017-05-07) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2017-05-07 |
| First published | 2013-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Blake Embrey |
| Maintainers | blakeembrey |
| Keywords | trim, string, left, right, characters, function |

## Links

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

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2017-05-07
- 1.0.0 — 2014-08-18
- 0.0.3 — 2013-07-06

## README

# Trimmer

[![NPM version](https://img.shields.io/npm/v/trimmer.svg?style=flat)](https://npmjs.org/package/trimmer)
[![Build status](https://img.shields.io/travis/blakeembrey/node-trimmer.svg?style=flat)](https://travis-ci.org/blakeembrey/node-trimmer)
[![Test coverage](https://img.shields.io/coveralls/blakeembrey/node-trimmer.svg?style=flat)](https://coveralls.io/r/blakeembrey/node-trimmer?branch=master)
[![Greenkeeper badge](https://badges.greenkeeper.io/blakeembrey/node-trimmer.svg)](https://greenkeeper.io/)

Trim characters from either side of a string.

## Installation

```
npm install trimmer --save
```

## API

```js
var trim = require('trimmer')
```

* `trim(string [, characters])`
* `trim.left(string [, characters])`
* `trim.right(string [, characters])`

**P.S.**: `characters` can be one of either an string, array or function.

```js
trim('  test  ') //=> 'test'
trim.left('  test  ') //=> 'test  '
trim.right('  test  ') //=> '  test'

trim('test', 't') //=> 'es'
trim('testing', 'ing') //=> 'test'
trim.left('test', 't') //=> 'est'
trim.right('test', 't') //=> 'tes'
```

## License

MIT

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