Skip to content

Add example for strict mode #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thompsonsj wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add example for strict mode #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,27 @@ slugify('some string', {
})
```

For example, to remove `*+~.()'"!:@` from the result slug, you can use `slugify('..', {remove: /[*+~.()'"!:@]/g})`.
### Examples

#### Remove special characters

Remove `$*_+~.()'"!\-:@`.

```js
let slug = 'foo *+~.() bar \'"!:@ baz'
slugify(slug, {remove: /[$*_+~.()'"!\-:@]/g})
// foo-bar-baz
```

#### Strict mode

Remove any character that doesn't match `[a-zA-Z0-9-]`, except the replacement.

```js
let slug = 'foo_bar. -baz!'
slugify(slug, {strict: true})
// foobar-baz
```

## Extend

Expand Down