@ev-uk/investment-forecast-advice

EValue widget: Investment Forecast Advice

Contents

• Description

• Install
• Usage
• Parameters

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

Name	Type	Required	Effects	Description
cashComparisonUrl	string		API
chanceBeatingTargetUrl	string		API
invForecastAdvancedUrl	string		API
company	string		API
configReference	string		API	The API company that the implementation is associated with. This should be passed into any API calls highlighted in the API section
token	string		API
currency	string	✓	Widget
riskLevels	number	✓	User	Valid values are 5, 7 and 10