# hyphenate

> A simple helper function that hyphenates phrases.

Latest version **0.2.5** (published 2020-07-05) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2020-07-05 |
| First published | 2015-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | vilicvane |
| Maintainers | vilic |

## Links

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

## Recent versions

- 0.2.5 (latest) — 2020-07-05
- 0.2.4 — 2018-08-31
- 0.2.3 — 2018-08-31
- 0.2.2 — 2018-08-31
- 0.2.1 — 2015-12-06
- 0.2.0 — 2015-12-06
- 0.1.1 — 2015-11-20
- 0.1.0 — 2015-11-20
- 0.0.1 — 2015-09-15
- 0.0.0 — 2015-09-15

## README

# Hyphenate [![Build Status](https://travis-ci.org/vilic/hyphenate.svg)](https://travis-ci.org/vilic/hyphenate)

A simple helper function that splits and then joins words back together.

## Install

```sh
yarn add hyphenate
```

## Usage

```ts
import hyphenate from 'hyphenate';

hyphenate('hello, world!'); // "hello-world"
hyphenate('JSONDataItems'); // "JSON-Data-Items"
hyphenate('JSONDataItems', {lowerCase: true}); // "json-data-items"
```

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