Skip to main content

SlugOptions

Stentor API Reference

Stentor API Reference / stentor-utils/src / SlugOptions

Interface: SlugOptions

Defined in: packages/stentor-utils/src/string/slug.ts:7

Options for slug.

Properties​

replacement?​

optional replacement?: string

Defined in: packages/stentor-utils/src/string/slug.ts:11

Character that spaces are replaced with. Defaults to -.

remove?​

optional remove?: RegExp

Defined in: packages/stentor-utils/src/string/slug.ts:15

Characters matched by this are removed from the slug.

lower?​

optional lower?: boolean

Defined in: packages/stentor-utils/src/string/slug.ts:19

Lowercase the slug.

strict?​

optional strict?: boolean

Defined in: packages/stentor-utils/src/string/slug.ts:23

Strip everything that is not alphanumeric or the replacement.

locale?​

optional locale?: string

Defined in: packages/stentor-utils/src/string/slug.ts:27

Locale used when transliterating.

trim?​

optional trim?: boolean

Defined in: packages/stentor-utils/src/string/slug.ts:31

Trim leading and trailing replacement characters. Defaults to true.