pubnub/src/entities/interfaces/entity-interface.ts

Publish & Subscribe Real-time Messaging with PubNub

import type { PubNubCore as PubNub } from '../../core/pubnub-common';
import { SubscriptionCapable } from './subscription-capable';

/**
 * Common entity interface.
 */
export interface EntityInterface extends SubscriptionCapable {
  /**
   * Creates and returns an instance of the PubNub client.
   *
   * @return {PubNub<unknown, unknown>} An instance of the PubNub client configured with specified parameters.
   *
   * @internal
   */
  client: PubNub<unknown, unknown>;

  /**
   * Retrieve entity type.
   *
   * There is four types:
   * - Channel
   * - ChannelGroups
   * - ChannelMetadata
   * - UserMetadata
   *
   * @return One of known entity types.
   *
   * @internal
   */
  entityType: 'Channel' | 'ChannelGroups' | 'ChannelMetadata' | 'UserMetadata';
}