@cubedelement.com/realty-investor-timeline 5.5.1 → 5.6.0

package/docs/time/has-met-goal-or-max-time/type-aliases/HasMetGoalOrMaxTime.md

@@ -1,39 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/has-met-goal-or-max-time](../index.md) / HasMetGoalOrMaxTime
-
-# Type Alias: HasMetGoalOrMaxTime()
-
-> **HasMetGoalOrMaxTime**: (`start`, `today`, `user`, `rentals`, `maxYears`) => `boolean`
-
-Defined in: [time/has-met-goal-or-max-time.ts:7](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/has-met-goal-or-max-time.ts#L7)
-
-a way to determine if the loop should end based on the user's rules
-
-## Parameters
-
-### start
-
-`Date`
-
-### today
-
-`Date`
-
-### user
-
-[`IUser`](../../../account/user/interfaces/IUser.md)
-
-### rentals
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)[]
-
-### maxYears
-
-`number`
-
-## Returns
-
-`boolean`

package/docs/time/i-historical-property/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/i-historical-property
-
-# time/i-historical-property
-
-## Interfaces
-
-- [IHistoricalProperty](interfaces/IHistoricalProperty.md)

package/docs/time/i-historical-property/interfaces/IHistoricalProperty.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/i-historical-property](../index.md) / IHistoricalProperty
-
-# Interface: IHistoricalProperty
-
-Defined in: [time/i-historical-property.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-historical-property.ts#L4)
-
-## Properties
-
-### property
-
-> **property**: [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-Defined in: [time/i-historical-property.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-historical-property.ts#L5)
-
----
-
-### reasons
-
-> **reasons**: [`IHistoricalReason`](../../i-historical-reason/interfaces/IHistoricalReason.md)[]
-
-Defined in: [time/i-historical-property.ts:6](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-historical-property.ts#L6)

package/docs/time/i-historical-reason/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/i-historical-reason
-
-# time/i-historical-reason
-
-## Interfaces
-
-- [IHistoricalReason](interfaces/IHistoricalReason.md)

package/docs/time/i-historical-reason/interfaces/IHistoricalReason.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/i-historical-reason](../index.md) / IHistoricalReason
-
-# Interface: IHistoricalReason
-
-Defined in: [time/i-historical-reason.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-historical-reason.ts#L1)
-
-## Properties
-
-### date
-
-> **date**: `Date`
-
-Defined in: [time/i-historical-reason.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-historical-reason.ts#L3)
-
----
-
-### reason
-
-> **reason**: `string`
-
-Defined in: [time/i-historical-reason.ts:2](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-historical-reason.ts#L2)

package/docs/time/i-loop-options/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/i-loop-options
-
-# time/i-loop-options
-
-## Interfaces
-
-- [ILoopOptions](interfaces/ILoopOptions.md)

package/docs/time/i-loop-options/interfaces/ILoopOptions.md

@@ -1,71 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/i-loop-options](../index.md) / ILoopOptions
-
-# Interface: ILoopOptions
-
-Defined in: [time/i-loop-options.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-options.ts#L4)
-
-## Extends
-
-- [`ILoopRecursiveOptions`](../../i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md)
-
-## Properties
-
-### hasMetGoalOrMaxTime?
-
-> `optional` **hasMetGoalOrMaxTime**: [`HasMetGoalOrMaxTime`](../../has-met-goal-or-max-time/type-aliases/HasMetGoalOrMaxTime.md)
-
-Defined in: [time/i-loop-options.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-options.ts#L18)
-
-This is how the system knows when to quit. If no value is supplied, it will use `defaultHasMetGoalOrMaxTime`.
-
----
-
-### maxYears?
-
-> `optional` **maxYears**: `number`
-
-Defined in: [time/i-loop-options.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-options.ts#L13)
-
-how long should this run in years? A common number is 25 to 30 years before giving up.
-
----
-
-### propertyGeneratorPassiveApartment?
-
-> `optional` **propertyGeneratorPassiveApartment**: [`IRentalGenerator`](../../../generators/rental-generator/interfaces/IRentalGenerator.md)\<[`RentalPassiveApartment`](../../../properties/rental-passive-apartment/classes/RentalPassiveApartment.md)\>
-
-Defined in: [time/i-loop-recursive-options.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-recursive-options.ts#L14)
-
-How the system generates passive apartment properties
-
-#### Inherited from
-
-[`ILoopRecursiveOptions`](../../i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md).[`propertyGeneratorPassiveApartment`](../../i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md#propertygeneratorpassiveapartment)
-
----
-
-### propertyGeneratorSingleFamily?
-
-> `optional` **propertyGeneratorSingleFamily**: [`IRentalGenerator`](../../../generators/rental-generator/interfaces/IRentalGenerator.md)\<[`RentalSingleFamily`](../../../properties/rental-single-family/classes/RentalSingleFamily.md)\>
-
-Defined in: [time/i-loop-recursive-options.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-recursive-options.ts#L9)
-
-How the system generates single family properties
-
-#### Inherited from
-
-[`ILoopRecursiveOptions`](../../i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md).[`propertyGeneratorSingleFamily`](../../i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md#propertygeneratorsinglefamily)
-
----
-
-### startDate?
-
-> `optional` **startDate**: `Date`
-
-Defined in: [time/i-loop-options.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-options.ts#L8)
-
-when does this start?

package/docs/time/i-loop-recursive-options/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/i-loop-recursive-options
-
-# time/i-loop-recursive-options
-
-## Interfaces
-
-- [ILoopRecursiveOptions](interfaces/ILoopRecursiveOptions.md)

package/docs/time/i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/i-loop-recursive-options](../index.md) / ILoopRecursiveOptions
-
-# Interface: ILoopRecursiveOptions
-
-Defined in: [time/i-loop-recursive-options.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-recursive-options.ts#L5)
-
-## Extended by
-
-- [`ILoopOptions`](../../i-loop-options/interfaces/ILoopOptions.md)
-
-## Properties
-
-### propertyGeneratorPassiveApartment?
-
-> `optional` **propertyGeneratorPassiveApartment**: [`IRentalGenerator`](../../../generators/rental-generator/interfaces/IRentalGenerator.md)\<[`RentalPassiveApartment`](../../../properties/rental-passive-apartment/classes/RentalPassiveApartment.md)\>
-
-Defined in: [time/i-loop-recursive-options.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-recursive-options.ts#L14)
-
-How the system generates passive apartment properties
-
----
-
-### propertyGeneratorSingleFamily?
-
-> `optional` **propertyGeneratorSingleFamily**: [`IRentalGenerator`](../../../generators/rental-generator/interfaces/IRentalGenerator.md)\<[`RentalSingleFamily`](../../../properties/rental-single-family/classes/RentalSingleFamily.md)\>
-
-Defined in: [time/i-loop-recursive-options.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/i-loop-recursive-options.ts#L9)
-
-How the system generates single family properties

package/docs/time/index.md

@@ -1,85 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../modules.md) / time
-
-# time
-
-## References
-
-### defaultHasMetGoalOrMaxTime
-
-Re-exports [defaultHasMetGoalOrMaxTime](default-has-met-goal-or-max-time/functions/defaultHasMetGoalOrMaxTime.md)
-
----
-
-### HasMetGoalOrMaxTime
-
-Re-exports [HasMetGoalOrMaxTime](has-met-goal-or-max-time/type-aliases/HasMetGoalOrMaxTime.md)
-
----
-
-### IGenOptions
-
-Re-exports [IGenOptions](simulate/interfaces/IGenOptions.md)
-
----
-
-### IHistoricalProperty
-
-Re-exports [IHistoricalProperty](i-historical-property/interfaces/IHistoricalProperty.md)
-
----
-
-### IHistoricalReason
-
-Re-exports [IHistoricalReason](i-historical-reason/interfaces/IHistoricalReason.md)
-
----
-
-### ILoopOptions
-
-Re-exports [ILoopOptions](i-loop-options/interfaces/ILoopOptions.md)
-
----
-
-### ILoopRecursiveOptions
-
-Re-exports [ILoopRecursiveOptions](i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md)
-
----
-
-### ISimulateOptions
-
-Re-exports [ISimulateOptions](simulate/interfaces/ISimulateOptions.md)
-
----
-
-### ITimeline
-
-Re-exports [ITimeline](timeline/interfaces/ITimeline.md)
-
----
-
-### movement
-
-Re-exports [movement](movement/functions/movement.md)
-
----
-
-### simulate
-
-Re-exports [simulate](simulate/functions/simulate.md)
-
----
-
-### Timeline
-
-Re-exports [Timeline](timeline/classes/Timeline.md)
-
----
-
-### updateHistoricalRentals
-
-Re-exports [updateHistoricalRentals](update-historical-rentals/functions/updateHistoricalRentals.md)

package/docs/time/looper/functions/looper.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/looper](../index.md) / looper
-
-# Function: looper()
-
-> **looper**(`options`, `timeline`): [`ITimeline`](../../timeline/interfaces/ITimeline.md)
-
-Defined in: [time/looper.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/looper.ts#L14)
-
-## Parameters
-
-### options
-
-[`ILoopRecursiveOptions`](../../i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md)
-
-### timeline
-
-[`ITimeline`](../../timeline/interfaces/ITimeline.md)
-
-## Returns
-
-[`ITimeline`](../../timeline/interfaces/ITimeline.md)

package/docs/time/looper/index.md

@@ -1,15 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/looper
-
-# time/looper
-
-## Type Aliases
-
-- [LooperType](type-aliases/LooperType.md)
-
-## Functions
-
-- [looper](functions/looper.md)

package/docs/time/looper/type-aliases/LooperType.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/looper](../index.md) / LooperType
-
-# Type Alias: LooperType()
-
-> **LooperType**: (`options`, `timeline`) => [`ITimeline`](../../timeline/interfaces/ITimeline.md)
-
-Defined in: [time/looper.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/looper.ts#L12)
-
-## Parameters
-
-### options
-
-[`ILoopRecursiveOptions`](../../i-loop-recursive-options/interfaces/ILoopRecursiveOptions.md)
-
-### timeline
-
-[`ITimeline`](../../timeline/interfaces/ITimeline.md)
-
-## Returns
-
-[`ITimeline`](../../timeline/interfaces/ITimeline.md)

package/docs/time/movement/functions/movement.md

@@ -1,27 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/movement](../index.md) / movement
-
-# Function: movement()
-
-> **movement**(`options`, `user`): [`ITimeline`](../../timeline/interfaces/ITimeline.md)
-
-Defined in: [time/movement.ts:19](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/movement.ts#L19)
-
-This is where the magic happens. You provide the options, and you let this calculate the rest.
-
-## Parameters
-
-### options
-
-[`ILoopOptions`](../../i-loop-options/interfaces/ILoopOptions.md)
-
-### user
-
-[`IUser`](../../../account/user/interfaces/IUser.md)
-
-## Returns
-
-[`ITimeline`](../../timeline/interfaces/ITimeline.md)

package/docs/time/movement/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/movement
-
-# time/movement
-
-## Functions
-
-- [movement](functions/movement.md)

package/docs/time/simulate/functions/simulate.md

@@ -1,23 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/simulate](../index.md) / simulate
-
-# Function: simulate()
-
-> **simulate**(`options`): [`ITimeline`](../../timeline/interfaces/ITimeline.md)
-
-Defined in: [time/simulate.ts:82](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L82)
-
-Easy entry method to get anyone going on simulating a property, or properties acquisition.
-
-## Parameters
-
-### options
-
-[`ISimulateOptions`](../interfaces/ISimulateOptions.md) = `...`
-
-## Returns
-
-[`ITimeline`](../../timeline/interfaces/ITimeline.md)

package/docs/time/simulate/index.md

@@ -1,16 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / time/simulate
-
-# time/simulate
-
-## Interfaces
-
-- [IGenOptions](interfaces/IGenOptions.md)
-- [ISimulateOptions](interfaces/ISimulateOptions.md)
-
-## Functions
-
-- [simulate](functions/simulate.md)

package/docs/time/simulate/interfaces/IGenOptions.md

@@ -1,163 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [time/simulate](../index.md) / IGenOptions
-
-# Interface: IGenOptions
-
-Defined in: [time/simulate.ts:20](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L20)
-
-## Extends
-
-- [`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md)
-
-## Properties
-
-### highestCashFlow
-
-> **highestCashFlow**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:40](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L40)
-
-I've seen as high as 630 a month, but on average, depending on the area, I've seen 450 a month
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`highestCashFlow`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#highestcashflow)
-
----
-
-### highestEquityCapturePercent
-
-> **highestEquityCapturePercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:20](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L20)
-
-used to generate a random equity amount, this is the high value
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`highestEquityCapturePercent`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#highestequitycapturepercent)
-
----
-
-### highestMinSellInYears
-
-> **highestMinSellInYears**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:50](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L50)
-
-For Texas, you should hold for 1 year for the lowest tax rate, but you might want to hold it longer
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`highestMinSellInYears`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#highestminsellinyears)
-
----
-
-### highestPurchasePrice
-
-> **highestPurchasePrice**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L10)
-
-used to generate a random price amount, this is the high value
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`highestPurchasePrice`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#highestpurchaseprice)
-
----
-
-### highestSellAppreciationPercent
-
-> **highestSellAppreciationPercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:30](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L30)
-
-for single family it is as high as 14.5 %
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`highestSellAppreciationPercent`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#highestsellappreciationpercent)
-
----
-
-### lowestCashFlow
-
-> **lowestCashFlow**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:35](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L35)
-
-typically 200 is the lowest
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`lowestCashFlow`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#lowestcashflow)
-
----
-
-### lowestEquityCapturePercent
-
-> **lowestEquityCapturePercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:15](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L15)
-
-used to generate a random equity amount, this is the low value
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`lowestEquityCapturePercent`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#lowestequitycapturepercent)
-
----
-
-### lowestMinSellInYears
-
-> **lowestMinSellInYears**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:45](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L45)
-
-For Texas, you should hold for 1 year for the lowest tax rate, but you might want to hold it longer
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`lowestMinSellInYears`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#lowestminsellinyears)
-
----
-
-### lowestPurchasePrice
-
-> **lowestPurchasePrice**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L5)
-
-used to generate a random price amount, this is the low value
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`lowestPurchasePrice`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#lowestpurchaseprice)
-
----
-
-### lowestSellAppreciationPercent
-
-> **lowestSellAppreciationPercent**: `number`
-
-Defined in: [generators/i-property-entity-options.ts:25](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/generators/i-property-entity-options.ts#L25)
-
-for single family it's around 4%
-
-#### Inherited from
-
-[`IPropertyEntityOptions`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md).[`lowestSellAppreciationPercent`](../../../generators/i-property-entity-options/interfaces/IPropertyEntityOptions.md#lowestsellappreciationpercent)
-
----
-
-### maxRentalOpportunities
-
-> **maxRentalOpportunities**: `number`
-
-Defined in: [time/simulate.ts:24](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/time/simulate.ts#L24)
-
-Used to provide an amount of Random properties