@nestjsvn/swagger-sse/dist/decorators/api-sse.decorator.d.ts

OpenAPI documentation and interactive Swagger UI for NestJS Server-Sent Events endpoints

import 'reflect-metadata';
import { ApiSseOptions } from './api-sse.options';
/**
 * Decorator for documenting Server-Sent Events endpoints in OpenAPI
 *
 * @param options Configuration options for the SSE endpoint
 * @returns Method decorator that applies OpenAPI documentation
 *
 * @example
 * ```typescript
 * @ApiSse({
 *   events: {
 *     'user-created': UserCreatedDto,
 *     'user-updated': UserUpdatedDto
 *   },
 *   summary: 'User events stream'
 * })
 * @Sse('users')
 * streamUserEvents(): Observable<MessageEvent> {
 *   // Implementation
 * }
 * ```
 */
export declare function ApiSse(options: ApiSseOptions): MethodDecorator;