# bn-slug

> bangla slug generator

Latest version **1.0.1** (published 2024-01-27) · ISC license · 0 weekly downloads

## Install

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

## 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 | 1.0.1 |
| Published | 2024-01-27 |
| First published | 2023-06-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 67.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Niloy Mahmud Apu |
| Maintainers | niloymahmudapu |
| Keywords | slug, slug, generator, bangla, bengali, slug |

## Links

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

## 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.1 (latest) — 2024-01-27
- 1.0.0 — 2023-06-11

## README

## Bengali Slug Generator

**Step-1:** Install the package `npm i bn-slug`

**Step-2:** Import the generator `import bnSlug from "bn-slug"`

**Step-3:** Call the generator `bnSlug()`

That’s it.

### Here is an example:
```javascript
import bnSlug from "bn-slug";

console.log(bnSlug()); // output: হলুদ-ঘুমন্ত-বাঘ
console.log(bnSlug()); // output: লাল-সুন্দর-গোলাপ
```

Optionally you can pass a type parameter specifying which type of slug should be returned. 
There are three possible types: 
* `bn`: returns the slug in Bengali words. Example: `হলুদ-ঘুমন্ত-বাঘ`, `লাল-সুন্দর-গোলাপ`
* `en`: returns the slug in English words. Example: `yellow-sleeping-tiger`, `red-beautiful-rose`
* `pron`: returns the slug in Banglish words (Bengali words written in English letters). Example: `holud-ghumonto-bagh`, `lal-sundor-golap`

By default type `bn` is selected.

### Example
```javascript
import bnSlug from "bn-slug";

console.log(bnSlug("bn")); // হলুদ-ঘুমন্ত-বাঘ
console.log(bnSlug("bn")); // লাল-সুন্দর-গোলাপ

console.log(bnSlug("en")); // yellow-sleeping-tiger
console.log(bnSlug("en")); // red-beautiful-rose

console.log(bnSlug("pron")); // holud-ghumonto-bagh
console.log(bnSlug("pron")); // lal-sundor-golap
```

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