# url-record

> a simple, fast and lightweight slug generator

Latest version **1.0.3** (published 2021-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install url-record
pnpm add url-record
yarn add url-record
bun add url-record
```

## 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.3 |
| Published | 2021-05-16 |
| First published | 2020-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 90.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Huseyin ELMAS |
| Maintainers | hsynlms |
| Keywords | url, slug, record |

## Links

- npm: https://www.npmjs.com/package/url-record
- Repository: https://github.com/hsynlms/url-record
- Homepage: https://github.com/hsynlms/url-record#readme
- Issues: https://github.com/hsynlms/url-record/issues
- npm.io page: https://npm.io/package/url-record

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-05-16
- 1.0.2 — 2021-05-01
- 1.0.1 — 2020-11-07
- 1.0.0 — 2020-07-07

## README

## url-record
> A simple, fast and lightweight slug generator. It's a JavaScript port from [nopCommerce](https://github.com/nopSolutions/nopCommerce) UrlRecord service.

[![NPM](https://nodei.co/npm/url-record.png)](https://nodei.co/npm/url-record/)

## Why url-record?
The reason behind this repository is nopCommerce, is an open source ASP.NET Core based ecommerce solution. I just wanted to create a port of the nopCommerce SEO friendly slug generation service which is in production for years and trusted by tens of thousands of stores.

## Installation
`npm install url-record --save`

## Usage

```js
// get required modules
const getSeoFriendlyName = require('url-record')

getSeoFriendlyName('nobodY d0es_it better')
// will return -> nobody-d0es_it-better
```

## Options

| Name              | Type               | Default                             | Description                                                                                                          |
| ---               | ---                | ---                                 | ---                                                                                                                  |
| name         | string | -                                | The string that will be slugified  |
| convertNonWesternChars         | boolean            | true                                | A value indicating whether non western chars should be converted  |
| allowUnicodeCharsInUrls  | boolean            | false                               | A value indicating whether Unicode chars are allowed  |

## Contribution
Contributions and pull requests are kindly welcomed!

## License
This project is licensed under the terms of the [MIT license](https://github.com/hsynlms/url-record/blob/master/LICENSE).

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