import {Transaction} from 'eventstore-ts-client/src/stream/Transaction.ts'

public class | source

Transaction

Base class for handling transaction writes to stream

Constructor Summary

Public Constructor
public	constructor() Creates an instance of Transaction.

Member Summary

Public Members
public get	id: Long Gets transaction id
public get	isCommitted: boolean Gets whether is committed
public get	isRolledBack: boolean Gets whether is rolled back
public get	name: string Gets transaction name

Protected Members
protected	committed: boolean indicates if transaction is committed
protected	credentials: UserCredentials \| null credentials for transaction
protected	esConnection: Eventstore current connection
protected	requireMaster: boolean indicates if transaction needs master node
protected	rolledBack: boolean indicates if transaction is rolled back
protected	stream: Stream corresponding stream
protected	transactionId: Long id of transaction

Method Summary

Public Methods
public	async append(event: Event, requireMaster: , credentials: UserCredentials \| null): Promise Appends single event or array of events to transaction
public	async commit(requireMaster: , credentials: UserCredentials \| null): Promise Commits transaction
public	roleBack(): void Roles back transaction

Protected Methods
protected	async appendEvents(events: , requireMaster: , credentials: UserCredentials \| null): Promise Appends array of evens to transaction

Public Constructors

public constructor() source

Creates an instance of Transaction.

Public Members

public get id: Long source

Gets transaction id

public get isCommitted: boolean source

Gets whether is committed

public get isRolledBack: boolean source

Gets whether is rolled back

public get name: string source

Gets transaction name

Protected Members

protected committed: boolean source

indicates if transaction is committed

protected credentials: UserCredentials | null source

credentials for transaction

protected esConnection: Eventstore source

current connection

protected requireMaster: boolean source

indicates if transaction needs master node

protected rolledBack: boolean source

indicates if transaction is rolled back

protected stream: Stream source

corresponding stream

protected transactionId: Long source

id of transaction

Public Methods

public async append(event: Event, requireMaster: , credentials: UserCredentials | null): Promise source

Appends single event or array of events to transaction

Params:

Name	Type	Attribute	Description
event	Event
requireMaster
credentials	UserCredentials \| null

public async commit(requireMaster: , credentials: UserCredentials | null): Promise source

Commits transaction

Params:

Name	Type	Attribute	Description
requireMaster
credentials	UserCredentials \| null

public roleBack(): void source

Roles back transaction

Protected Methods

protected async appendEvents(events: , requireMaster: , credentials: UserCredentials | null): Promise source

Appends array of evens to transaction

Params:

Name	Type	Attribute	Description
events
requireMaster
credentials	UserCredentials \| null