Skip to main content

SlugStrategy

SlugStrategy​

@vendure/coreslug-strategy.ts
v3.5.0

Defines the strategy for generating slugs from input strings. Slugs are URL-friendly versions of text that are commonly used for entity identifiers in URLs.

Example

export class CustomSlugStrategy implements SlugStrategy {
  generate(ctx: RequestContext, params: SlugGenerateParams): string {
    return params.value
      .toLowerCase()
      .replace(/[^a-z0-9]+/g, '-')
      .replace(/^-+|-+$/g, '');
  }
}
Signature
interface SlugStrategy extends InjectableStrategy {
    generate(ctx: RequestContext, params: SlugGenerateParams): string | Promise<string>;
}

generate​

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

Generates a slug from the input string.