Skip to content

fix: interface and infinity corrections #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kvernon merged 2 commits into from
Jan 15, 2026
Merged

fix: interface and infinity corrections #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8ee0db
fix: interface and infinity corrections
kvernon Jan 15, 2026
1c158fb
docs: updated
kvernon Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_media/badge.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/account/i-user-goal/interfaces/IUserGoal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Interface: IUserGoal

Defined in: [account/i-user-goal.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-goal.ts#L1)
Defined in: [account/i-user-goal.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-goal.ts#L1)

## Extended by

Expand All @@ -18,7 +18,7 @@ Defined in: [account/i-user-goal.ts:1](https://github.com/kvernon/realty-investo

> **monthlyIncomeAmountGoal**: `number`

Defined in: [account/i-user-goal.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-goal.ts#L5)
Defined in: [account/i-user-goal.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-goal.ts#L5)

used to determine how much you need want for monthly expenses

Expand All @@ -28,7 +28,7 @@ used to determine how much you need want for monthly expenses

> **metAverageQuarterlyGoal**(`today`): `boolean`

Defined in: [account/i-user-goal.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-goal.ts#L17)
Defined in: [account/i-user-goal.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-goal.ts#L17)

takes data from a quarterly average cash flow and compares it to the monthly goal. The reason on quarterly is that apartments do distributions quarterly, so you have to spread those out monthly

Expand All @@ -48,7 +48,7 @@ takes data from a quarterly average cash flow and compares it to the monthly goa

> **metMonthlyGoal**(`today`): `boolean`

Defined in: [account/i-user-goal.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-goal.ts#L11)
Defined in: [account/i-user-goal.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-goal.ts#L11)

method used to help determine if you have met your expenses

Expand Down
24 changes: 12 additions & 12 deletions docs/account/i-user-investor-check/interfaces/IUserInvestorCheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Interface: IUserInvestorCheck

Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L9)
Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L9)

## Extends

Expand All @@ -22,7 +22,7 @@ Defined in: [account/i-user-investor-check.ts:9](https://github.com/kvernon/real

> **holdRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]

Defined in: [account/i-user-investor-check.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L23)
Defined in: [account/i-user-investor-check.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L23)

a system to determine how to hold onto the properties the longest. This scenario says as long as it meets 1 rule

Expand All @@ -32,7 +32,7 @@ a system to determine how to hold onto the properties the longest. This scenario

> `readonly` **ledgerCollection**: [`ILedgerCollection`](../../../ledger/ledger-collection/interfaces/ILedgerCollection.md)

Defined in: [account/i-user-investor-check.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L13)
Defined in: [account/i-user-investor-check.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L13)

the collection which is used to keep a balance sheet.

Expand All @@ -42,7 +42,7 @@ the collection which is used to keep a balance sheet.

> **loanSettings**: [`ILoanSetting`](../../../loans/i-loan-settings/interfaces/ILoanSetting.md)[]

Defined in: [account/i-user-investor-check.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L18)
Defined in: [account/i-user-investor-check.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L18)

a collection of loan settings for how to get a loan for single family or some other kind of property

Expand All @@ -52,7 +52,7 @@ a collection of loan settings for how to get a loan for single family or some ot

> **monthlyIncomeAmountGoal**: `number`

Defined in: [account/i-user-goal.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-goal.ts#L5)
Defined in: [account/i-user-goal.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-goal.ts#L5)

used to determine how much you need want for monthly expenses

Expand All @@ -66,7 +66,7 @@ used to determine how much you need want for monthly expenses

> **purchaseRules**: [`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]

Defined in: [account/i-user-investor-check.ts:60](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L60)
Defined in: [account/i-user-investor-check.ts:60](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L60)

a system to weed out the properties you don't want. This scenario says as long as it meets 1 rule

Expand All @@ -76,7 +76,7 @@ a system to weed out the properties you don't want. This scenario says as long a

> **getAvailableSavings**(`date`, `properties`): `number`

Defined in: [account/i-user-investor-check.ts:55](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L55)
Defined in: [account/i-user-investor-check.ts:55](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L55)

should be the total balance - savings, using [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), for determining monthly cash to save for single family properties

Expand All @@ -100,7 +100,7 @@ should be the total balance - savings, using [getMinimumSavings](IUserInvestorCh

> **getMinimumSavings**(`date`, `properties`): `number`

Defined in: [account/i-user-investor-check.ts:48](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L48)
Defined in: [account/i-user-investor-check.ts:48](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L48)

used to retrieve the amount required to keep in savings

Expand All @@ -124,7 +124,7 @@ used to retrieve the amount required to keep in savings

> **hasMinimumSavings**(`date`, `properties`): `boolean`

Defined in: [account/i-user-investor-check.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L41)
Defined in: [account/i-user-investor-check.ts:41](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L41)

a way to determine if the user has enough money. This is different because with
single family homes, you would have to save a certain amount of monthly mortgage
Expand All @@ -149,7 +149,7 @@ single family homes, you would have to save a certain amount of monthly mortgage

> **hasMoneyToInvest**(`date`, `properties`, `contribution`?): `boolean`

Defined in: [account/i-user-investor-check.ts:33](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-investor-check.ts#L33)
Defined in: [account/i-user-investor-check.ts:33](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-investor-check.ts#L33)

based upon [getMinimumSavings](IUserInvestorCheck.md#getminimumsavings), it checks to see if there is an amount remaining that can be used along with the [contribution](IUserInvestorCheck.md#contribution).

Expand Down Expand Up @@ -183,7 +183,7 @@ availableSavings - contribution >= 0;

> **metAverageQuarterlyGoal**(`today`): `boolean`

Defined in: [account/i-user-goal.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-goal.ts#L17)
Defined in: [account/i-user-goal.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-goal.ts#L17)

takes data from a quarterly average cash flow and compares it to the monthly goal. The reason on quarterly is that apartments do distributions quarterly, so you have to spread those out monthly

Expand All @@ -207,7 +207,7 @@ takes data from a quarterly average cash flow and compares it to the monthly goa

> **metMonthlyGoal**(`today`): `boolean`

Defined in: [account/i-user-goal.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/f5e81c745c9712850008b994845a2db276e2111c/src/account/i-user-goal.ts#L11)
Defined in: [account/i-user-goal.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/a8ee0dbe1cb2541838a433a27053b4875ab05305/src/account/i-user-goal.ts#L11)

method used to help determine if you have met your expenses

Expand Down
Loading