ServerRedis

  
class ServerRedis extends Server implements CustomTransportStrategy {
  constructor(options: { host?: string; port?: number; retryAttempts?: number; retryDelay?: number; serializer?: Serializer<any, any>; deserializer?: Deserializer<any, any>; } & IORedisOptions)
  transportId: Transport.REDIS
  listen(callback: (err?: unknown, ...optionalParams: unknown[]) => void)
  start(callback?: () => void)
  bindEvents(subClient: any, pubClient: any)
  close()
  createRedisClient(): Redis
  getMessageHandler(pub: any)
  handleMessage(channel: string, buffer: any, pub: any)
  getPublisher(pub: any, pattern: any, id: string)
  parseMessage(content: any): Record<string, any>
  getRequestPattern(pattern: string): string
  getReplyPattern(pattern: string): string
  handleError(stream: any)
  getClientOptions(): Partial<RedisOptions['options']>
  createRetryStrategy(times: number): undefined | number | void

  // inherited from nest/packages/microservices/Server
  protected messageHandlers: Map<string, MessageHandler>
  protected logger: LoggerService
  protected serializer: ConsumerSerializer
  protected deserializer: ConsumerDeserializer
  addHandler(pattern: any, callback: MessageHandler<any, any, any>, isEventHandler: boolean = false, extras: Record<string, any> = {})
  getHandlers(): Map<string, MessageHandler>
  getHandlerByPattern(pattern: string): MessageHandler | null
  send(stream$: Observable<any>, respond: (data: WritePacket<any>) => unknown): Subscription
  handleEvent(pattern: string, packet: ReadPacket<any>, context: BaseRpcContext<unknown[]>): Promise<any>
  transformToObservable(resultOrDeferred: any)
  getOptionsProp<T extends MicroserviceOptions['options'], K extends keyof T>(obj: T, prop: K, defaultValue: T[K] = undefined)
  protected handleError(error: string)
  protected loadPackage<T = any>(name: string, ctx: string, loader?: Function): T
  protected initializeSerializer(options: { url?: string; maxSendMessageLength?: number; maxReceiveMessageLength?: number; maxMetadataSize?: number; keepalive?: { keepaliveTimeMs?: number; keepaliveTimeoutMs?: number; keepalivePermitWithoutCalls?: number; http2MaxPingsWithoutData?: number; http2MinTimeBetweenPingsMs?: number; http2MinPingIntervalWithoutData...)
  protected initializeDeserializer(options: { url?: string; maxSendMessageLength?: number; maxReceiveMessageLength?: number; maxMetadataSize?: number; keepalive?: { keepaliveTimeMs?: number; keepaliveTimeoutMs?: number; keepalivePermitWithoutCalls?: number; http2MaxPingsWithoutData?: number; http2MinTimeBetweenPingsMs?: number; http2MinPingIntervalWithoutData...)
  protected getRouteFromPattern(pattern: string): string
  protected normalizePattern(pattern: MsPattern): string
}

Constructor


constructor(options: { host?: string; port?: number; retryAttempts?: number; retryDelay?: number; serializer?: Serializer<any, any>; deserializer?: Deserializer<any, any>; } & IORedisOptions)

Parameters

Option Type Description
options { host?: string; port?: number; retryAttempts?: number; retryDelay?: number; serializer?: Serializer; deserializer?: Deserializer; } & IORedisOptions

Properties

Property Description
transportId: Transport.REDIS Read-only.

Methods

listen()


listen(callback: (err?: unknown, ...optionalParams: unknown[]) => void)

Parameters

Option Type Description
callback (err?: unknown, ...optionalParams: unknown[]) => void

start()


start(callback?: () => void)

Parameters

Option Type Description
callback () => void

Optional. Default is undefined.

bindEvents()


bindEvents(subClient: any, pubClient: any)

Parameters

Option Type Description
subClient any
pubClient any

close()


close()

Parameters

There are no parameters.

createRedisClient()


createRedisClient(): Redis

Parameters

There are no parameters.

Returns

Redis

getMessageHandler()


getMessageHandler(pub: any)

Parameters

Option Type Description
pub any

handleMessage()


handleMessage(channel: string, buffer: any, pub: any)

Parameters

Option Type Description
channel string
buffer any
pub any

getPublisher()


getPublisher(pub: any, pattern: any, id: string)

Parameters

Option Type Description
pub any
pattern any
id string

parseMessage()


parseMessage(content: any): Record<string, any>

Parameters

Option Type Description
content any

Returns

Record<string, any>

getRequestPattern()


getRequestPattern(pattern: string): string

Parameters

Option Type Description
pattern string

Returns

string

getReplyPattern()


getReplyPattern(pattern: string): string

Parameters

Option Type Description
pattern string

Returns

string

handleError()


handleError(stream: any)

Parameters

Option Type Description
stream any

getClientOptions()


getClientOptions(): Partial<RedisOptions['options']>

Parameters

There are no parameters.

Returns

Partial<RedisOptions['options']>

createRetryStrategy()


createRetryStrategy(times: number): undefined | number | void

Parameters

Option Type Description
times number

Returns

undefined | number | void