Skip to main content

DefaultSlugStrategy

DefaultSlugStrategy​

@vendure/coredefault-slug-strategy.ts
v3.5.0

The default strategy for generating slugs. This strategy:

  • Converts to lowercase
  • Replaces spaces and special characters with hyphens
  • Removes non-alphanumeric characters (except hyphens)
  • Removes leading and trailing hyphens
  • Collapses multiple hyphens into one

Example

const strategy = new DefaultSlugStrategy();
strategy.generate(ctx, { value: "Hello World!" }); // "hello-world"
strategy.generate(ctx, { value: "Café Français" }); // "cafe-francais"
strategy.generate(ctx, { value: "100% Natural" }); // "100-natural"
Signature
class DefaultSlugStrategy implements SlugStrategy {
    generate(ctx: RequestContext, params: SlugGenerateParams) => string;
}

generate​

method
(ctx: RequestContext, params: SlugGenerateParams) => string