@imqueue/pg-pubsub/src/PgChannelEmitter.d.ts

Reliable PostgreSQL LISTEN/NOTIFY with inter-process lock support

/*!
 * I'm Queue Software Project
 * Copyright (C) 2025  imqueue.com <support@imqueue.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * If you want to use this code in a closed source (commercial) project, you can
 * purchase a proprietary commercial license. Please contact us at
 * <support@imqueue.com> to get commercial licensing options.
 */
import { EventEmitter } from 'events';
import { channel } from './types';
export declare interface PgChannelEmitter {
    /**
     * Sets channel listener event handler
     *
     * @param {string} channelName - channel name to listen
     * @param {typeof channel} listener - channel event handler
     * @return {PgChannelEmitter}
     */
    on(channelName: string, listener: typeof channel): this;
    /**
     * Sets channel listener event handler which will be fired only one time
     *
     * @param {string} channelName - channel name to listen
     * @param {typeof channel} listener - channel event handler
     * @return {PgChannelEmitter}
     */
    once(channelName: string, listener: typeof channel): this;
}
/**
 * Implements event emitting/subscribing on PostgreSQL LISTEN/NOTIFY
 * named channels.
 */
export declare class PgChannelEmitter extends EventEmitter {
}