ServerNats

  
class ServerNats extends Server implements CustomTransportStrategy {
  constructor(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 28 more ...; tokenHandler?: any; })
  transportId: Transport.NATS
  listen(callback: (err?: unknown, ...optionalParams: unknown[]) => void)
  start(callback: (err?: unknown, ...optionalParams: unknown[]) => void)
  bindEvents(client: Client)
  close()
  createNatsClient(): Promise<Client>
  getMessageHandler(channel: string): Function
  handleMessage(channel: string, natsMsg: NatsMsg)
  getPublisher(natsMsg: NatsMsg, id: string)
  handleStatusUpdates(client: Client)
  protected initializeSerializer(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 28 more ...; tokenHandler?: any; })
  protected initializeDeserializer(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 28 more ...; tokenHandler?: any; })

  // 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: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 28 more ...; tokenHandler?: any; })

Parameters

Option Type Description
options object

Properties

Property Description
transportId: Transport.NATS Read-only.

Methods

listen()


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

Parameters

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

start()


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

Parameters

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

bindEvents()


bindEvents(client: Client)

Parameters

Option Type Description
client Client

close()


close()

Parameters

There are no parameters.

createNatsClient()


createNatsClient(): Promise<Client>

Parameters

There are no parameters.

Returns

Promise<Client>

getMessageHandler()


getMessageHandler(channel: string): Function

Parameters

Option Type Description
channel string

Returns

Function

handleMessage()


handleMessage(channel: string, natsMsg: NatsMsg)

Parameters

Option Type Description
channel string
natsMsg NatsMsg

getPublisher()


getPublisher(natsMsg: NatsMsg, id: string)

Parameters

Option Type Description
natsMsg NatsMsg
id string

handleStatusUpdates()


handleStatusUpdates(client: Client)

Parameters

Option Type Description
client Client

initializeSerializer()


protected initializeSerializer(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 28 more ...; tokenHandler?: any; })

Parameters

Option Type Description
options object

initializeDeserializer()


protected initializeDeserializer(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 28 more ...; tokenHandler?: any; })

Parameters

Option Type Description
options object