# parameterize

> This repository adds node.js and npm support for parameterize which is originally used in Ruby on Rails. It replaces special characters in a string so that it may be used as part of a 'pretty' URL.

Latest version **1.0.0** (published 2019-05-26) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-05-26 |
| First published | 2013-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/parameterize) |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Unpacked size | 11.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 36 |
| Author | Fırat Yalavuz |
| Maintainers | fyalavuz |

## Links

- npm: https://www.npmjs.com/package/parameterize
- Repository: https://github.com/fyalavuz/node-parameterize
- Homepage: https://github.com/fyalavuz/node-parameterize#readme
- Issues: https://github.com/fyalavuz/node-parameterize/issues
- npm.io page: https://npm.io/package/parameterize

## Recent versions

- 1.0.0 (latest) — 2019-05-26
- 0.1.0 — 2017-10-06
- 0.0.9 — 2017-10-06
- 0.0.7 — 2013-06-14
- 0.0.6 — 2013-06-14
- 0.0.5 — 2013-06-07
- 0.0.4 — 2013-06-07
- 0.0.3 — 2013-06-07
- 0.0.2 — 2013-06-07
- 0.0.1 — 2013-06-07

## README

node-parameterize
=================
This repository adds node.js and npm support for [parameterize](http://apidock.com/rails/String/parameterize) which is originally used in Ruby on Rails. It replaces special characters in a string so that it may be used as part of a 'pretty' URL.

parameterize.js is a port of django admin [urlify.js](https://github.com/django/django/blob/master/django/contrib/admin/static/admin/js/urlify.js)

Installing
--------------------------------
npm install parameterize

 
Supports
--------------------------------
Turkish
Azerbaijani
Serbian
Greek
Georgian
Russian
Ukranian
Czech
Polish
Romanian
Latvanian
Lithuanian 
Arabic
Latin special chars


Require
--------------------------------
```javascript
var parameterize = require('parameterize');
```


Using
--------------------------------
```javascript
parameterize('parameterized url with special characters, öçıŞÇ');
// outputs
// parameterized-url-with-special-characters-ocisc
```

```javascript
// using optional length limit
parameterize('this is a long text', 10);
// outputs
// this-is-a-l
```

```javascript
// you can change delimiter character
parameterize('this is a long text', 10, '_');
// outputs
// this_is_a_l
```

Using in express.js 3 view files as view helper
--------------------------------

You can implement it as in the example just below in your app.js file so that you can use it in all views. Note that it should be before the line 'app.use(app.router)'.

app.configure
--------------------------------

```javascript
  app.use(function(req, res, next) {
    res.locals.parameterize = parameterize
    next();
  });
  
  app.use(app.router);
```


using with jade template engine
----
index.jade

```html
#{parameterize('parameterized url with special characters, öçıŞÇ')}
// output:
// parameterized-url-with-special-characters-ocisc
```


using with ejs template engine
---
index.ejs

```ejs
<% parameterize('parameterized url with special characters, öçıŞÇ') %>
// parameterized-url-with-special-characters-ocisc
```

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