0.0.7-bacfdedda4525a1b0956000c4204333eff0ac86b • Published 2 years ago

@ev-uk/investment-forecast-advice v0.0.7-bacfdedda4525a1b0956000c4204333eff0ac86b

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

EValue widget: Investment Forecast Advice

Contents

Description

@ev-uk/investment-forecast-advice is an EValue widget that can be added to an existing website

Install

The widget can be installed by running one of the following commands

npm i @ev-uk/investment-forecast-advice
yarn add @ev-uk/investment-forecast-advice

Usage

The widget can be imported into a TypeScript project as follows:

import type { TApiParam, TConfig, TInvestmentForecastAdviceProps } from '@ev-uk/investment-forecast-advice';
import { InvestmentForecastAdviceWidget } from '@ev-uk/investment-forecast-advice';

const api: TApiParam = {
  ...url parameters...
}

const config: TConfig = {
  api,
  currency: '<CURRENCY>',
  riskLevels: 7
}

const props: TInvestmentForecastAdviceProps = {
  config
}

export const App = () => {
  return (
    InvestmentForecastAdviceWidget(props)
  )
}

Parameters

NameTypeRequiredEffectsDescription
cashComparisonUrlstringAPI
chanceBeatingTargetUrlstringAPI
invForecastAdvancedUrlstringAPI
companystringAPI
configReferencestringAPIThe API company that the implementation is associated with. This should be passed into any API calls highlighted in the API section
tokenstringAPI
currencystringWidget
riskLevelsnumberUserValid values are 5, 7 and 10