# slugifi

> Slugify a string!

Latest version **1.0.7** (published 2021-04-01) · MIT license · 0 weekly downloads

## Install

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

Provides the command `slugifi`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2021-04-01 |
| First published | 2021-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Suzan-Dev |
| Maintainers | suzan-dev |
| Keywords | slug |

## Links

- npm: https://www.npmjs.com/package/slugifi
- Repository: https://github.com/Suzan-Dev/slugifi
- Issues: https://github.com/Suzan-Dev/slugifi/issues
- npm.io page: https://npm.io/package/slugifi

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.0.7 (latest) — 2021-04-01
- 1.0.6 — 2021-01-24
- 1.0.5 — 2021-01-23
- 1.0.4 — 2021-01-23
- 1.0.3 — 2021-01-21
- 1.0.2 — 2021-01-20
- 1.0.1 — 2021-01-20
- 1.0.0 — 2021-01-20

## README

## Slugifi

[![version](https://img.shields.io/npm/v/slugifi?style=flat-square)](https://www.npmjs.com/package/slugifi)
[![downloads](https://img.shields.io/npm/dm/slugifi?style=flat-square)]()
[![license](https://img.shields.io/npm/l/slugifi?style=flat-square)](http://opensource.org/licenses/MIT)

`Slugifi` is small package for creating a slug from a string.

 

## Release Notes (v1.0.7)

> You can now remove special characters from string by enabling specialChars property from the options.

 

## Installation

Npm :

```
$ npm install slugifi
```

Yarn :

```
$ yarn add slugifi
```

Pnpm :

```
$ pnpm add slugifi
```

 

## Usage

ES6 :

```js
import slugifi from 'slugifi';

slugifi('Random text'); // Outputs: random-text
```

CommonJS :

```js
const slugifi = require('slugifi');

slugifi('Random text'); // Outputs: random-text
```

 

## Options

```js
slugifi('some text', {
  separator: '_', // defaults to '-'
  capitalize: true, // defaults to false
  specialChars: false, // defaults to true
});
```

 

## License

[MIT](http://opensource.org/licenses/MIT)

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