@imqueue/pg-pubsub/src/helpers.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 { AnyJson, AnyLogger } from './types';
/**
 * Serializes given input object to JSON string. On error will return
 * serialized null value
 *
 * @param {AnyJson} input - serializable value
 * @param {AnyLogger} [logger] - logger to handle errors logging with
 * @param {boolean} [pretty] - serialized format output prettify flag
 * @return {string}
 */
export declare function pack(input: AnyJson, logger?: AnyLogger, pretty?: boolean): string;
/**
 * Deserializes given input JSON string to corresponding JSON value object.
 * On error will return empty object
 *
 * @param {string} input - string to deserialize
 * @param {AnyLogger} [logger] - logger to handle errors logging with
 * @return {AnyJson}
 */
export declare function unpack(input?: string, logger?: AnyLogger): AnyJson;
/**
 * Constructs and returns hash string for a given set of processId, channel
 * and payload.
 *
 * @param {string} processId
 * @param {string} channel
 * @param {any} payload
 * @returns {string}
 */
export declare function signature(processId: number, channel: string, payload: any): string;