Mapa de uso
Qué peso tiene este paquete dentro del runtime
Flujo del paquete
Cómo atraviesa este paquete las fases del runtime de xtaskjs
Antes del arranque
Configura valores por defecto de colas, registra transports y decora consumidores mientras cargan los módulos para que el runtime de colas sepa qué productores y handlers conectar.
Durante CreateApplication()
El ciclo de vida de queues publica QueueService y tokens de transport con nombre en el contenedor, descubre consumidores decorados y los prepara para arrancar en la fase ready del ciclo de vida.
Durante app.close()
Los consumidores activos se detienen y los transports conectados se desconectan automáticamente para que los recursos del broker se apaguen junto con la aplicación.
Superficie API
Exports representativos del paquete original
Configuración y transports
- configureQueues
- registerQueueTransport
- registerInMemoryQueueTransport
- createRabbitMqTransport
- createMqttTransport
Decoradores e inyectores
- QueueHandler
- QueueSubscribe
- QueuePattern
- PublishToQueue
- InjectQueueService
- InjectQueueLifecycleManager
- InjectQueueTransport
Servicio de runtime y ciclo de vida
- QueueService
- initializeQueueIntegration
- shutdownQueueIntegration
- getQueueServiceToken
- getQueueTransportToken
Uso
Flujo típico de adopción
1. Configura transports y valores por defecto
Empieza con el transporte integrado en memoria para flujos locales, o registra las utilidades de RabbitMQ o MQTT cuando los mensajes deban cruzar límites de proceso.
2. Decora consumidores y publicadores
Usa QueueHandler y QueuePattern para consumidores, PublishToQueue para eventos basados en el resultado del método e InjectQueueService cuando los servicios necesiten APIs directas de publicación o productores.
3. Inspecciona y controla el runtime de colas
Usa QueueService para listar grupos y consumidores, crear productores con valores por defecto e iniciar o detener el procesamiento de colas para endpoints de diagnóstico u operaciones.
Ejemplo
Fragmento de referencia
import { Service } from "@xtaskjs/core";
import {
InjectQueueService,
PublishToQueue,
QueueHandler,
QueueService,
configureQueues,
registerInMemoryQueueTransport,
} from "@xtaskjs/queues";
configureQueues({
defaultTransportName: "memory",
autoCreateDefaultInMemoryTransport: false,
});
registerInMemoryQueueTransport({
name: "memory",
kind: "in-memory",
});
@Service()
export class OrdersQueueService {
constructor(
@InjectQueueService()
private readonly queues: QueueService
) {}
async publishOrder(orderId: string) {
await this.queues.publish("orders.created", { orderId });
}
@PublishToQueue("orders.completed", { transportName: "memory" })
completeOrder(orderId: string) {
return { orderId, completedAt: new Date().toISOString() };
}
@QueueHandler("orders.created", { name: "orders.created", transportName: "memory" })
onOrderCreated(payload: { orderId: string }) {
console.log("received", payload.orderId);
}
}
Ejemplos
Ejemplos oficiales para revisar después
Ejemplos de referencia: 16-queues_memory_app and 17-queues_rabbitmq_app
Relacionados
Paquetes que suelen usarse junto a este
