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

package/docs/investments/reason-to-rule/classes/ReasonToRule.md

@@ -1,263 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/reason-to-rule](../index.md) / ReasonToRule
-
-# Class: ReasonToRule\<T, TR\>
-
-Defined in: [investments/reason-to-rule.ts:39](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L39)
-
-## Type Parameters
-
-• **T** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-• **TR** _extends_ [`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md) \| [`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)
-
-## Implements
-
-- [`IReasonToRule`](../interfaces/IReasonToRule.md)\<`T`, `TR`\>
-
-## Constructors
-
-### new ReasonToRule()
-
-> **new ReasonToRule**\<`T`, `TR`\>(`investmentReason`, `propertyType`, `propertyKey`, `value`, `ruleType`?, `overrideUserResultEstimates`?): [`ReasonToRule`](ReasonToRule.md)\<`T`, `TR`\>
-
-Defined in: [investments/reason-to-rule.ts:44](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L44)
-
-#### Parameters
-
-##### investmentReason
-
-[`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-##### propertyType
-
-[`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
-
-##### propertyKey
-
-keyof `T` & `string`
-
-##### value
-
-`number`[]
-
-##### ruleType?
-
-`TR`
-
-##### overrideUserResultEstimates?
-
-[`UserResultEstimates`](../../user-result-estimates/type-aliases/UserResultEstimates.md)
-
-#### Returns
-
-[`ReasonToRule`](ReasonToRule.md)\<`T`, `TR`\>
-
-## Properties
-
-### investmentReason
-
-> **investmentReason**: [`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-Defined in: [investments/reason-to-rule.ts:84](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L84)
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`investmentReason`](../interfaces/IReasonToRule.md#investmentreason)
-
----
-
-### propertyKey
-
-> **propertyKey**: keyof `T` & `string`
-
-Defined in: [investments/reason-to-rule.ts:129](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L129)
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`propertyKey`](../interfaces/IReasonToRule.md#propertykey)
-
----
-
-### propertyType
-
-> **propertyType**: [`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
-
-Defined in: [investments/reason-to-rule.ts:130](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L130)
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`propertyType`](../interfaces/IReasonToRule.md#propertytype-2)
-
----
-
-### ruleType
-
-> **ruleType**: `TR`
-
-Defined in: [investments/reason-to-rule.ts:131](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L131)
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`ruleType`](../interfaces/IReasonToRule.md#ruletype-4)
-
----
-
-### values
-
-> **values**: `number`[]
-
-Defined in: [investments/reason-to-rule.ts:132](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L132)
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`values`](../interfaces/IReasonToRule.md#values)
-
-## Methods
-
-### getValueAtIndex()
-
-> **getValueAtIndex**(`index`): `number`
-
-Defined in: [investments/reason-to-rule.ts:98](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L98)
-
-#### Parameters
-
-##### index
-
-`number`
-
-#### Returns
-
-`number`
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`getValueAtIndex`](../interfaces/IReasonToRule.md#getvalueatindex)
-
----
-
-### isRuleAndPropertyTypeMatch()
-
-> **isRuleAndPropertyTypeMatch**(`propertyType`, `ruleType`): `boolean`
-
-Defined in: [investments/reason-to-rule.ts:86](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L86)
-
-#### Parameters
-
-##### propertyType
-
-[`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
-
-##### ruleType
-
-`TR`
-
-#### Returns
-
-`boolean`
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`isRuleAndPropertyTypeMatch`](../interfaces/IReasonToRule.md#isruleandpropertytypematch)
-
----
-
-### isRuleMatch()
-
-> **isRuleMatch**(`ruleType`): `boolean`
-
-Defined in: [investments/reason-to-rule.ts:90](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L90)
-
-#### Parameters
-
-##### ruleType
-
-`TR`
-
-#### Returns
-
-`boolean`
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`isRuleMatch`](../interfaces/IReasonToRule.md#isrulematch)
-
----
-
-### isRuleNone()
-
-> **isRuleNone**(): `boolean`
-
-Defined in: [investments/reason-to-rule.ts:94](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L94)
-
-#### Returns
-
-`boolean`
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`isRuleNone`](../interfaces/IReasonToRule.md#isrulenone)
-
----
-
-### isValueGreater()
-
-> **isValueGreater**\<`T2`\>(`rule`): `boolean`
-
-Defined in: [investments/reason-to-rule.ts:60](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L60)
-
-#### Type Parameters
-
-• **T2** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-#### Parameters
-
-##### rule
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md)\<`T2`, `TR`\>
-
-#### Returns
-
-`boolean`
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`isValueGreater`](../interfaces/IReasonToRule.md#isvaluegreater)
-
----
-
-### userResultEstimates()
-
-> **userResultEstimates**(`rental`, `holdRules`, `purchaseRules`, `date`): [`UserInvestResult`](../../user-invest-result/classes/UserInvestResult.md)[]
-
-Defined in: [investments/reason-to-rule.ts:106](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L106)
-
-#### Parameters
-
-##### rental
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-##### holdRules
-
-[`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]
-
-##### purchaseRules
-
-[`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
-
-##### date
-
-`Date`
-
-#### Returns
-
-[`UserInvestResult`](../../user-invest-result/classes/UserInvestResult.md)[]
-
-#### Implementation of
-
-[`IReasonToRule`](../interfaces/IReasonToRule.md).[`userResultEstimates`](../interfaces/IReasonToRule.md#userresultestimates)

package/docs/investments/reason-to-rule/index.md

@@ -1,16 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / investments/reason-to-rule
-
-# investments/reason-to-rule
-
-## Classes
-
-- [ReasonToRule](classes/ReasonToRule.md)
-
-## Interfaces
-
-- [IReasonToRule](interfaces/IReasonToRule.md)
-- [IReasonToRuleMeta](interfaces/IReasonToRuleMeta.md)

package/docs/investments/reason-to-rule/interfaces/IReasonToRule.md

@@ -1,189 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/reason-to-rule](../index.md) / IReasonToRule
-
-# Interface: IReasonToRule\<T, TR\>
-
-Defined in: [investments/reason-to-rule.ts:15](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L15)
-
-## Extends
-
-- [`IReasonToRuleMeta`](IReasonToRuleMeta.md)\<`TR`\>
-
-## Type Parameters
-
-• **T** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-• **TR** _extends_ [`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md) \| [`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)
-
-## Properties
-
-### investmentReason
-
-> **investmentReason**: [`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-Defined in: [investments/reason-to-rule.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L11)
-
-#### Inherited from
-
-[`IReasonToRuleMeta`](IReasonToRuleMeta.md).[`investmentReason`](IReasonToRuleMeta.md#investmentreason)
-
----
-
-### isRuleAndPropertyTypeMatch()
-
-> **isRuleAndPropertyTypeMatch**: (`propertyType`, `ruleType`) => `boolean`
-
-Defined in: [investments/reason-to-rule.ts:21](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L21)
-
-#### Parameters
-
-##### propertyType
-
-[`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
-
-##### ruleType
-
-`TR`
-
-#### Returns
-
-`boolean`
-
----
-
-### isRuleMatch()
-
-> **isRuleMatch**: (`ruleType`) => `boolean`
-
-Defined in: [investments/reason-to-rule.ts:23](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L23)
-
-#### Parameters
-
-##### ruleType
-
-`TR`
-
-#### Returns
-
-`boolean`
-
----
-
-### propertyKey
-
-> **propertyKey**: keyof `T` & `string`
-
-Defined in: [investments/reason-to-rule.ts:18](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L18)
-
----
-
-### propertyType
-
-> **propertyType**: [`PropertyType`](../../../properties/property-type/enumerations/PropertyType.md)
-
-Defined in: [investments/reason-to-rule.ts:17](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L17)
-
----
-
-### ruleType?
-
-> `optional` **ruleType**: `TR`
-
-Defined in: [investments/reason-to-rule.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L12)
-
-#### Inherited from
-
-[`IReasonToRuleMeta`](IReasonToRuleMeta.md).[`ruleType`](IReasonToRuleMeta.md#ruletype)
-
----
-
-### values
-
-> **values**: `number`[]
-
-Defined in: [investments/reason-to-rule.ts:19](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L19)
-
-## Methods
-
-### getValueAtIndex()
-
-> **getValueAtIndex**(`index`): `number`
-
-Defined in: [investments/reason-to-rule.ts:27](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L27)
-
-#### Parameters
-
-##### index
-
-`number`
-
-#### Returns
-
-`number`
-
----
-
-### isRuleNone()
-
-> **isRuleNone**(): `boolean`
-
-Defined in: [investments/reason-to-rule.ts:25](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L25)
-
-#### Returns
-
-`boolean`
-
----
-
-### isValueGreater()
-
-> **isValueGreater**\<`T2`\>(`rule`): `boolean`
-
-Defined in: [investments/reason-to-rule.ts:29](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L29)
-
-#### Type Parameters
-
-• **T2** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-#### Parameters
-
-##### rule
-
-[`IReasonToRule`](IReasonToRule.md)\<`T2`, `TR`\>
-
-#### Returns
-
-`boolean`
-
----
-
-### userResultEstimates()
-
-> **userResultEstimates**(`rental`, `holdRules`, `purchaseRules`, `date`): [`UserInvestResult`](../../user-invest-result/classes/UserInvestResult.md)[]
-
-Defined in: [investments/reason-to-rule.ts:31](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L31)
-
-#### Parameters
-
-##### rental
-
-[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-##### holdRules
-
-[`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)\>[]
-
-##### purchaseRules
-
-[`IRuleEvaluation`](../../../rules/rule-evaluation/interfaces/IRuleEvaluation.md)\<[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
-
-##### date
-
-`Date`
-
-#### Returns
-
-[`UserInvestResult`](../../user-invest-result/classes/UserInvestResult.md)[]

package/docs/investments/reason-to-rule/interfaces/IReasonToRuleMeta.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/reason-to-rule](../index.md) / IReasonToRuleMeta
-
-# Interface: IReasonToRuleMeta\<TR\>
-
-Defined in: [investments/reason-to-rule.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L10)
-
-## Extended by
-
-- [`IReasonToRule`](IReasonToRule.md)
-
-## Type Parameters
-
-• **TR** _extends_ [`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md) \| [`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)
-
-## Properties
-
-### investmentReason
-
-> **investmentReason**: [`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-Defined in: [investments/reason-to-rule.ts:11](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L11)
-
----
-
-### ruleType?
-
-> `optional` **ruleType**: `TR`
-
-Defined in: [investments/reason-to-rule.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/reason-to-rule.ts#L12)

package/docs/investments/rental-investor-validator/classes/RentalInvestorValidator.md

@@ -1,53 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/rental-investor-validator](../index.md) / RentalInvestorValidator
-
-# Class: RentalInvestorValidator
-
-Defined in: [investments/rental-investor-validator.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/rental-investor-validator.ts#L8)
-
-## Implements
-
-- [`IRentalInvestorValidator`](../interfaces/IRentalInvestorValidator.md)
-
-## Constructors
-
-### new RentalInvestorValidator()
-
-> **new RentalInvestorValidator**(): [`RentalInvestorValidator`](RentalInvestorValidator.md)
-
-#### Returns
-
-[`RentalInvestorValidator`](RentalInvestorValidator.md)
-
-## Properties
-
-### results
-
-> **results**: [`IUserInvestResult`](../../user-invest-result/interfaces/IUserInvestResult.md)[] = `[]`
-
-Defined in: [investments/rental-investor-validator.ts:13](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/rental-investor-validator.ts#L13)
-
-#### Implementation of
-
-[`IRentalInvestorValidator`](../interfaces/IRentalInvestorValidator.md).[`results`](../interfaces/IRentalInvestorValidator.md#results)
-
-## Accessors
-
-### canInvest
-
-#### Get Signature
-
-> **get** **canInvest**(): `boolean`
-
-Defined in: [investments/rental-investor-validator.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/rental-investor-validator.ts#L9)
-
-##### Returns
-
-`boolean`
-
-#### Implementation of
-
-[`IRentalInvestorValidator`](../interfaces/IRentalInvestorValidator.md).[`canInvest`](../interfaces/IRentalInvestorValidator.md#caninvest)

package/docs/investments/rental-investor-validator/index.md

@@ -1,15 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / investments/rental-investor-validator
-
-# investments/rental-investor-validator
-
-## Classes
-
-- [RentalInvestorValidator](classes/RentalInvestorValidator.md)
-
-## Interfaces
-
-- [IRentalInvestorValidator](interfaces/IRentalInvestorValidator.md)

package/docs/investments/rental-investor-validator/interfaces/IRentalInvestorValidator.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/rental-investor-validator](../index.md) / IRentalInvestorValidator
-
-# Interface: IRentalInvestorValidator
-
-Defined in: [investments/rental-investor-validator.ts:3](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/rental-investor-validator.ts#L3)
-
-## Properties
-
-### canInvest
-
-> `readonly` **canInvest**: `boolean`
-
-Defined in: [investments/rental-investor-validator.ts:4](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/rental-investor-validator.ts#L4)
-
----
-
-### results
-
-> **results**: [`IUserInvestResult`](../../user-invest-result/interfaces/IUserInvestResult.md)[]
-
-Defined in: [investments/rental-investor-validator.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/rental-investor-validator.ts#L5)

package/docs/investments/user-invest-result/classes/UserInvestResult.md

@@ -1,65 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/user-invest-result](../index.md) / UserInvestResult
-
-# Class: UserInvestResult
-
-Defined in: [investments/user-invest-result.ts:8](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-invest-result.ts#L8)
-
-## Implements
-
-- [`IUserInvestResult`](../interfaces/IUserInvestResult.md)
-
-## Constructors
-
-### new UserInvestResult()
-
-> **new UserInvestResult**(`reason`, `message`): [`UserInvestResult`](UserInvestResult.md)
-
-Defined in: [investments/user-invest-result.ts:16](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-invest-result.ts#L16)
-
-#### Parameters
-
-##### reason
-
-[`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md) = `InvestmentReasons.Unknown`
-
-##### message
-
-`string` = `''`
-
-#### Returns
-
-[`UserInvestResult`](UserInvestResult.md)
-
-## Properties
-
-### investmentReason
-
-> **investmentReason**: [`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-Defined in: [investments/user-invest-result.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-invest-result.ts#L14)
-
-#### Implementation of
-
-[`IUserInvestResult`](../interfaces/IUserInvestResult.md).[`investmentReason`](../interfaces/IUserInvestResult.md#investmentreason)
-
-## Accessors
-
-### message
-
-#### Get Signature
-
-> **get** **message**(): `string`
-
-Defined in: [investments/user-invest-result.ts:9](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/user-invest-result.ts#L9)
-
-##### Returns
-
-`string`
-
-#### Implementation of
-
-[`IUserInvestResult`](../interfaces/IUserInvestResult.md).[`message`](../interfaces/IUserInvestResult.md#message)

package/docs/investments/user-invest-result/index.md

@@ -1,15 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / investments/user-invest-result
-
-# investments/user-invest-result
-
-## Classes
-
-- [UserInvestResult](classes/UserInvestResult.md)
-
-## Interfaces
-
-- [IUserInvestResult](interfaces/IUserInvestResult.md)