# slug-off

> Turn strings into slugs, eh?

Latest version **0.0.2** (published 2018-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install slug-off
pnpm add slug-off
yarn add slug-off
bun add slug-off
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-04-28 |
| First published | 2018-04-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 2.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Jamie Halvorson |
| Maintainers | jamiehalvorson |

## Links

- npm: https://www.npmjs.com/package/slug-off
- Repository: https://github.com/jhalvorson/slug-off
- Homepage: https://github.com/jhalvorson/slug-off#readme
- Issues: https://github.com/jhalvorson/slug-off/issues
- npm.io page: https://npm.io/package/slug-off

## Dependencies (1)

- [babel-preset-env](https://npm.io/package/babel-preset-env.md) ^1.6.1

## Recent versions

- 0.0.2 (latest) — 2018-04-28
- 0.0.1 — 2018-04-28

## README

![Slug off](https://file-enkhgwwuwf.now.sh/)

A tiny and probably useless set of helper functions to turn your strings into slugs, because, laziness.

Uses Rollup and Babel to transpile JS. *It even has Babel?!* Yes, I know. See the first line for the reason.

## Usage

So, for some reason you want to use this module?

First in your terminal, `cd` into your project and run:

`npm install slug-off`

Now import it into your file:

`import slugOff from 'slug-off';`

You can now run `slugOff('my Awesome line oF t3xt Bruh')`. The `slugOff` function takes two parameters: string, separator. If you're a monster and want to use underscores for your slugs you can run `slugOff('why would I do this?', '_');`,

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