Index

consolidated/stompjs/src/types.ts

closeEventCallbackType

This callback will receive a [CloseEvent]://developer.mozilla.org/en-US/docs/Web/API/CloseEventhttps as parameter.

Part of @stomp/stompjs.

function
debugFnType

This callback will receive a string as a parameter.

Part of @stomp/stompjs.

function
emptyCallbackType

This callback is an "Event" only callback, no parameters provided.

Part of @stomp/stompjs.

function
frameCallbackType

This callback will receive a IFrame as parameter.

Part of @stomp/stompjs.

|
messageCallbackType

This callback will receive a IMessage as parameter.

Part of @stomp/stompjs.

function
publishParams

Backward compatibility, switch to IPublishParams.

IPublishParams
wsErrorCallbackType

This callback will receive an [Event]://developer.mozilla.org/en-US/docs/Web/API/Eventhttps as parameter.

Part of @stomp/stompjs.

function

consolidated/stompjs/src/i-frame.ts

Frame

Alias for IFrame

IFrame

consolidated/stompjs/src/i-message.ts

Message

Aliased to IMessage.

Part of @stomp/stompjs.

IMessage

consolidated/rx-stomp/src/rx-stomp-rpc-config.ts

setupReplyQueueFnType

This is a Ninja-level topic.

A factory function type used to create an Observable for the reply queue.

Purpose

  • RxStompRPC needs an Observable that emits all RPC replies. By default, it uses RxStomp.unhandledMessage$, which receives messages that don’t match any explicit subscription.
  • Implement this to route replies from a dedicated queue or custom destination if your broker requires it.

Parameters

  • replyQueueName: The queue/destination where RPC replies should arrive.
  • rxStomp: The active RxStomp instance (use it to set up any subscriptions you need).

Return

  • An Observable that emits every reply (IMessage) arriving on the reply queue.

Notes

  • The returned Observable should be “hot” (i.e., continue receiving frames without requiring downstream subscribers). If you return a cold Observable, RxStompRPC ensures it remains subscribed internally to keep the stream alive.
  • The Observable must include all messages for the reply queue; RxStompRPC will filter replies per request using the correlation-id header.

Example: use a dedicated temporary reply queue

const setupReplyQueue: setupReplyQueueFnType = (replyQueueName, rxStomp) => {
  // Ensure the broker delivers replies to `replyQueueName` for this session.
  // Then return a hot Observable of all messages from that destination.
  return rxStomp.watch({ destination: replyQueueName });
};
function

results matching ""

    No results matching ""