pubnub/lib/event-engine/presence/effects.js

Publish & Subscribe Real-time Messaging with PubNub

"use strict";
/**
 * Presence Event Engine effects module.
 *
 * @internal
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.wait = exports.emitStatus = exports.leave = exports.heartbeat = void 0;
const core_1 = require("../core");
/**
 * Presence heartbeat effect.
 *
 * Performs presence heartbeat REST API call.
 *
 * @internal
 */
exports.heartbeat = (0, core_1.createManagedEffect)('HEARTBEAT', (channels, groups) => ({
    channels,
    groups,
}));
/**
 * Presence leave effect.
 *
 * Performs presence leave REST API call.
 *
 * @internal
 */
exports.leave = (0, core_1.createEffect)('LEAVE', (channels, groups) => ({
    channels,
    groups,
}));
/**
 * Emit presence heartbeat REST API call result status effect.
 *
 * Notify status change event listeners.
 *
 * @internal
 */
/* eslint-disable  @typescript-eslint/no-explicit-any */
exports.emitStatus = (0, core_1.createEffect)('EMIT_STATUS', (status) => status);
/**
 * Heartbeat delay effect.
 *
 * Delay of configured length (heartbeat interval) before another heartbeat REST API call will be done.
 *
 * @internal
 */
exports.wait = (0, core_1.createManagedEffect)('WAIT', () => ({}));