| 1 | /**
|
| 2 | * A Transaction is created by calling [Client#begin]{@link Client#begin}
|
| 3 | *
|
| 4 | * Part of `@stomp/stompjs`.
|
| 5 | *
|
| 6 | * TODO: Example and caveat
|
| 7 | */
|
| 8 | export interface ITransaction {
|
| 9 | /**
|
| 10 | * You will need to access this to send, ack, or nack within this transaction.
|
| 11 | */
|
| 12 | id: string;
|
| 13 | /**
|
| 14 | * Commit this transaction. See [Client#commit]{@link Client#commit} for an example.
|
| 15 | */
|
| 16 | commit: () => void;
|
| 17 | /**
|
| 18 | * Abort this transaction. See [Client#abort]{@link Client#abort} for an example.
|
| 19 | */
|
| 20 | abort: () => void;
|
| 21 | }
|