Class SlugifyConfig

Configuration class for the slugify functionality. Provides comprehensive customization options for URL slug generation.

Accessors

customReplacements

get customReplacements(): Record<string, string>
Returns Record<string, string>
- Defined in src/utils/slugify.config.ts:38

separator

get separator(): string
Returns string
- Defined in src/utils/slugify.config.ts:42

case

get case(): "upper" | "lower" | "default"
Returns "upper" | "lower" | "default"
- Defined in src/utils/slugify.config.ts:46

removeAccents

get removeAccents(): boolean
Returns boolean
- Defined in src/utils/slugify.config.ts:50

allowedChars

get allowedChars(): undefined | RegExp
Returns undefined | RegExp
- Defined in src/utils/slugify.config.ts:54

maxLength

get maxLength(): undefined | number
Returns undefined | number
- Defined in src/utils/slugify.config.ts:58

transformers

get transformers(): ((str: string) => string)[]
Returns ((str: string) => string)[]
- Defined in src/utils/slugify.config.ts:62

Methods

`Static`builder

builder(): SlugifyConfigBuilder
Returns SlugifyConfigBuilder
- Defined in src/utils/slugify.config.ts:24

`Static`default

default(): SlugifyConfig
Returns SlugifyConfig
- Defined in src/utils/slugify.config.ts:28

`Static`create

create(builder: SlugifyConfigBuilder): SlugifyConfig
Parameters
- builder: SlugifyConfigBuilder
Returns SlugifyConfig
- Defined in src/utils/slugify.config.ts:32

merge

merge(other: SlugifyConfig): SlugifyConfig
Parameters
- other: SlugifyConfig
Returns SlugifyConfig
- Defined in src/utils/slugify.config.ts:66

getCharClass

getCharClass(): RegExp
Returns RegExp
- Defined in src/utils/slugify.config.ts:82

applyCustomReplacements

applyCustomReplacements(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:86

applyTransformers

applyTransformers(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:95

applyRemoveAccents

applyRemoveAccents(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:99

replaceNonAllowedChars

replaceNonAllowedChars(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:104

trimSeparators

trimSeparators(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:110

applyCase

applyCase(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:115

applyMaxLength

applyMaxLength(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:121

collapseSeparators

collapseSeparators(str: string): string
Parameters
- str: string
Returns string
- Defined in src/utils/slugify.config.ts:128

slugify

slugify(str: string): string
Applies the slugify transformations to the given string using this configuration.
Parameters
- str: string
  The input string to slugify
Returns string
The slugified string
- Defined in src/utils/slugify.config.ts:138

`Static`slugifyWith

slugifyWith(
str: string,
builderFn: (builder: SlugifyConfigBuilder) => SlugifyConfigBuilder,
): string
Static method to slugify a string with a temporary configuration built from the builder.
Parameters
- str: string
  The input string to slugify
- builderFn: (builder: SlugifyConfigBuilder) => SlugifyConfigBuilder
  A function that configures the builder
Returns string
The slugified string
- Defined in src/utils/slugify.config.ts:157