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

package/docs/index.md

@@ -1,258 +0,0 @@
-**@cubedelement.com/realty-investor-timeline**
-
----
-
-# realty-investor-timeline
-
-[![CircleCI](https://circleci.com/gh/kvernon/realty-investor-timeline.svg?style=shield)](https://circleci.com/gh/kvernon/realty-investor-timeline)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![Wallaby.js](https://img.shields.io/badge/wallaby.js-configured-green.svg)](https://wallabyjs.com)
-![](_media/badge.svg)
-
-A way to determine if and when your expenses would be covered through rental properties
-
-Will be based on version 1
-
-1. https://bitbucket.org/kellyvernon/realty-generator-core (a private repo by me).
-2. version 1 live: http://cubedelement.com/realty/
-
-> Note: this above is buggy. I was racing to get the pieces together.
-
-> Note 2: this is the new version, which isn't live
-
-## Inspiration
-
-This was originally used as a discussion point between me and my SO. The idea is that we like our jobs, but we also want
-a way to ensure that if anything happens to us, we would be able to sustain our income.
-
-For me, I was inspired by a game originally from early 2000's where you could quickly click on houses and flip them, but
-after this idea and speaking with mentors, the idea has become find an optimal way to _ramp-up_.
-
-> ☝️Mentors are great! They do a great job at helping you discover how to get to the next point in your life. Also, a
-> mentor is someone who has done the thing and is either where you've been or want to go. AKA, don't ask a someone how
-> to become a CEO when that person has never been a CEO. (Hopefully that give you a good idea)
-
-## What this does
-
-As mentioned prior, we want to find a way to _ramp-up_. This library will work through the scenarios of houses and
-provide a way to collect them. Once it completes, it'll provide feedback as to why you passed on a property.
-
-For example, it could be that you didn't have enough cash. Another is that you may have wanted more cash flow per month.
-After you see the trends, and based on the time-line hand at play, you could realize that you might need to expand on
-your ideal finds.
-
-The library loop simulates a per-month savings. In there it will take your money saved and determine if you have enough
-to acquire more properties. Equally, we run through selling of properties too, because it's a common practice.
-
-## Building
-
-### Node version
-
-On linux, mac, etc... do: `$ nvm install`, referencing this manager: `https://github.com/nvm-sh/nvm`
-
-on windows: `$ nvs install`, referencing this manager: `https://github.com/jasongin/nvs`
-
-### Getting the Repo up and running
-
-#### Install libs
-
-`$ npm ci`
-
-#### Run tests
-
-`$ npm run tests`
-
-> ☝️This can run using Wallaby.js in automatic config, or you can use the config supplied here
-
-### CI/CD (Delivery)
-
-This project _sports_ a non gitflow workflow.
-
-#### Branches
-
-`main` and `feature/*`
-
-#### The (CI/CD) Flow
-
-Once a feature's PR is merged, the pipeline will run checks and publish.
-
-## Single family homes
-
-### Features
-
-- Mortgage calc (Single Family) ✔
-- Rent amount ✔
-- Cash flow ✔
-- Appreciation calculation ✔
-- Equity (simple) ✔
-- Monthly summaries ✔
-- Annual summaries ✔
-
-### Needed things (in no order)
-
-- TODO: Hard Money Loan calc ✋
-  - What would the transition look like in code?
-- TODO: Cash flow ramp (0 - 3 months depending on rehab, conventional, or existing tenant)
-  - Transition would be around Hard Money vs Conventional
-
-## Missing features
-
-1. delay 1st mortgage payment
-2. refactor loop
-
-## Future
-
-- Refine the build process to remove /dist/src from library drill down
-
-## calling
-
-As this is still in progress, the current flow is as follows:
-
-```typescript
-import {
-  HasMetGoalOrMaxTime,
-  ISimulateOptions,
-  LedgerCollection,
-  LoanSettings,
-  HoldRuleTypes,
-  PropertyType,
-  RentalGenerator,
-  RentalSingleFamily,
-  RuleEvaluation,
-  PurchaseRuleTypes,
-  ValueCache,
-  User,
-  simulate,
-} from "@cubedelement.com/realty-investor-timeline";
-
-/**
- * Callout!
- * This example shows you all the options available, and most are defaulted if you don't supply the options object.
- * This only one that isn't supplied is the generatorOptionsPassiveApartment values.
- */
-const options: ISimulateOptions = {
-  amountInSavings: 100000,
-  monthlyIncomeAmountGoal: 10000,
-  monthlySavedAmount: 10000,
-  holdRules: [
-    {
-      value: 5,
-      type: HoldRuleTypes.MinSellIfHighEquityPercent,
-      propertyType: PropertyType.SingleFamily,
-    },
-  ],
-  purchaseRules: [
-    {
-      value: 50000,
-      type: PurchaseRuleTypes.MaxEstimatedOutOfPocket,
-      propertyType: PropertyType.SingleFamily,
-    },
-    {
-      value: 7000,
-      type: PurchaseRuleTypes.MinEstimatedCapitalGainsPercent,
-      propertyType: PropertyType.SingleFamily,
-    },
-    {
-      value: 200,
-      type: PurchaseRuleTypes.MinEstimatedAnnualCashFlow,
-      propertyType: PropertyType.SingleFamily,
-    },
-  ],
-  loanSettings: [
-    {
-      propertyType: PropertyType.SingleFamily,
-      name: LoanSettings.MinimumMonthlyReservesForRental,
-      value: 6,
-    },
-    {
-      name: LoanSettings.LoanRatePercent,
-      value: 4,
-      propertyType: PropertyType.SingleFamily,
-    },
-    {
-      name: LoanSettings.LoanTermInYears,
-      value: 30,
-      propertyType: PropertyType.SingleFamily,
-    },
-  ],
-  maxYears: 7,
-  generatorOptionsSingleFamily: {
-    lowestMinSellInYears: 1,
-    highestMinSellInYears: 1,
-    lowestPurchasePrice: 150000,
-    highestPurchasePrice: 250000,
-    lowestSellAppreciationPercent: 5,
-    highestSellAppreciationPercent: 7,
-    lowestCashFlow: 200,
-    highestCashFlow: 550,
-    lowestEquityCapturePercent: 7,
-    highestEquityCapturePercent: 15,
-    maxRentalOpportunities: 4,
-  },
-  generatorOptionsPassiveApartment: {
-    lowestMinSellInYears: 1,
-    highestMinSellInYears: 1,
-    lowestPurchasePrice: 150000,
-    highestPurchasePrice: 200000,
-    lowestSellAppreciationPercent: 5,
-    highestSellAppreciationPercent: 7,
-    lowestCashFlow: 200,
-    highestCashFlow: 500,
-    lowestEquityCapturePercent: 7,
-    highestEquityCapturePercent: 15,
-    maxRentalOpportunities: 6,
-  },
-};
-
-const timeline = simulate(options);
-
-//Finally, to review your results, you can use the ledgerCollection's getSummariesAnnual.
-const lastYear = timeline.user.ledgerCollection.getSummariesAnnual(
-  timeline.endDate.getUTCFullYear()
-);
-```
-
-The example result object models:
-`Timeline`:
-
-```JSON
-{
-  "startDate": "2021-11-01T00:00:00.000Z",
-  "endDate": "2022-11-01T00:00:00.000Z",
-  "rentals": [
-    {
-      "property": {
-        "sellPriceAppreciationPercent": 6,
-        "minSellYears": 1,
-        "id": "7674c1ec-2fb6-4828-9490-271e9ab4a3c4",
-        "purchasePrice": 162373,
-        "address": "1791 Wama Extension",
-        "monthlyCashFlow": 237,
-        "availableStartDate": "2021-12-01T00:00:00.000Z",
-        "availableEndDate": "2022-02-01T00:00:00.000Z",
-        "cashDownPercent": 25,
-        "monthlyPrincipalInterestTaxInterest": 949.57,
-        "_purchaseDate": "2022-01-01T06:00:00.000Z",
-        "_soldDate": "2022-02-01T06:00:00.000Z"
-      },
-      "reasons": []
-    }
-  ],
-  "user": {
-    "ledgerCollection": {
-      "collection": {
-        "source": [
-          {
-            "amount": 119603.25,
-            "type": "Equity Capture",
-            "created": "2022-11-01T00:00:00.000Z",
-            "note": "for: 1791 Wama Extension, id: 7674c1ec-2fb6-4828-9490-271e9ab4a3c4"
-          }
-        ]
-      }
-    }
-  }
-}
-```
-
-In it you can get an estimate monthly cash flow by calling `const estimated = timeline.getEstimatedMonthlyCashFlow();`

package/docs/investments/index.md

@@ -1,85 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../modules.md) / investments
-
-# investments
-
-## References
-
-### getInvestmentReasons
-
-Re-exports [getInvestmentReasons](investment-reasons-decorator/functions/getInvestmentReasons.md)
-
----
-
-### getInvestmentReasonsForPurchaseTypes
-
-Re-exports [getInvestmentReasonsForPurchaseTypes](investment-reasons-decorator/functions/getInvestmentReasonsForPurchaseTypes.md)
-
----
-
-### InvestmentReasonForHoldRuleTypes
-
-Re-exports [InvestmentReasonForHoldRuleTypes](investment-reasons-decorator/functions/InvestmentReasonForHoldRuleTypes.md)
-
----
-
-### InvestmentReasonForPurchaseRuleTypes
-
-Re-exports [InvestmentReasonForPurchaseRuleTypes](investment-reasons-decorator/functions/InvestmentReasonForPurchaseRuleTypes.md)
-
----
-
-### InvestmentReasons
-
-Re-exports [InvestmentReasons](investment-reasons/enumerations/InvestmentReasons.md)
-
----
-
-### IReasonToRule
-
-Re-exports [IReasonToRule](reason-to-rule/interfaces/IReasonToRule.md)
-
----
-
-### IReasonToRuleMeta
-
-Re-exports [IReasonToRuleMeta](reason-to-rule/interfaces/IReasonToRuleMeta.md)
-
----
-
-### IRentalInvestorValidator
-
-Re-exports [IRentalInvestorValidator](rental-investor-validator/interfaces/IRentalInvestorValidator.md)
-
----
-
-### IUserInvestResult
-
-Re-exports [IUserInvestResult](user-invest-result/interfaces/IUserInvestResult.md)
-
----
-
-### PropertyDecoratorType
-
-Re-exports [PropertyDecoratorType](investment-reasons-decorator/type-aliases/PropertyDecoratorType.md)
-
----
-
-### ReasonToRule
-
-Re-exports [ReasonToRule](reason-to-rule/classes/ReasonToRule.md)
-
----
-
-### RentalInvestorValidator
-
-Re-exports [RentalInvestorValidator](rental-investor-validator/classes/RentalInvestorValidator.md)
-
----
-
-### UserInvestResult
-
-Re-exports [UserInvestResult](user-invest-result/classes/UserInvestResult.md)

package/docs/investments/investment-reasons/enumerations/InvestmentReasons.md

@@ -1,119 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/investment-reasons](../index.md) / InvestmentReasons
-
-# Enumeration: InvestmentReasons
-
-Defined in: [investments/investment-reasons.ts:1](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L1)
-
-## Enumeration Members
-
-### DoesNotMeetUserRuleAnnualCashFlow
-
-> **DoesNotMeetUserRuleAnnualCashFlow**: `6`
-
-Defined in: [investments/investment-reasons.ts:34](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L34)
-
-The user wants a certain amount of annual cash flow
-
----
-
-### DoesNotMeetUserRuleAskingPrice
-
-> **DoesNotMeetUserRuleAskingPrice**: `8`
-
-Defined in: [investments/investment-reasons.ts:44](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L44)
-
-Property's asking price, or market value, is not met
-
----
-
-### DoesNotMeetUserRuleCapitalGain
-
-> **DoesNotMeetUserRuleCapitalGain**: `10`
-
-Defined in: [investments/investment-reasons.ts:54](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L54)
-
-Properties capital gain percent from purchase is lower than expected
-
----
-
-### DoesNotMeetUserRuleCashOnCash
-
-> **DoesNotMeetUserRuleCashOnCash**: `5`
-
-Defined in: [investments/investment-reasons.ts:29](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L29)
-
-The user wants a certain percent of annual cash flow
-
----
-
-### DoesNotMeetUserRuleEquityCapture
-
-> **DoesNotMeetUserRuleEquityCapture**: `4`
-
-Defined in: [investments/investment-reasons.ts:24](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L24)
-
-The user wants a certain amount of Unrealized Capital Gain (Equity)
-
----
-
-### DoesNotMeetUserRuleOutOfPocket
-
-> **DoesNotMeetUserRuleOutOfPocket**: `9`
-
-Defined in: [investments/investment-reasons.ts:49](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L49)
-
-Property's cost down, or out of pocket expense, is larger than desired
-
----
-
-### NoRules
-
-> **NoRules**: `1`
-
-Defined in: [investments/investment-reasons.ts:10](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L10)
-
-no rule applied
-
----
-
-### PropertyIsAlreadyOwned
-
-> **PropertyIsAlreadyOwned**: `7`
-
-Defined in: [investments/investment-reasons.ts:39](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L39)
-
-Property is already owned
-
----
-
-### Unknown
-
-> **Unknown**: `0`
-
-Defined in: [investments/investment-reasons.ts:5](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L5)
-
-unknown rule match
-
----
-
-### UserHasNoMoneyToInvest
-
-> **UserHasNoMoneyToInvest**: `2`
-
-Defined in: [investments/investment-reasons.ts:14](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L14)
-
-No money for the user to invest with at this time
-
----
-
-### UserHasNotSavedEnoughMoney
-
-> **UserHasNotSavedEnoughMoney**: `3`
-
-Defined in: [investments/investment-reasons.ts:19](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons.ts#L19)
-
-The user has money, however, the user does not have enough to invest with at this time

package/docs/investments/investment-reasons/index.md

@@ -1,11 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / investments/investment-reasons
-
-# investments/investment-reasons
-
-## Enumerations
-
-- [InvestmentReasons](enumerations/InvestmentReasons.md)

package/docs/investments/investment-reasons-decorator/functions/InvestmentReasonForHoldRuleTypes.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/investment-reasons-decorator](../index.md) / InvestmentReasonForHoldRuleTypes
-
-# Function: InvestmentReasonForHoldRuleTypes()
-
-> **InvestmentReasonForHoldRuleTypes**(`investmentReason`, `ruleType`): [`PropertyDecoratorType`](../type-aliases/PropertyDecoratorType.md)\<[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)\>
-
-Defined in: [investments/investment-reasons-decorator.ts:70](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons-decorator.ts#L70)
-
-## Parameters
-
-### investmentReason
-
-[`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-### ruleType
-
-[`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)
-
-## Returns
-
-[`PropertyDecoratorType`](../type-aliases/PropertyDecoratorType.md)\<[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)\>

package/docs/investments/investment-reasons-decorator/functions/InvestmentReasonForPurchaseRuleTypes.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/investment-reasons-decorator](../index.md) / InvestmentReasonForPurchaseRuleTypes
-
-# Function: InvestmentReasonForPurchaseRuleTypes()
-
-> **InvestmentReasonForPurchaseRuleTypes**(`investmentReason`, `ruleType`): [`PropertyDecoratorType`](../type-aliases/PropertyDecoratorType.md)\<[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)\>
-
-Defined in: [investments/investment-reasons-decorator.ts:63](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons-decorator.ts#L63)
-
-## Parameters
-
-### investmentReason
-
-[`InvestmentReasons`](../../investment-reasons/enumerations/InvestmentReasons.md)
-
-### ruleType
-
-[`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)
-
-## Returns
-
-[`PropertyDecoratorType`](../type-aliases/PropertyDecoratorType.md)\<[`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)\>

package/docs/investments/investment-reasons-decorator/functions/getInvestmentReasons.md

@@ -1,33 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/investment-reasons-decorator](../index.md) / getInvestmentReasons
-
-# Function: getInvestmentReasons()
-
-> **getInvestmentReasons**\<`T`, `TR`\>(`target`, `metaDataNameSuffix`): [`IReasonToRule`](../../reason-to-rule/interfaces/IReasonToRule.md)\<`T`, `TR`\>[]
-
-Defined in: [investments/investment-reasons-decorator.ts:82](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons-decorator.ts#L82)
-
-used to get the value for all properties
-
-## Type Parameters
-
-• **T** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md) & `object`
-
-• **TR** _extends_ [`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md) \| [`HoldRuleTypes`](../../../rules/hold-rule-types/enumerations/HoldRuleTypes.md)
-
-## Parameters
-
-### target
-
-`T`
-
-### metaDataNameSuffix
-
-`string`
-
-## Returns
-
-[`IReasonToRule`](../../reason-to-rule/interfaces/IReasonToRule.md)\<`T`, `TR`\>[]

package/docs/investments/investment-reasons-decorator/functions/getInvestmentReasonsForPurchaseTypes.md

@@ -1,25 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/investment-reasons-decorator](../index.md) / getInvestmentReasonsForPurchaseTypes
-
-# Function: getInvestmentReasonsForPurchaseTypes()
-
-> **getInvestmentReasonsForPurchaseTypes**\<`T`\>(`target`): [`IReasonToRule`](../../reason-to-rule/interfaces/IReasonToRule.md)\<`T`, [`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]
-
-Defined in: [investments/investment-reasons-decorator.ts:128](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons-decorator.ts#L128)
-
-## Type Parameters
-
-• **T** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md) & `object`
-
-## Parameters
-
-### target
-
-`T`
-
-## Returns
-
-[`IReasonToRule`](../../reason-to-rule/interfaces/IReasonToRule.md)\<`T`, [`PurchaseRuleTypes`](../../../rules/purchase-rule-types/enumerations/PurchaseRuleTypes.md)\>[]

package/docs/investments/investment-reasons-decorator/index.md

@@ -1,18 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../modules.md) / investments/investment-reasons-decorator
-
-# investments/investment-reasons-decorator
-
-## Type Aliases
-
-- [PropertyDecoratorType](type-aliases/PropertyDecoratorType.md)
-
-## Functions
-
-- [getInvestmentReasons](functions/getInvestmentReasons.md)
-- [getInvestmentReasonsForPurchaseTypes](functions/getInvestmentReasonsForPurchaseTypes.md)
-- [InvestmentReasonForHoldRuleTypes](functions/InvestmentReasonForHoldRuleTypes.md)
-- [InvestmentReasonForPurchaseRuleTypes](functions/InvestmentReasonForPurchaseRuleTypes.md)

package/docs/investments/investment-reasons-decorator/type-aliases/PropertyDecoratorType.md

@@ -1,29 +0,0 @@
-[**@cubedelement.com/realty-investor-timeline**](../../../index.md)
-
----
-
-[@cubedelement.com/realty-investor-timeline](../../../modules.md) / [investments/investment-reasons-decorator](../index.md) / PropertyDecoratorType
-
-# Type Alias: PropertyDecoratorType()\<T\>
-
-> **PropertyDecoratorType**\<`T`\>: (`target`, `propertyKey`) => `any`
-
-Defined in: [investments/investment-reasons-decorator.ts:12](https://github.com/kvernon/realty-investor-timeline/blob/c7446a8a5576468ac5874a2dd8323180fa97a55b/src/investments/investment-reasons-decorator.ts#L12)
-
-## Type Parameters
-
-• **T** _extends_ [`IRentalPropertyEntity`](../../../properties/i-rental-property-entity/interfaces/IRentalPropertyEntity.md)
-
-## Parameters
-
-### target
-
-`T`
-
-### propertyKey
-
-keyof `T` & `string`
-
-## Returns
-
-`any`