Installation

Install the Package

Install @nestbolt/sluggable using your preferred package manager:

npm install @nestbolt/sluggable

yarn add @nestbolt/sluggable

pnpm add @nestbolt/sluggable

Peer Dependencies

The following packages are required peer dependencies. In a typical NestJS project, most of these are already installed:

Install any missing peer dependencies:

npm install @nestjs/common @nestjs/core typeorm reflect-metadata

Optional Dependencies

Event Emitter (Slug Lifecycle Events)

Required if you want to listen to slug generation events such as sluggable.slug-generated and sluggable.slug-regenerated.

npm install @nestjs/event-emitter

Supported versions: ^2.0.0 || ^3.0.0

You also need to register the EventEmitterModule in your application:

import { EventEmitterModule } from "@nestjs/event-emitter";

@Module({
  imports: [
    EventEmitterModule.forRoot(),
    // ... other imports
  ],
})
export class AppModule {}

If @nestjs/event-emitter is not installed, the package works normally but no events are emitted. The event emitter is injected as an optional dependency.

Verifying the Installation

After installing, verify everything is wired correctly by importing the module in your root AppModule:

import { Module } from "@nestjs/common";
import { TypeOrmModule } from "@nestjs/typeorm";
import { SluggableModule } from "@nestbolt/sluggable";

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: "postgres",
      // ... your database config
      synchronize: true, // development only
    }),
    SluggableModule.forRoot(),
  ],
})
export class AppModule {}

If the application starts without errors and you see SluggableService initialized in the logs, the installation is complete. Continue to the Quick Start guide to create your first sluggable entity.