IMQClientOptions interface

Options accepted by a generated IMQ client.

Signature:

export interface IMQClientOptions extends IMQOptions 

Extends: IMQOptions

Remarks

Extends the core queue options, so all transport settings are accepted as well. Note that path, compile, write and timeout affect code generation only and have no effect on an already-generated client at runtime.

Properties

Property

Modifiers

Type

Description

afterCall?

IMQAfterCall<IMQClient>

(Optional) Post-settle hook. See IMQAfterCall.

beforeCall?

IMQBeforeCall<IMQClient>

(Optional) Pre-dispatch hook. See IMQBeforeCall; on a client it receives the request only.

callTimeout?

number

(Optional) Per-call timeout in milliseconds.

compile

boolean

Transpile the generated client and evaluate it in-process, returning its exports.

path

string

Directory the generated client is written to, resolved relative to the process working directory.

singleQueue?

boolean

(Optional) Share a single reply queue and transport connection across every client in the process, instead of one per client.

timeout

number

Milliseconds the client generator waits for the target service to answer its description request before failing.

write

boolean

Persist the generated .ts and .js pair in IMQClientOptions.path.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.