cluster-slots.d.ts 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. /// <reference types="node" />
  2. import { RedisClientType } from '../client';
  3. import { RedisClusterOptions } from '.';
  4. import { RedisCommandArgument, RedisFunctions, RedisModules, RedisScripts } from '../commands';
  5. import { ChannelListeners } from '../client/pub-sub';
  6. import { EventEmitter } from 'stream';
  7. interface NodeAddress {
  8. host: string;
  9. port: number;
  10. }
  11. export type NodeAddressMap = {
  12. [address: string]: NodeAddress;
  13. } | ((address: string) => NodeAddress | undefined);
  14. type ValueOrPromise<T> = T | Promise<T>;
  15. type ClientOrPromise<M extends RedisModules, F extends RedisFunctions, S extends RedisScripts> = ValueOrPromise<RedisClientType<M, F, S>>;
  16. export interface Node<M extends RedisModules, F extends RedisFunctions, S extends RedisScripts> {
  17. address: string;
  18. client?: ClientOrPromise<M, F, S>;
  19. }
  20. export interface ShardNode<M extends RedisModules, F extends RedisFunctions, S extends RedisScripts> extends Node<M, F, S> {
  21. id: string;
  22. host: string;
  23. port: number;
  24. readonly: boolean;
  25. }
  26. export interface MasterNode<M extends RedisModules, F extends RedisFunctions, S extends RedisScripts> extends ShardNode<M, F, S> {
  27. pubSubClient?: ClientOrPromise<M, F, S>;
  28. }
  29. export interface Shard<M extends RedisModules, F extends RedisFunctions, S extends RedisScripts> {
  30. master: MasterNode<M, F, S>;
  31. replicas?: Array<ShardNode<M, F, S>>;
  32. nodesIterator?: IterableIterator<ShardNode<M, F, S>>;
  33. }
  34. export type PubSubNode<M extends RedisModules, F extends RedisFunctions, S extends RedisScripts> = Required<Node<M, F, S>>;
  35. export type OnShardedChannelMovedError = (err: unknown, channel: string, listeners?: ChannelListeners) => void;
  36. export default class RedisClusterSlots<M extends RedisModules, F extends RedisFunctions, S extends RedisScripts> {
  37. #private;
  38. slots: Shard<M, F, S>[];
  39. shards: Shard<M, F, S>[];
  40. masters: ShardNode<M, F, S>[];
  41. replicas: ShardNode<M, F, S>[];
  42. readonly nodeByAddress: Map<string, ShardNode<M, F, S> | MasterNode<M, F, S>>;
  43. pubSubNode?: PubSubNode<M, F, S>;
  44. get isOpen(): boolean;
  45. constructor(options: RedisClusterOptions<M, F, S>, emit: EventEmitter['emit']);
  46. connect(): Promise<void>;
  47. nodeClient(node: ShardNode<M, F, S>): ClientOrPromise<M, F, S>;
  48. rediscover(startWith: RedisClientType<M, F, S>): Promise<void>;
  49. quit(): Promise<void>;
  50. disconnect(): Promise<void>;
  51. getClient(firstKey: RedisCommandArgument | undefined, isReadonly: boolean | undefined): ClientOrPromise<M, F, S>;
  52. getRandomNode(): ShardNode<M, F, S>;
  53. getSlotRandomNode(slotNumber: number): ShardNode<M, F, S>;
  54. getMasterByAddress(address: string): ClientOrPromise<M, F, S> | undefined;
  55. getPubSubClient(): ClientOrPromise<M, F, S>;
  56. executeUnsubscribeCommand(unsubscribe: (client: RedisClientType<M, F, S>) => Promise<void>): Promise<void>;
  57. getShardedPubSubClient(channel: string): ClientOrPromise<M, F, S>;
  58. executeShardedUnsubscribeCommand(channel: string, unsubscribe: (client: RedisClientType<M, F, S>) => Promise<void>): Promise<void>;
  59. }
  60. export {};