View Source BasicECommerce.OrderLine (Basic e-commerce v0.1.0)

Defines a line of an order.

This module defines a BasicECommerce.OrderLine describing a line of an order.

fields
Fields

product()

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

special_offer()

t()

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Apply the best applicable offer to a given line.

raw_total(line)

Returns the total price of the given line without any applicable special offer

@type product() :: BasicECommerce.Product.t()

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Full definition:

product :: BasicECommerce.Product.t()

@type special_offer() :: BasicECommerce.SpecialOffer.t()

@type t() :: %BasicECommerce.OrderLine{product: product(), quantity: integer()}

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Full definition:

t :: %BasicECommerce.OrderLine{product: product(), quantity: integer()}

@spec apply_offers(t(), [special_offer()]) :: {nil | special_offer(), integer()}

Apply the best applicable offer to a given line.

Returns a tuple with

the first element being the applied BasicECommerce.SpecialOffer or nil if no offer was applied
the second element being the total price after the special offer was applied

@spec raw_total(t()) :: integer()

Returns the total price of the given line without any applicable special offer