@justinjoram/request-interceptor

A customizable request interceptor for NestJS applications that provides request logging and timing functionality.

Features

• Request logging (method, URL, and body)
• Response logging
• Request timing measurements
• Error logging
• Configurable options

Installation

npm install @justinjoram/request-interceptor

Requirements

• NestJS ^10.0.0
• RxJS ^7.8.1

Usage

Basic Usage

import { RequestInterceptor } from '@justinjoram/request-interceptor';
import { Controller, UseInterceptors } from '@nestjs/common';

@UseInterceptors(new RequestInterceptor())
@Controller('example')
export class ExampleController {
  // Your controller methods
}

With Custom Options

import { RequestInterceptor } from '@justinjoram/request-interceptor';
import { Controller, UseInterceptors } from '@nestjs/common';

@UseInterceptors(new RequestInterceptor({
  logging: true,  // Enable/disable request and response logging
  timing: true    // Enable/disable request timing measurements
}))
@Controller('example')
export class ExampleController {
  // Your controller methods
}

Global Registration

import { RequestInterceptor } from '@justinjoram/request-interceptor';

// In your main.ts
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalInterceptors(new RequestInterceptor());
  await app.listen(3000);
}

Configuration Options

| Option | Type | Default | Description | |----------|---------|---------|------------------------------------------------| | logging | boolean | true | Enables logging of requests and responses | | timing | boolean | true | Enables logging of request execution time |

Logging Output

The interceptor provides the following log information:

• Incoming request details (method, URL, body)
• Response data
• Request execution time (when timing is enabled)
• Error details (if request fails)

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.