Class CartItem

Hierarchy

CartItem

Index

Constructors

constructor

new CartItem(product: ProductListed, quantity?: number, schemas?: SchemaListed[], schemaValues?: CartItemSchema[], children?: CartItem[], currency: string, createdAt?: number): CartItem
Parameters
- product: ProductListed
- quantity: number = 1
- schemas: SchemaListed[] = []
- schemaValues: CartItemSchema[] = []
- children: CartItem[] = []
- currency: string
- createdAt: number = ...
Returns CartItem
- Defined in models/CartItem.ts:29

Properties

`Private` children

children: CartItem[] = []

field 'children' contains duplicated(due to id) products copies, which have different prices(usually discount prices) it's required to merge products that are basically the same

`Private` createdAt

createdAt: number

currency

currency: string

`Private` precalculatedInitialPrice

precalculatedInitialPrice: null | number = null

`Private` precalculatedPrice

precalculatedPrice: null | number = null

`Readonly` product

product: ProductListed

`Private` productSchemas

productSchemas: SchemaListed[]

qty

qty: number

schemas

schemas: CartItemSchema[]

Accessors

attributes

get attributes(): ProductListedAttribute[]
Returns ProductListedAttribute[]
- Defined in models/CartItem.ts:90

basePrice

get basePrice(): Price | {
currency: string;
gross: string;
}
Returns Price | {
currency: string;
gross: string;
}
- Defined in models/CartItem.ts:102

cover

get cover(): string
Deprecated
Use coverUrl instead

Returns string
- Defined in models/CartItem.ts:191

coverMedia

get coverMedia(): null | CdnMedia
Returns null | CdnMedia
- Defined in models/CartItem.ts:199

coverUrl

get coverUrl(): string
Returns string
- Defined in models/CartItem.ts:195

discountValue

get discountValue(): number
Total discount value of the item (without children)

Returns number
- Defined in models/CartItem.ts:155

id

get id(): string
Returns string
- Defined in models/CartItem.ts:74

initialPrice

get initialPrice(): number
Singular initial (before discounts) price of the item (without children)

Returns number
- Defined in models/CartItem.ts:129

name

get name(): string
Returns string
- Defined in models/CartItem.ts:82

price

get price(): number
Singular price of the item (without children)

Returns number
- Defined in models/CartItem.ts:114

productId

get productId(): string
Returns string
- Defined in models/CartItem.ts:78

quantityStep

get quantityStep(): number
Returns number
- Defined in models/CartItem.ts:203

shippingDigital

get shippingDigital(): boolean
Returns boolean
- Defined in models/CartItem.ts:86

totalDiscountValue

get totalDiscountValue(): number
returns sum of core-product discounts and all childrens' discounts to be able to display info about total discount on one particular product

Returns number
- Defined in models/CartItem.ts:163

totalInitialPrice

get totalInitialPrice(): number
Total initial price (before discounts) of the item including quantity and children

Returns number
- Defined in models/CartItem.ts:144

totalPrice

get totalPrice(): number
Total price of the item including quantity and children

Returns number
- Defined in models/CartItem.ts:136

totalQty

get totalQty(): number
Number of given items in the cart, also includes nested items

Returns number
- Defined in models/CartItem.ts:97

variant

get variant(): [string, CartItemRawSchemaValue][]
Returns [name, value] pair for each schema in CartItem value is a human readable value - so it is a selected option name for Option Schema, or a simple value for any other type

Returns [string, CartItemRawSchemaValue][]
- Defined in models/CartItem.ts:212

Methods

getOrderObject

getOrderObject(): CartItemDto
Returns CartItemDto
- Defined in models/CartItem.ts:49

setChildren

setChildren(childs: CartItem[]): CartItem
Parameters
- childs: CartItem[]
Returns CartItem
- Defined in models/CartItem.ts:179

setPrecalculatedPrices

setPrecalculatedPrices(price: number, initialPrice: number): CartItem
Parameters
- price: number
- initialPrice: number
Returns CartItem
- Defined in models/CartItem.ts:173

toJSON

toJSON(): SavedCartItem
Returns SavedCartItem
- Defined in models/CartItem.ts:226

updateQuantity

updateQuantity(newQuantity: number): CartItem
Parameters
- newQuantity: number
Returns CartItem
- Defined in models/CartItem.ts:58

Class CartItem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

product: ProductListed

quantity: number = 1

schemas: SchemaListed[] = []

schemaValues: CartItemSchema[] = []

children: CartItem[] = []

currency: string

createdAt: number = ...

Returns CartItem

Properties

Private children

Private createdAt

currency

Private precalculatedInitialPrice

Private precalculatedPrice

Readonly product

Private productSchemas

qty

schemas

Accessors

attributes

Returns ProductListedAttribute[]

basePrice

Returns Price | { currency: string; gross: string; }

cover

Deprecated

Returns string

coverMedia

Returns null | CdnMedia

coverUrl

Returns string

discountValue

Returns number

id

Returns string

initialPrice

Returns number

name

Returns string

price

Returns number

productId

Returns string

quantityStep

Returns number

shippingDigital

Returns boolean

totalDiscountValue

Returns number

totalInitialPrice

Returns number

totalPrice

Returns number

totalQty

Returns number

variant

Returns [string, CartItemRawSchemaValue][]

Methods

getOrderObject

Returns CartItemDto

setChildren

Parameters

childs: CartItem[]

Returns CartItem

setPrecalculatedPrices

Parameters

price: number

initialPrice: number

Returns CartItem

toJSON

Returns SavedCartItem

`Private` children

`Private` createdAt

`Private` precalculatedInitialPrice

`Private` precalculatedPrice

`Readonly` product

`Private` productSchemas

Returns Price | {
currency: string;
gross: string;
}