Installation

Install the Package

Install @nestbolt/disposable-email using your preferred package manager:

npm install @nestbolt/disposable-email

Or with yarn:

yarn add @nestbolt/disposable-email

Or with pnpm:

pnpm add @nestbolt/disposable-email

Peer Dependencies

This package requires the following peer dependencies. In a typical NestJS project, most of these are already installed:

If any of these are missing from your project, install them:

npm install @nestjs/common @nestjs/core class-validator class-transformer reflect-metadata

Compatibility

NestJS Versions

The package supports both NestJS 10 and NestJS 11. The module uses standard NestJS dynamic module patterns (forRoot / forRootAsync) and does not depend on any version-specific internals, so it works seamlessly with either major version.

Node.js

The package requires Node.js 18 or later. This is because the DefaultFetcher uses the native fetch() API (available globally since Node.js 18) for retrieving remote domain lists. If you are running an older Node.js version, you can provide a custom fetcher that uses a different HTTP client such as axios or node-fetch.

TypeScript

The package is written in TypeScript and ships with full type declarations. No additional @types/* packages are needed.

Verifying the Installation

After installing, you can verify that everything is in place by importing the module in your AppModule:

import { Module } from "@nestjs/common";
import { DisposableEmailModule } from "@nestbolt/disposable-email";

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

If the application starts without errors, the package is correctly installed. The module logs a message at startup indicating how many disposable domains were loaded:

[DisposableEmailService] Loaded 37123 disposable domains

Next Steps

Once installed, proceed to the Quick Start guide to set up the module, configure validation, and start blocking disposable emails.