import Cart from '@eastsideco/escshopify/src/entities/Cart.js'

public class | source

Cart

Extends:

evee → Cart

Shopify Cart entity.

Constructor Summary

Public Constructor
public	constructor() Construct a new instance of the cart entity.

Member Summary

Public Members
public get	attributes: Object Alias to getAttributes()
public get	items: ShopifyCartLineItem[] Alias to getItems();
public get	totalPrice: Number Alias to getTotalPrice();
public get	total_price: Number Alias to getTotalPrice();

Private Members
private	_attributes: {}
private	_items: Object[]
private	_queue: promise-queue
private	_ready: boolean

Method Summary

Public Methods
public	addItem(id: Number \| String, quantity: Number, properties: Object): Promise<ShopifyCartLineItem, Error> Add a new item to the cart.
public	clear(): Promise<Cart, Error> Clear the cart.
public	getAttribute(key: ):
public	getAttributes(): Object Returns cart attributes.
public	getItems(): ShopifyCartLineItem[] Returns items in the cart (in the normal Shopify line item format.
public	getTotalPrice(): Number Calculates the total value of the cart.
public	initialize(cartData: ShopifyCart) Initialize the cart entity with the current state of the visitor's cart.
public	async reload(): Promise<Cart, Error> Reloads the cart state via AJAX.
public	removeItem(lineNumber: ):
public	removeItemById(id: ):
public	setAttribute(key: , value: ): *
public	setAttributes(attributes: Object): Promise<Cart, Error> Sets all attributes on the cart.
public	updateItem(lineNumber: , quantity: , properties: ):
public	updateItemById(id: , quantity: , properties: ):
public	updateItemById(id: , quantity: , properties: ):
public	updateItemQuantitiesById(updates: ):

Private Methods
private	_emitAdd(item: *)
private	_emitClear(oldItems: *)
private	_emitRemove(item: *)
private	_emitUpdate(operation: , item: )
private	_emitUpdateItem(item: *)
private	_loadFromShopifyCart(cart: *)
private	_loadItem(itemData: ):

Public Constructors

public constructor() source

Construct a new instance of the cart entity.

Public Members

public get attributes: Object source

Alias to getAttributes()

public get items: ShopifyCartLineItem[] source

Alias to getItems();

public get totalPrice: Number source

Alias to getTotalPrice();

public get total_price: Number source

Alias to getTotalPrice();

Private Members

private _attributes: {} source

private _items: Object[] source

private _queue: promise-queue source

private _ready: boolean source

Public Methods

public addItem(id: Number | String, quantity: Number, properties: Object): Promise<ShopifyCartLineItem, Error> source

Add a new item to the cart.

Params:

Name	Type	Attribute	Description
id	Number \| String		Variant ID to add to cart.
quantity	Number		Quantity to add.
properties	Object		Line item attributes.

Return:

Promise<ShopifyCartLineItem, Error>

public clear(): Promise<Cart, Error> source

Clear the cart.

Return:

Promise<Cart, Error>

public getAttribute(key: ): source

Params:

Name	Type	Attribute	Description
key	*

Return:

public getAttributes(): Object source

Returns cart attributes.

Return:

Object

public getItems(): ShopifyCartLineItem[] source

Returns items in the cart (in the normal Shopify line item format.

Return:

ShopifyCartLineItem[]

public getTotalPrice(): Number source

Calculates the total value of the cart.

Return:

Number

public initialize(cartData: ShopifyCart) source

Initialize the cart entity with the current state of the visitor's cart.

Params:

Name	Type	Attribute	Description
cartData	ShopifyCart		Shopify Cart object.

public async reload(): Promise<Cart, Error> source

Reloads the cart state via AJAX.

Return:

Promise<Cart, Error>

public removeItem(lineNumber: ): source

Params:

Name	Type	Attribute	Description
lineNumber	*

Return:

public removeItemById(id: ): source

Params:

Name	Type	Attribute	Description
id	*

Return:

public setAttribute(key: , value: ): * source

Params:

Name	Type	Attribute	Description
key	*
value	*

Return:

public setAttributes(attributes: Object): Promise<Cart, Error> source

Sets all attributes on the cart. This will override/remove existing attributes.

Params:

Name	Type	Attribute	Description
attributes	Object		New attributes for the cart.

Return:

Promise<Cart, Error>

public updateItem(lineNumber: , quantity: , properties: ): source

Params:

Name	Type	Attribute	Description
lineNumber	*
quantity	*
properties	*

Return:

public updateItemById(id: , quantity: , properties: ): source

Params:

Name	Type	Attribute	Description
id	*
quantity	*
properties	*

Return:

public updateItemById(id: , quantity: , properties: ): source

Params:

Name	Type	Attribute	Description
id	*
quantity	*
properties	*

Return:

public updateItemQuantitiesById(updates: ): source

Params:

Name	Type	Attribute	Description
updates	*

Return:

Private Methods

private _emitAdd(item: *) source

Params:

Name	Type	Attribute	Description
item	*

private _emitClear(oldItems: *) source

Params:

Name	Type	Attribute	Description
oldItems	*

private _emitRemove(item: *) source

Params:

Name	Type	Attribute	Description
item	*

private _emitUpdate(operation: , item: ) source

Params:

Name	Type	Attribute	Description
operation	*
item	*

private _emitUpdateItem(item: *) source

Params:

Name	Type	Attribute	Description
item	*

private _loadFromShopifyCart(cart: *) source

Params:

Name	Type	Attribute	Description
cart	*

private _loadItem(itemData: ): source

Params:

Name	Type	Attribute	Description
itemData	*

Cart

Extends:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public get attributes: Object source

public get items: ShopifyCartLineItem[] source

public get totalPrice: Number source

public get total_price: Number source

Private Members

private _attributes: {} source

private _items: Object[] source

private _queue: promise-queue source

private _ready: boolean source

Public Methods

public addItem(id: Number | String, quantity: Number, properties: Object): Promise<ShopifyCartLineItem, Error> source

Params:

Return:

public clear(): Promise<Cart, Error> source

Return:

public getAttribute(key: *): * source

Params:

Return:

public getAttributes(): Object source

Return:

public getItems(): ShopifyCartLineItem[] source

Return:

public getTotalPrice(): Number source

Return:

public initialize(cartData: ShopifyCart) source

Params:

public async reload(): Promise<Cart, Error> source

Return:

public removeItem(lineNumber: *): * source

Params:

Return:

public removeItemById(id: *): * source

Params:

Return:

public setAttribute(key: *, value: *): * source

Params:

Return:

public setAttributes(attributes: Object): Promise<Cart, Error> source

Params:

Return:

public updateItem(lineNumber: *, quantity: *, properties: *): * source

Params:

Return:

public updateItemById(id: *, quantity: *, properties: *): * source

Params:

Return:

public updateItemById(id: *, quantity: *, properties: *): * source

Params:

Return:

public updateItemQuantitiesById(updates: *): * source

Params:

Return:

Private Methods

private _emitAdd(item: *) source

Params:

private _emitClear(oldItems: *) source

Params:

private _emitRemove(item: *) source

Params:

private _emitUpdate(operation: *, item: *) source

Params:

private _emitUpdateItem(item: *) source

Params:

private _loadFromShopifyCart(cart: *) source

Params:

private _loadItem(itemData: *): * source

Params:

Return:

public getAttribute(key: ): source

public removeItem(lineNumber: ): source

public removeItemById(id: ): source

public setAttribute(key: , value: ): * source

public updateItem(lineNumber: , quantity: , properties: ): source

public updateItemById(id: , quantity: , properties: ): source

public updateItemById(id: , quantity: , properties: ): source

public updateItemQuantitiesById(updates: ): source

private _emitUpdate(operation: , item: ) source

private _loadItem(itemData: ): source