Skip to content

InsuranceCalculator

Utility to calculate insurance and determine the correct Onward variant to add to cart. Exposed on window as OnwardInsuranceCalculator.

In order to use this directly you will need to implement your own loading of the Onward product and its variants from Shopify.

const insuranceVariants = myLoadInsuranceProductVariants();
const insuranceCalculator = new OnwardInsuranceCalculator(insuranceVariants, OnwardSettings.load());

Constructors

Constructor

new InsuranceCalculator(insuranceVariants, settings, locale): InsuranceCalculator

Parameters

insuranceVariants

ProductVariant[]

settings

OnwardSettings

locale

ILocale = null

Returns

InsuranceCalculator

Properties

insuranceVariants

insuranceVariants: ProductVariant[]


locale

locale: ILocale = null


settings

settings: OnwardSettings

Methods

insurancePrice()

insurancePrice(lines): number

Calculate the price of insurance for the cart.

Parameters

lines

CartLine[]

Current cart line items

Returns

number


insuranceVariant()

insuranceVariant(lines): ProductVariant

Determine the Onward insurance variant to add to cart in order to insure the order.

Parameters

lines

CartLine[]

Current cart line items

Returns

ProductVariant