Class Ledger

Structure that can merge record changes from another source.

Index

Constructors

Methods

createRecord encode getRecord ledgerId listRecords merge saved toCsv total unit updateRecord year buildLedgerId

Constructors

constructor

new Ledger(
    id: string,
    unit: Unit,
    year: number,
    updatedCb: (ledgerId: string) => void,
): Ledger
Start blank.
Parameters
- id: string
- unit: Unit
- year: number
- updatedCb: (ledgerId: string) => void
Returns Ledger
- Defined in ledger.ts:91

Methods

createRecord

createRecord(record: Record): string
Create a new record.
Parameters
- record: Record
Returns string
- Defined in ledger.ts:266

encode

encode(): Uint8Array<ArrayBuffer>
Encode as a byte array.

Returns Uint8Array<ArrayBuffer>
- Defined in ledger.ts:217

getRecord

getRecord(recordId: string): Record
Get a record by id.
Parameters
- recordId: string
Returns Record
- Defined in ledger.ts:337

ledgerId

ledgerId(): string
Get the ID for this ledger.

Returns string
- Defined in ledger.ts:116

listRecords

listRecords(): string[]
List the records in this ledger. The ids will be sorted by record date with most recent records first.

Returns string[]
- Defined in ledger.ts:330

merge

merge(oth: Uint8Array, publishUpdate?: boolean): void
Merge / decode an encoded byte array.
Parameters
- oth: Uint8Array
- OptionalpublishUpdate: boolean
Returns void
- Defined in ledger.ts:224

saved

saved(saved?: boolean): boolean
As a getter, get the current saved state. As a setter, set the current saved state.
Parameters
- Optionalsaved: boolean
Returns boolean
- Defined in ledger.ts:124

toCsv

toCsv(): string
Generate a user-friendly csv file from this ledger.

Returns string
- Defined in ledger.ts:308

total

total(): Total
Total all income and expense in all records in this ledger.

Returns Total
- Defined in ledger.ts:354

unit

unit(): Unit
Get the unit used by this ledger.

Returns Unit
- Defined in ledger.ts:203

updateRecord

updateRecord(record: Record): void
Update a record.
Parameters
- record: Record
Returns void
- Defined in ledger.ts:292

year

year(): number
Get the year used by this ledger.

Returns number
- Defined in ledger.ts:210

`Static`buildLedgerId

buildLedgerId(year: number, unit: Unit): string
Construct a canonical ledger id by year and unit.
Parameters
- year: number
- unit: Unit
Returns string
- Defined in ledger.ts:109