Class Ledger

Structure that can merge record changes from another source.

Index

Constructors

Methods

createRecord encode getRecord listRecords merge total unit updateRecord year

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:81

Methods

createRecord

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

encode

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

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

getRecord

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

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:269

merge

merge(oth: Uint8Array): void
Merge / decode an encoded byte array.
Parameters
- oth: Uint8Array
Returns void
- Defined in ledger.ts:186

total

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

Returns Total
- Defined in ledger.ts:293

unit

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

Returns Unit
- Defined in ledger.ts:165

updateRecord

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

year

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

Returns number
- Defined in ledger.ts:172