Class NsqStore

constructor

• new NsqStore(options?: NsqStoreOptions): NsqStore

  Parameters

  • options: NsqStoreOptions = {}

  Returns NsqStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): any

  Returns the underlying producer Writer for operations not wrapped here.

  Returns any

enqueue

• enqueue(queue: string, jobData: unknown): Promise<null>

  Publish a message to a topic via the producer Writer. The payload is JSON-serialized (strings/Buffers pass through). NSQ does not return a client-visible job id, so this resolves to null.

  Parameters

  • queue: string
  • jobData: unknown

  Returns Promise<null>

process

• process(
      queue: string,
      handler: (msg: any) => void | Promise<void>,
      opts?: NsqProcessOptions,
  ): Promise<any>

  Subscribe a Reader to queue (topic) on a channel and invoke handler(msg) for each delivered message. One reader is cached per topic/channel; a repeat process() on the same pair returns it.

  Parameters

  • queue: string
  • handler: (msg: any) => void | Promise<void>
  • opts: NsqProcessOptions = {}

  Returns Promise<any>

getJob

• getJob(_queue: string, _id: string): Promise<never>

  Not supported: NSQ exposes no server-side lookup of a message by id.

  Parameters

  • _queue: string
  • _id: string

  Returns Promise<never>

remove

• remove(_queue: string, _id: string): Promise<never>

  Not supported: NSQ messages are acknowledged via finish(), not removed by id.

  Parameters

  • _queue: string
  • _id: string

  Returns Promise<never>

stats

• stats(queue: string): Promise<{ topic: string; readers: number }>

  Return a lightweight local view of consumers for a topic: the number of active Readers this store has bound to it. (NSQ's authoritative stats live in nsqd's HTTP /stats endpoint, not the client library.)

  Parameters

  • queue: string

  Returns Promise<{ topic: string; readers: number }>