Skip to content

Commit 30eec66

Browse files
committed
chore: mark deprecated
1 parent c85b120 commit 30eec66

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

src/transactions.ts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,13 @@ export interface TransactionOptions extends Omit<CommandOperationOptions, 'timeo
7474

7575
/**
7676
* @public
77+
* @deprecated - Will be made internal in a future major release.
7778
* A class maintaining state related to a server transaction. Internal Only
7879
*/
7980
export class Transaction {
8081
/** @internal */
8182
state: TxnState;
82-
/** @internal */
83+
/** @deprecated - Will be made internal in a future major release. */
8384
options: TransactionOptions;
8485
/** @internal */
8586
_pinnedServer?: Server;
@@ -123,33 +124,33 @@ export class Transaction {
123124
return this._pinnedServer;
124125
}
125126

126-
/** @internal */
127+
/** @deprecated - Will be made internal in a future major release. */
127128
get recoveryToken(): Document | undefined {
128129
return this._recoveryToken;
129130
}
130131

131-
/** @internal */
132+
/** @deprecated - Will be made internal in a future major release. */
132133
get isPinned(): boolean {
133134
return !!this.server;
134135
}
135136

136137
/**
137-
* @internal
138+
* @deprecated - Will be made internal in a future major release.
138139
* @returns Whether the transaction has started
139140
*/
140141
get isStarting(): boolean {
141142
return this.state === TxnState.STARTING_TRANSACTION;
142143
}
143144

144145
/**
145-
* @internal
146+
* @deprecated - Will be made internal in a future major release.
146147
* @returns Whether this session is presently in a transaction
147148
*/
148149
get isActive(): boolean {
149150
return ACTIVE_STATES.has(this.state);
150151
}
151152

152-
/** @internal */
153+
/** @deprecated - Will be made internal in a future major release. */
153154
get isCommitted(): boolean {
154155
return COMMITTED_STATES.has(this.state);
155156
}

0 commit comments

Comments
 (0)