Class Transaction

The Transaction class represents a single line in a transactions file (package) that is represented by a copybook.

A transaction requires a parsed copybook to be able to store data in the resulting DataItem's

Implements

ITransaction

Index

Constructors

Methods

getCopybookItem getCopybookItems getValue setValue toBuffer toJson toString

Constructors

constructor

new Transaction(
dataItem: ICopybookItem[],
transactionData?: Buffer<ArrayBufferLike>,
): Transaction
Parameters
- dataItem: ICopybookItem[]
- OptionaltransactionData: Buffer<ArrayBufferLike>
Returns Transaction
- Defined in transaction/transaction.ts:16

Methods

getCopybookItem

getCopybookItem(name: string): ICopybookItem | undefined
Get a specific copybook item based on the name of the item
Parameters
- name: string
  Name of the copybook item
Returns ICopybookItem | undefined
copybook item

Remarks
It is possible that due to an occurs class, mutliple data items with the same name exist. Only the first occurance will be returned. Using the name of the group field might be better
Implementation of ITransaction.getCopybookItem
- Defined in transaction/transaction.ts:165

getCopybookItems

getCopybookItems(): ICopybookItem[]
Return an array of all copybook items

Returns ICopybookItem[]
copybook items
Implementation of ITransaction.getCopybookItems
- Defined in transaction/transaction.ts:152

getValue

getValue(name: string): string | undefined
Get the value of a specific copybook item using the name of the copybook item
Parameters
- name: string
Returns string | undefined
value Returns the string representation of the copybook item's value, or undefined if it is not set

Throws
Throws an error if a copybook item couldn't be found based on the provided name
Implementation of ITransaction.getValue
- Defined in transaction/transaction.ts:176

setValue

setValue(name: string, value: string): void
Set the value of a copybook item based on the name of the item
Parameters
- name: string
  Name of the copybook item
- value: string
  String representation of the value for the copybook item
Returns void
Throws
Throws an error if a copybook item couldn't be found based on the provided name
Implementation of ITransaction.setValue
- Defined in transaction/transaction.ts:192

toBuffer

toBuffer(): Buffer
Convert ICopybookItem values to a buffer

Returns Buffer
{Buffer}
Implementation of ITransaction.toBuffer
- Defined in transaction/transaction.ts:220

toJson

toJson(): string
Get a JSON representation of the current transaction

Returns string
{string}
Implementation of ITransaction.toJson
- Defined in transaction/transaction.ts:211

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in transaction/transaction.ts:202