Type Parameters

Hierarchy

  • default

Constructors

  • Type Parameters

    Parameters

    • options: RedisClusterOptions<M, F, S>
    • emit: ((eventName, ...args) => boolean)
        • (eventName, ...args): boolean
        • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

          Returns true if the event had listeners, false otherwise.

          import { EventEmitter } from 'node:events';
          const myEmitter = new EventEmitter();

          // First listener
          myEmitter.on('event', function firstListener() {
          console.log('Helloooo! first listener');
          });
          // Second listener
          myEmitter.on('event', function secondListener(arg1, arg2) {
          console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
          });
          // Third listener
          myEmitter.on('event', function thirdListener(...args) {
          const parameters = args.join(', ');
          console.log(`event with parameters ${parameters} in third listener`);
          });

          console.log(myEmitter.listeners('event'));

          myEmitter.emit('event', 1, 2, 3, 4, 5);

          // Prints:
          // [
          // [Function: firstListener],
          // [Function: secondListener],
          // [Function: thirdListener]
          // ]
          // Helloooo! first listener
          // event with parameters 1, 2 in second listener
          // event with parameters 1, 2, 3, 4, 5 in third listener

          Parameters

          • eventName: string | symbol
          • Rest ...args: any[]

          Returns boolean

          Since

          v0.1.26

    Returns default<M, F, S>

Properties

#Client: InstantiableRedisClient<M, F, S>
#emit: ((eventName, ...args) => boolean)

Type declaration

    • (eventName, ...args): boolean
    • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

      Returns true if the event had listeners, false otherwise.

      import { EventEmitter } from 'node:events';
      const myEmitter = new EventEmitter();

      // First listener
      myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
      });
      // Second listener
      myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
      });
      // Third listener
      myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
      });

      console.log(myEmitter.listeners('event'));

      myEmitter.emit('event', 1, 2, 3, 4, 5);

      // Prints:
      // [
      // [Function: firstListener],
      // [Function: secondListener],
      // [Function: thirdListener]
      // ]
      // Helloooo! first listener
      // event with parameters 1, 2 in second listener
      // event with parameters 1, 2, 3, 4, 5 in third listener

      Parameters

      • eventName: string | symbol
      • Rest ...args: any[]

      Returns boolean

      Since

      v0.1.26

#isOpen: boolean = false
#options: RedisClusterOptions<M, F, S>
#randomNodeIterator?: IterableIterator<ShardNode<M, F, S>>
#runningRediscoverPromise?: Promise<void>
masters: ShardNode<M, F, S>[] = ...
nodeByAddress: Map<string, ShardNode<M, F, S> | MasterNode<M, F, S>> = ...
pubSubNode?: Required<Node<M, F, S>>
replicas: ShardNode<M, F, S>[] = ...
shards: Shard<M, F, S>[] = ...
slots: Shard<M, F, S>[] = ...
#SLOTS: number = 16384

Accessors

Methods

  • Parameters

    Returns Promise<{
        from: number;
        master: { ip: string; port: number; id: string; };
        replicas: ({ ip: string; port: number; id: string; })[];
        to: number;
    }[]>

Generated using TypeDoc