shopperman

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Cart | shopperman api docs</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">shopperman api docs</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="cart.html">Cart</a> </li> </ul> <h1>Class Cart</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Shopping cart which tracks products and maintains a subtotal</p> <ul> <li>maintain a cart containing products and keeping track of quantities etc</li> <li>you must provide a catalog of all available items</li> <li>items with quantity 0 are considered "not in the cart"</li> </ul> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Cart</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="cart.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="cart.html#itemcatalog" class="tsd-kind-icon">item<wbr>Catalog</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="cart.html#panelopen" class="tsd-kind-icon">panel<wbr>Open</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="cart.html#activeitems" class="tsd-kind-icon">active<wbr>Items</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="cart.html#price" class="tsd-kind-icon">price</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="cart.html#value" class="tsd-kind-icon">value</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="cart.html#clear" class="tsd-kind-icon">clear</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="cart.html#getproductitem" class="tsd-kind-icon">get<wbr>Product<wbr>Item</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="cart.html#togglepanelopen" class="tsd-kind-icon">toggle<wbr>Panel<wbr>Open</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Cart<span class="tsd-signature-symbol">(</span>opts<span class="tsd-signature-symbol">: </span><a href="../interfaces/cartoptions.html" class="tsd-signature-type">CartOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="cart.html" class="tsd-signature-type">Cart</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L30">stores/cart.ts:30</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>opts: <a href="../interfaces/cartoptions.html" class="tsd-signature-type">CartOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="cart.html" class="tsd-signature-type">Cart</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="itemcatalog" class="tsd-anchor"></a> <h3>item<wbr>Catalog</h3> <div class="tsd-signature tsd-kind-icon">item<wbr>Catalog<span class="tsd-signature-symbol">:</span> <a href="cartitem.html" class="tsd-signature-type">CartItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L25">stores/cart.ts:25</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="panelopen" class="tsd-anchor"></a> <h3>panel<wbr>Open</h3> <div class="tsd-signature tsd-kind-icon">panel<wbr>Open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L26">stores/cart.ts:26</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="activeitems" class="tsd-anchor"></a> <h3>active<wbr>Items</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> activeItems<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="cartitem.html" class="tsd-signature-type">CartItem</a><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L78">stores/cart.ts:78</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Getter for items which are "in the cart"</p> <ul> <li>active items are cart items with quantity greater than zero</li> </ul> </div> </div> <h4 class="tsd-returns-title">Returns <a href="cartitem.html" class="tsd-signature-type">CartItem</a><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="price" class="tsd-anchor"></a> <h3>price</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> price<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L93">stores/cart.ts:93</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Formatter price tag for the whole cart's value</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="value" class="tsd-anchor"></a> <h3>value</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> value<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L85">stores/cart.ts:85</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sum of cart item value</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="clear" class="tsd-anchor"></a> <h3>clear</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L111">stores/cart.ts:111</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Remove all products from the cart</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getproductitem" class="tsd-anchor"></a> <h3>get<wbr>Product<wbr>Item</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Product<wbr>Item<span class="tsd-signature-symbol">(</span>product<span class="tsd-signature-symbol">: </span><a href="product.html" class="tsd-signature-type">Product</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="cartitem.html" class="tsd-signature-type">CartItem</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L120">stores/cart.ts:120</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get a cart item by providing the product inside</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>product: <a href="product.html" class="tsd-signature-type">Product</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="cartitem.html" class="tsd-signature-type">CartItem</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="togglepanelopen" class="tsd-anchor"></a> <h3>toggle<wbr>Panel<wbr>Open</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">toggle<wbr>Panel<wbr>Open<span class="tsd-signature-symbol">(</span>open<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/chase-moskal/shopperman/blob/983feb3/source/stores/cart.ts#L101">stores/cart.ts:101</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Toggle the cart panel open or closed</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> open: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = null</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="cart.html" class="tsd-kind-icon">Cart</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="cart.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="cart.html#itemcatalog" class="tsd-kind-icon">item<wbr>Catalog</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="cart.html#panelopen" class="tsd-kind-icon">panel<wbr>Open</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="cart.html#activeitems" class="tsd-kind-icon">active<wbr>Items</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="cart.html#price" class="tsd-kind-icon">price</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="cart.html#value" class="tsd-kind-icon">value</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="cart.html#clear" class="tsd-kind-icon">clear</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="cart.html#getproductitem" class="tsd-kind-icon">get<wbr>Product<wbr>Item</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="cart.html#togglepanelopen" class="tsd-kind-icon">toggle<wbr>Panel<wbr>Open</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>