sqs-consumer/dist/esm/emitter.js

Build SQS-based Node applications without the boilerplate

import { EventEmitter } from "node:events";
import { logger } from "./logger.js";
export class TypedEventEmitter extends EventEmitter {
    /**
     * @param queueUrl - The URL of the SQS queue this emitter is associated with
     */
    constructor(queueUrl) {
        super();
        this.queueUrl = queueUrl;
    }
    /**
     * Trigger a listener on all emitted events
     * @param event The name of the event to listen to
     * @param listener A function to trigger when the event is emitted
     */
    on(event, listener) {
        return super.on(event, listener);
    }
    /**
     * Trigger a listener only once for an emitted event
     * @param event The name of the event to listen to
     * @param listener A function to trigger when the event is emitted
     */
    once(event, listener) {
        return super.once(event, listener);
    }
    /**
     * Emits an event with the provided arguments and adds queue metadata
     * @param event The name of the event to emit
     * @param args The arguments to pass to the event listeners
     * @returns {boolean} Returns true if the event had listeners, false otherwise
     * @example
     * // Inside a method:
     * this.emit('message_received', message);
     */
    emit(event, ...args) {
        const metadata = { queueUrl: this.queueUrl };
        logger.debug(event, ...args, metadata);
        return super.emit(event, ...args, metadata);
    }
}