Interface ITransactionPackage

Readonlyparser

Optionaltransactions

createEmptyTransaction

• createEmptyTransaction(): void

  Create a new empty transaction using the parsed copybook

  Returns void

getFirstTransaction

• getFirstTransaction(): ITransaction | undefined

  Get the first transaction in the current package, or undefined if no transactions exist.

  Returns ITransaction | undefined

  {(ITransaction | undefined)}

  Remarks

  Convenience method, you can also use:

  transactionPackage.transactions[0]
  Copy

getLastTransaction

• getLastTransaction(): ITransaction | undefined

  Get the last transaction in the current package, or undefined if no transactions exist.

  Returns ITransaction | undefined

  {(ITransaction | undefined)}

  Remarks

  Convenience method, you can also use:

  transactionPackage.transactions[transactionPackage.transactions.length - 1]
  Copy

load

• load(data: Buffer): void

  Load data from a Buffer into transactions.

  The data param can contain multiple transactions in a single buffer and splitBuffer is used to split the buffer into an array of buffers for further processing

  Parameters

  • data: Buffer

  Returns void

loadFile

• loadFile(path: string): void

  Load data from a file into transactions

  Parameters

  • path: string

  Returns void

  Throws

  Throws an error when the provided path doesn't exist.

save

• save(path: string): void

  Save the current transaction package to file.

  The new line character x'15' will be added at the end of each transaction

  Parameters

  • path: string

  Returns void

toBuffer

• toBuffer(): Buffer

  Convert the current transaction package to a buffer

  Returns Buffer

  {Buffer}

toJson

• toJson(spaces?: number): string

  Convert the current transaction package to an array of transactions as JSON string

  Parameters

  • Optionalspaces: number

    Number of spaces to use for indentation

  Returns string

  {string}