File

consolidated/stompjs/src/i-transaction.ts

Description

A Transaction is created by calling Client#begin

Part of @stomp/stompjs.

TODO: Example and caveat

Index

Properties

Properties

abort
abort: function
Type : function

Abort this transaction. See Client#abort for an example.

commit
commit: function
Type : function

Commit this transaction. See Client#commit for an example.

id
id: string
Type : string

You will need to access this to send, ack, or nack within this transaction.

export interface ITransaction {
  /**
   * You will need to access this to send, ack, or nack within this transaction.
   */
  id: string;

  /**
   * Commit this transaction. See [Client#commit]{@link Client#commit} for an example.
   */
  commit: () => void;

  /**
   * Abort this transaction. See [Client#abort]{@link Client#abort} for an example.
   */
  abort: () => void;
}

results matching ""

    No results matching ""