Class Transaction

Hierarchy

Transaction

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Transaction(options?: TransactionOptions): Transaction

- Defined in src/transactions.ts:89
Create a transaction @internal

Parameters
- Optional options: TransactionOptions
Returns Transaction

Properties

Optional _pinnedServer

_pinnedServer?: Server

Optional _recoveryToken

_recoveryToken?: Document

options

options: TransactionOptions

state

state: TxnState

Accessors

isActive

get isActive(): boolean

- Defined in src/transactions.ts:141
Returns boolean
Whether this session is presently in a transaction

isCommitted

get isCommitted(): boolean

- Defined in src/transactions.ts:145
Returns boolean

isPinned

get isPinned(): boolean

- Defined in src/transactions.ts:129
Returns boolean

isStarting

get isStarting(): boolean

- Defined in src/transactions.ts:134
Returns boolean
Whether the transaction has started

recoveryToken

get recoveryToken(): undefined | Document

- Defined in src/transactions.ts:125
Returns undefined | Document

server

get server(): undefined | Server

- Defined in src/transactions.ts:121
Returns undefined | Server

Methods

pinServer

pinServer(server: Server): void

- Defined in src/transactions.ts:173
Parameters
- server: Server
Returns void

transition

transition(nextState: TxnState): void

- Defined in src/transactions.ts:153
Transition the transaction in the state machine

Parameters
- nextState: TxnState
  
  The new state to transition to
Returns void

unpinServer

unpinServer(): void

- Defined in src/transactions.ts:180
Returns void

Generated using TypeDoc