@dismissible/nestjs-request
v3.1.1
Published
Request context decorator for Dismissible applications
Downloads
304
Maintainers
Readme
Dismissible manages the state of your UI elements across sessions, so your users see what matters, once! No more onboarding messages reappearing on every tab, no more notifications haunting users across devices. Dismissible syncs dismissal state everywhere, so every message is intentional, never repetitive.
@dismissible/nestjs-request
Request context decorator for Dismissible applications.
Part of the Dismissible API - This library is part of the Dismissible API ecosystem. Visit dismissible.io for more information and documentation.
Overview
This library provides a NestJS parameter decorator for extracting request context from HTTP requests:
RequestContext- Parameter decorator that extracts request context from the current HTTP request
Installation
npm install @dismissible/nestjs-requestGetting Started
Basic Usage
Use the RequestContext decorator in your controllers to extract request context:
import { Controller, Get } from '@nestjs/common';
import { RequestContext, IRequestContext } from '@dismissible/nestjs-request';
@Controller('items')
export class ItemsController {
@Get()
async getItems(@RequestContext() context: IRequestContext) {
// Use context.requestId, context.headers, etc.
return { requestId: context.requestId };
}
}API Reference
RequestContext
A NestJS parameter decorator that extracts request context from the current HTTP request.
The decorator returns an IRequestContext object containing:
requestId- Unique request identifier (fromx-request-idheader or generated UUID)headers- Request headersquery- Query parametersparams- Route parametersbody- Request bodyuser- Authenticated user (if available)ip- Client IP addressmethod- HTTP methodurl- Request URLprotocol- Request protocolsecure- Whether the request is secure (HTTPS)hostname- Request hostnameport- Request portpath- Request pathsearch- Query stringsearchParams- Parsed search parametersorigin- Request originreferer- Referer headeruserAgent- User agent header
Related Packages
This library is typically used alongside other Dismissible packages:
@dismissible/nestjs-hooks- Provides theIRequestContextinterface@dismissible/nestjs-core- Main dismissible service and module
License
MIT
