pta-tools
TypeScript icon, indicating that this package has built-in type declarations

1.6.0 • Public • Published

Plain text acounting node js api

Build Status

Plain text accounting JS helpers to interact with the ledger / hledger journal file format.

On the TS / JS side Transactions are described by the Transaction type

Main APIs

formatTransaction

import { formatTransaction } from 'pta-journal';
function formatTransaction(trx: Transaction): string

Returns the Transaction formatted in a way suitable to be appendend to a journal file

parse

import { parse } from 'pta-tools';
function parse(stream: ReadableStream): Promise<ParseResult>
type ParseResult = {
  transactions: Transaction[];
  accounts: string[];
  commodities: string[];
};

Returns the transactions, the accounts and the commodities from a journal. To get the stream of the journal you can use

const stream = fs.createReadStream('./hledger.journal');

/pta-tools/

    Package Sidebar

    Install

    npm i pta-tools

    Weekly Downloads

    9

    Version

    1.6.0

    License

    MIT

    Unpacked Size

    72.5 kB

    Total Files

    27

    Last publish

    Collaborators

    • kajyr