pubnub/src/entities/channel.ts

Publish & Subscribe Real-time Messaging with PubNub

import { Entity } from './entity';

/**
 * First-class objects which provides access to the channel-specific APIs.
 */
export class Channel extends Entity {
  /**
   * Retrieve entity type.
   *
   * There is four types:
   * - Channel
   * - ChannelGroups
   * - ChannelMetadata
   * - UserMetadata
   *
   * @return One of known entity types.
   *
   * @internal
   */
  override get entityType(): 'Channel' | 'ChannelGroups' | 'ChannelMetadata' | 'UserMetadata' {
    return 'Channel';
  }

  /**
   * Get a unique channel name.
   *
   * @returns Channel name.
   */
  get name(): string {
    return this._nameOrId;
  }
}