ServerNats

  
class ServerNats<E extends NatsEvents = NatsEvents, S extends NatsStatus = NatsStatus> extends Server {
  constructor(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 30 more ...; gracePeriod?: number; })
  transportId: Transport.NATS
  protected statusEventEmitter: EventEmitter<{...}
  listen(callback: (err?: unknown, ...optionalParams: unknown[]) => void)
  start(callback: (err?: unknown, ...optionalParams: unknown[]) => void)
  bindEvents(client: any)
  close()
  createNatsClient(): Promise<Client>
  getMessageHandler(channel: string): Function
  handleMessage(channel: string, natsMsg: any)
  getPublisher(natsMsg: any, id: string)
  handleStatusUpdates(client: any)
  unwrap<T>(): T
  on<EventKey extends keyof E = keyof E, EventCallback extends E[EventKey] = E[EventKey]>(event: EventKey, callback: EventCallback)
  protected initializeSerializer(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 30 more ...; gracePeriod?: number; })
  protected initializeDeserializer(options: { [key: string]: any; headers?: Record<string, string>; authenticator?: any; debug?: boolean; ignoreClusterUpdates?: boolean; inboxPrefix?: string; encoding?: string; name?: string; user?: string; ... 30 more ...; gracePeriod?: number; })

  // inherited from nest/packages/microservices/Server
  transportId?: Transport | symbol
  protected messageHandlers: Map<string, MessageHandler>
  protected logger: LoggerService
  protected serializer: ConsumerSerializer
  protected deserializer: ConsumerDeserializer
  protected _status$: ReplaySubject<Status>
  status: Observable<Status>
  abstract on<EventKey extends keyof EventsMap = keyof EventsMap, EventCallback extends EventsMap[EventKey] = EventsMap[EventKey]>(event: EventKey, callback: EventCallback): any
  abstract unwrap<T>(): T
  abstract listen(callback: (...optionalParams: unknown[]) => any): any
  abstract close(): any
  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>) => void | Promise<unknown>): Subscription
  handleEvent(pattern: string, packet: ReadPacket<any>, context: BaseRpcContext<unknown[]>): Promise<any>
  transformToObservable(resultOrDeferred: any)
  getOptionsProp<Options extends MicroserviceOptions['options'], Attribute extends keyof Options, DefaultValue extends Options[Attribute] = Options[Attribute]>(obj: Options, prop: Attribute, defaultValue: DefaultValue = undefined as DefaultValue)
  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; ... 30 more ...; gracePeriod?: number; })

Parameters

Option Type Description
options object

Properties

Property Description
transportId: Transport.NATS Read-only.
protected statusEventEmitter: EventEmitter<{ [key in keyof NatsEvents]: Parameters<NatsEvents[key]>; }>

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: any)

Parameters

Option Type Description
client any

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: any)

Parameters

Option Type Description
channel string
natsMsg any

getPublisher()


getPublisher(natsMsg: any, id: string)

Parameters

Option Type Description
natsMsg any
id string

handleStatusUpdates()


handleStatusUpdates(client: any)

Parameters

Option Type Description
client any

unwrap()


unwrap<T>(): T

Parameters

There are no parameters.

Returns

T

on()


on<EventKey extends keyof E = keyof E, EventCallback extends E[EventKey] = E[EventKey]>(event: EventKey, callback: EventCallback)

Parameters

Option Type Description
event EventKey
callback EventCallback

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; ... 30 more ...; gracePeriod?: number; })

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; ... 30 more ...; gracePeriod?: number; })

Parameters

Option Type Description
options object