Class TransactionPackage

constructor

• new TransactionPackage(
      copybookPath: string,
      transactions?: ITransaction[],
  ): TransactionPackage

  Parameters

  • copybookPath: string
  • Optionaltransactions: ITransaction[]

  Returns TransactionPackage

Readonlyparser

transactions

createEmptyTransaction

• createEmptyTransaction(): void

  Create a new empty transaction in this package.

  Returns void

getEventEmitter

• getEventEmitter(): TypedEventEmitter<IEvent>

  Get the TypedEventEmitter instance used

  Returns TypedEventEmitter<IEvent>

  TypedEventEmitter

getFirstTransaction

• getFirstTransaction(): ITransaction | undefined

  Get the first transaction from this package

  Returns ITransaction | undefined

  first transaction

getLastTransaction

• getLastTransaction(): ITransaction | undefined

  Get the last transaction from this package

  Returns ITransaction | undefined

  last transaction

load

• load(data: Buffer): void

  Load transaction(s) from a buffer

  Parameters

  • data: Buffer

    Transaction data

  Returns void

  Remarks

  The buffer can represent multiple transactions. Based on the length of the copybook, the buffer will be split

loadFile

• loadFile(path: string): void

  Load transaction from a file

  This method will read the file and pass the data to TransactionPackage.load(data: string) to process the data into a transaction

  Parameters

  • path: string

  Returns void

save

• save(path: string): void

  Save the current package to a file

  Parameters

  • path: string

  Returns void

toBuffer

• toBuffer(): Buffer

  Convert the current transaction package to a buffer

  Returns Buffer

  {Buffer}

  Remarks

  At the end of each transaction, a x'15' (New Line) byte is inserted

toJson

• toJson(spaces?: number): string

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

  Parameters

  • Optionalspaces: number

    Number of spaces to use for indentation

  Returns string

  {string}