Class default

Tracks metrics for import runs and individual banks.

Index

Constructors

Methods

startImport startBank recordAccountTransactions recordBankSuccess recordBankFailure recordReconciliation getSummary printSummary getBankMetrics hasFailures getErrorBreakdown

Constructors

constructor

new default(): default

Returns default

Methods

startImport

startImport(): Procedure<{ status: "started" }>
Starts import tracking.

Returns Procedure<{ status: "started" }>
started status.
- Defined in Services/Metrics/Registry.ts:15

startBank

startBank(bankName: string): Procedure<{ status: "tracking" }>
Starts bank tracking.
Parameters
- bankName: string
  bank name.
Returns Procedure<{ status: "tracking" }>
tracking status.
- Defined in Services/Metrics/Registry.ts:23

recordAccountTransactions

recordAccountTransactions(
bankName: string,
record: IAccountTransactionsRecord,
): Procedure<{ status: "recorded" }>
Records account transactions.
Parameters
- bankName: string
  bank name.
- record: IAccountTransactionsRecord
  account metrics.
Returns Procedure<{ status: "recorded" }>
recorded status.
- Defined in Services/Metrics/Registry.ts:34

recordBankSuccess

recordBankSuccess(
    bankName: string,
    transactionsImported: number,
    transactionsSkipped: number,
): Procedure<{ status: "recorded" }>
Records bank success.
Parameters
- bankName: string
  bank name.
- transactionsImported: number
  imported count.
- transactionsSkipped: number
  skipped count.
Returns Procedure<{ status: "recorded" }>
recorded status.
- Defined in Services/Metrics/Registry.ts:47

recordBankFailure

recordBankFailure(
bankName: string,
error: Error,
): Procedure<{ status: "recorded" }>
Records bank failure.
Parameters
- bankName: string
  bank name.
- error: Error
  failure cause.
Returns Procedure<{ status: "recorded" }>
recorded status.
- Defined in Services/Metrics/Registry.ts:59

recordReconciliation

recordReconciliation(
    bankName: string,
    status: NonNullable<
        "skipped"
        | "created"
        | "already-reconciled"
        | undefined,
    >,
    amount?: number,
): Procedure<{ status: "recorded" }>
Records reconciliation status.
Parameters
- bankName: string
  bank name.
- status: NonNullable<"skipped" | "created" | "already-reconciled" | undefined>
  reconciliation status.
- Optionalamount: number
  optional amount.
Returns Procedure<{ status: "recorded" }>
recorded status.
- Defined in Services/Metrics/Registry.ts:70

getSummary

getSummary(): Procedure<IImportSummary>
Returns import summary.

Returns Procedure<IImportSummary>
import summary.
- Defined in Services/Metrics/Registry.ts:81

printSummary

printSummary(): Procedure<{ status: "printed" }>
Prints import summary.

Returns Procedure<{ status: "printed" }>
printed status.
- Defined in Services/Metrics/Registry.ts:89

getBankMetrics

getBankMetrics(bankName: string): Procedure<IBankMetrics>
Returns bank metrics.
Parameters
- bankName: string
  bank name.
Returns Procedure<IBankMetrics>
bank metrics.
- Defined in Services/Metrics/Registry.ts:99

hasFailures

hasFailures(): Procedure<boolean>
Checks failure state.

Returns Procedure<boolean>
failure flag.
- Defined in Services/Metrics/Registry.ts:106

getErrorBreakdown

getErrorBreakdown(): Procedure<Record<string, number>>
Returns error breakdown.

Returns Procedure<Record<string, number>>
grouped errors.
- Defined in Services/Metrics/Registry.ts:114