Skip to content

Commit

Permalink
Update preserveTrailingDash docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vhpoet committed May 13, 2021
1 parent c0b0ef7 commit 2142006
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion index.d.ts
Expand Up @@ -116,7 +116,7 @@ export interface Options {
/**
If your string ends with a dash, it will be preserved in the slugified string.
Sometimes trailing dashes are intentional, for example, when using slugify on an input field used for setting a slug.
For example, using slugify on an input field would allow for validation while not preventing the user from writing a slug.
@default false
Expand Down
2 changes: 1 addition & 1 deletion readme.md
Expand Up @@ -174,7 +174,7 @@ Default: `false`

If your string ends with a dash, it will be preserved in the slugified string.

Sometimes trailing dashes are intentional, for example, when using slugify on an input field used for setting a slug.
For example, using slugify on an input field would allow for validation while not preventing the user from writing a slug.

```js
import slugify from '@sindresorhus/slugify';
Expand Down

0 comments on commit 2142006

Please sign in to comment.