@donation-alerts/api/cjs/api/centrifugo/donation-alerts-centrifugo-channel.d.ts

Interact with Donation Alerts API.

import { DataObject } from '@donation-alerts/common';
/** @internal */
export interface DonationAlertsCentrifugoChannelsResponseData {
    channels: DonationAlertsCentrifugoChannel[];
}
/** @internal */
export interface DonationAlertsCentrifugoChannelData {
    channel: string;
    token: string;
}
/**
 * Represents a Donation Alerts Centrifugo private channel as a plain JavaScript object.
 */
export interface DonationAlertsCentrifugoChannelJson {
    channel: string;
    token: string;
}
/**
 * Represents a Donation Alerts Centrifugo private channel.
 *
 * @remarks
 * This class provides access to a private channel's data, including its name (`channel`)
 * and the token required to connect to this channel (`token`).
 */
export declare class DonationAlertsCentrifugoChannel extends DataObject<DonationAlertsCentrifugoChannelData, DonationAlertsCentrifugoChannelJson> {
    /**
     * The private channel name.
     *
     * @example
     * `$alerts:donation_12345`.
     */
    get channel(): string;
    /**
     * The Centrifugo connection token.
     *
     * @remarks
     * This token is required to establish a connection to the respective private channel.
     */
    get token(): string;
    toJSON(): DonationAlertsCentrifugoChannelJson;
}
//# sourceMappingURL=donation-alerts-centrifugo-channel.d.ts.map