Class Emitter

packages/socket.io-postgres-emitter/lib/index.ts:84–237

}

export class Emitter<
  EmitEvents extends EventsMap = DefaultEventsMap,
  ServerSideEvents extends EventsMap = DefaultEventsMap,
> {
  public readonly channel: string;
  public readonly tableName: string;
  public payloadThreshold: number;

  constructor(
    readonly pool: any,
    readonly nsp: string = "/",
    opts: Partial<PostgresEmitterOptions> = {},
  ) {
    const channelPrefix = opts.channelPrefix || "socket.io";
    this.channel = `${channelPrefix}#${nsp}`;
    this.tableName = opts.tableName || "socket_io_attachments";
    this.payloadThreshold = opts.payloadThreshold || 8000;
  }

  /**
   * Return a new emitter for the given namespace.
   *
   * @param nsp - namespace
   * @public
   */
  public of(nsp: string): Emitter {
    return new Emitter(this.pool, (nsp[0] !== "/" ? "/" : "") + nsp);
  }

  /**
   * Emits to all clients.
   *
   * @return Always true
   * @public
   */
  public emit<Ev extends EventNames<EmitEvents>>(
    ev: Ev,
    ...args: EventParams<EmitEvents, Ev>
  ): true {
    return new BroadcastOperator<EmitEvents, ServerSideEvents>(this).emit(
      ev,
      ...args,
    );
  }

  /**
   * Targets a room when emitting.
   *
   * @param room
   * @return BroadcastOperator
   * @public
   */
  public to(
    room: string | string[],
  ): BroadcastOperator<EmitEvents, ServerSideEvents> {
    return new BroadcastOperator(this).to(room);
  }