@@ -67,7 +67,7 @@ Cart keeps track of items being added and removed from the cart/order
6767
6868\+ ** new Commerce** (` client ` : [ IClient] ( ../interfaces/_types_.iclient.md ) , ` order? ` : any, ` taxRates ` : [ IGeoRate] ( ../interfaces/_types_.igeorate.md ) [ ] , ` shippingRates ` : [ IGeoRate] ( ../interfaces/_types_.igeorate.md ) [ ] , ` analytics ` : any, ` aPT ` : [ AnalyticsProductTransformFn] ( ../modules/_commerce_.md#analyticsproducttransformfn ) ): * [ Commerce] ( _commerce_.commerce.md ) *
6969
70- * Defined in [ Commerce.ts:109] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L109 ) *
70+ * Defined in [ Commerce.ts:109] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L109 ) *
7171
7272Create an instance of Commerce
7373
@@ -90,7 +90,7 @@ Name | Type | Default | Description |
9090
9191• ** _ storeId** : * string*
9292
93- * Defined in [ Commerce.ts:109] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L109 ) *
93+ * Defined in [ Commerce.ts:109] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L109 ) *
9494
9595the current storeId
9696
100100
101101• ** analytics** : * any*
102102
103- * Defined in [ Commerce.ts:90] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L90 ) *
103+ * Defined in [ Commerce.ts:90] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L90 ) *
104104
105105payment is the object for tracking the user's payment information
106106
110110
111111• ** analyticsProductTransform** : * [ AnalyticsProductTransformFn] ( ../modules/_commerce_.md#analyticsproducttransformfn ) *
112112
113- * Defined in [ Commerce.ts:97] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L97 ) *
113+ * Defined in [ Commerce.ts:97] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L97 ) *
114114
115115analyticsProductTransform is a function for transforming analytics objects
116116before sending them
121121
122122• ** bootstrapPromise** : * Promise‹any›*
123123
124- * Defined in [ Commerce.ts:103] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L103 ) *
124+ * Defined in [ Commerce.ts:103] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L103 ) *
125125
126126bootstrapPromise executes after contructor completes any bootstrap
127127
131131
132132• ** client** : * [ IClient] ( ../interfaces/_types_.iclient.md ) *
133133
134- * Defined in [ Commerce.ts:52] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L52 ) *
134+ * Defined in [ Commerce.ts:52] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L52 ) *
135135
136136client is reference to a IClient
137137
141141
142142• ** order** : * [ Order] ( _order_.order.md ) *
143143
144- * Defined in [ Commerce.ts:72] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L72 ) *
144+ * Defined in [ Commerce.ts:72] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L72 ) *
145145
146146order is the object for tracking the user's order/cart info
147147
151151
152152• ** payment** : * any*
153153
154- * Defined in [ Commerce.ts:84] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L84 ) *
154+ * Defined in [ Commerce.ts:84] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L84 ) *
155155
156156payment is the object for tracking the user's payment information
157157
161161
162162• ** updateQueue** : * [ CartUpdateRequest] ( ../modules/_commerce_.md#cartupdaterequest ) [ ] * = [ ]
163163
164- * Defined in [ Commerce.ts:59] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L59 ) *
164+ * Defined in [ Commerce.ts:59] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L59 ) *
165165
166166updateQueue contains the list of cart item updates so we can ensure
167167updates are pushed fifo
172172
173173• ** updateQueuePromise** : * Promise‹void›* = new Promise((res) => { res() })
174174
175- * Defined in [ Commerce.ts:66] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L66 ) *
175+ * Defined in [ Commerce.ts:66] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L66 ) *
176176
177177updateQueuePromise is a reference to the promise generated by the
178178updateQueue for the purposes of awaiting outside of the direct call
183183
184184• ** user** : * [ User] ( _user_.user.md ) *
185185
186- * Defined in [ Commerce.ts:78] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L78 ) *
186+ * Defined in [ Commerce.ts:78] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L78 ) *
187187
188188user is an object for tracking the user's contact information
189189
@@ -193,7 +193,7 @@ user is an object for tracking the user's contact information
193193
194194• ** get cartId** (): * string*
195195
196- * Defined in [ Commerce.ts:162] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L162 ) *
196+ * Defined in [ Commerce.ts:162] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L162 ) *
197197
198198Get the cart id
199199
208208
209209• ** get isCartInit** (): * boolean*
210210
211- * Defined in [ Commerce.ts:170] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L170 ) *
211+ * Defined in [ Commerce.ts:170] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L170 ) *
212212
213213Get the cart id
214214
220220
221221• ** get items** (): * [ LineItem] ( _lineitem_.lineitem.md ) [ ] *
222222
223- * Defined in [ Commerce.ts:144] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L144 ) *
223+ * Defined in [ Commerce.ts:144] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L144 ) *
224224
225225** Returns:** * [ LineItem] ( _lineitem_.lineitem.md ) [ ] *
226226
232232
233233• ** get size** (): * number*
234234
235- * Defined in [ Commerce.ts:152] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L152 ) *
235+ * Defined in [ Commerce.ts:152] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L152 ) *
236236
237237** Returns:** * number*
238238
244244
245245• ** get storeId** (): * string*
246246
247- * Defined in [ Commerce.ts:190] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L190 ) *
247+ * Defined in [ Commerce.ts:190] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L190 ) *
248248
249249** Returns:** * string*
250250
254254
255255▸ ** cartInit** (): * Promise‹[ ICart] ( ../interfaces/_types_.icart.md ) ›*
256256
257- * Defined in [ Commerce.ts:199] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L199 ) *
257+ * Defined in [ Commerce.ts:199] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L199 ) *
258258
259259Initialize the cart system.
260260
270270
271271* Implementation of [ ICartAPI] ( ../interfaces/_types_.icartapi.md ) *
272272
273- * Defined in [ Commerce.ts:600] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L600 ) *
273+ * Defined in [ Commerce.ts:600] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L600 ) *
274274
275275Set the cart's email directly on the server (shouldn't be used directly in high level
276276operations)
291291
292292▸ ** cartSetItem** (` id ` : string, ` quantity ` : number): * Promise‹[ ICart] ( ../interfaces/_types_.icart.md ) | undefined›*
293293
294- * Defined in [ Commerce.ts:565] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L565 ) *
294+ * Defined in [ Commerce.ts:565] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L565 ) *
295295
296296Set the cart's items directly on the server (shouldn't be used directly in high level
297297operations)
315315
316316* Implementation of [ ICartAPI] ( ../interfaces/_types_.icartapi.md ) *
317317
318- * Defined in [ Commerce.ts:615] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L615 ) *
318+ * Defined in [ Commerce.ts:615] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L615 ) *
319319
320320Set the cart's user name directly on the server (shouldn't be used directly in high level
321321operations)
338338
339339* Implementation of [ ICartAPI] ( ../interfaces/_types_.icartapi.md ) *
340340
341- * Defined in [ Commerce.ts:585] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L585 ) *
341+ * Defined in [ Commerce.ts:585] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L585 ) *
342342
343343Set the cart's store directly on the server (shouldn't be used directly in high level
344344operations)
359359
360360▸ ** checkout** (` payment ` : [ IPayment] ( ../interfaces/_types_.ipayment.md ) ): * Promise‹[ IOrder] ( ../interfaces/_types_.iorder.md ) | undefined›*
361361
362- * Defined in [ Commerce.ts:676] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L676 ) *
362+ * Defined in [ Commerce.ts:676] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L676 ) *
363363
364364Checkout the order
365365
381381
382382* Implementation of [ ICartAPI] ( ../interfaces/_types_.icartapi.md ) *
383383
384- * Defined in [ Commerce.ts:630] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L630 ) *
384+ * Defined in [ Commerce.ts:630] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L630 ) *
385385
386386Set the cart's user name directly on the server (shouldn't be used directly in high level
387387operations)
396396
397397▸ ** del** (` id ` : string): * Promise‹[ LineItem] ( _lineitem_.lineitem.md ) | undefined›*
398398
399- * Defined in [ Commerce.ts:507] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L507 ) *
399+ * Defined in [ Commerce.ts:507] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L507 ) *
400400
401401Delete an item
402402
416416
417417▸ ** executeUpdateItem** (` id ` : string, ` quantity ` : number, ` locked ` : boolean, ` ignore ` : boolean): * Promise‹[ LineItem] ( _lineitem_.lineitem.md ) | undefined›*
418418
419- * Defined in [ Commerce.ts:406] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L406 ) *
419+ * Defined in [ Commerce.ts:406] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L406 ) *
420420
421421Execute update for item
422422
439439
440440▸ ** executeUpdates** (): * Promise‹void›*
441441
442- * Defined in [ Commerce.ts:296] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L296 ) *
442+ * Defined in [ Commerce.ts:296] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L296 ) *
443443
444444Execute all queued updates
445445
453453
454454▸ ** get** (` id ` : string): * Promise‹[ LineItem] ( _lineitem_.lineitem.md ) | undefined›*
455455
456- * Defined in [ Commerce.ts:221] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L221 ) *
456+ * Defined in [ Commerce.ts:221] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L221 ) *
457457
458458Get the current state of a specific lineitem
459459
473473
474474▸ ** refresh** (` id ` : any): * Promise‹[ LineItem] ( _lineitem_.lineitem.md ) | undefined›*
475475
476- * Defined in [ Commerce.ts:281] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L281 ) *
476+ * Defined in [ Commerce.ts:281] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L281 ) *
477477
478478Refresh a lineitem by product id. Add lineitem to asynchronous update queue
479479
493493
494494▸ ** set** (` id ` : any, ` quantity ` : any, ` locked ` : boolean, ` ignore ` : boolean, ` force ` : boolean): * Promise‹void›*
495495
496- * Defined in [ Commerce.ts:265] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L265 ) *
496+ * Defined in [ Commerce.ts:265] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L265 ) *
497497
498498Set a lineitem by product id. Add lineitem to asynchronous update queue
499499
519519
520520* Implementation of [ ICartAPI] ( ../interfaces/_types_.icartapi.md ) *
521521
522- * Defined in [ Commerce.ts:645] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L645 ) *
522+ * Defined in [ Commerce.ts:645] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L645 ) *
523523
524524Apply a coupon/promoCode
525525
539539
540540▸ ** setStoreId** (` sId ` : any): * Promise‹void›*
541541
542- * Defined in [ Commerce.ts:175] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L175 ) *
542+ * Defined in [ Commerce.ts:175] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L175 ) *
543543
544544** Parameters:**
545545
@@ -555,30 +555,30 @@ Name | Type |
555555
556556### ▪ ** cart** : * object*
557557
558- * Defined in [ Commerce.ts:41] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L41 ) *
558+ * Defined in [ Commerce.ts:41] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L41 ) *
559559
560560metadata of the current cart
561561
562562### email
563563
564564• ** email** : * string* = ""
565565
566- * Defined in [ Commerce.ts:44] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L44 ) *
566+ * Defined in [ Commerce.ts:44] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L44 ) *
567567
568568### id
569569
570570• ** id** : * string* = ""
571571
572- * Defined in [ Commerce.ts:42] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L42 ) *
572+ * Defined in [ Commerce.ts:42] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L42 ) *
573573
574574### name
575575
576576• ** name** : * string* = ""
577577
578- * Defined in [ Commerce.ts:45] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L45 ) *
578+ * Defined in [ Commerce.ts:45] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L45 ) *
579579
580580### storeId
581581
582582• ** storeId** : * string* = ""
583583
584- * Defined in [ Commerce.ts:43] ( https://github.com/shopjs/commerce.js/blob/bdc45b5 /src/Commerce.ts#L43 ) *
584+ * Defined in [ Commerce.ts:43] ( https://github.com/shopjs/commerce.js/blob/e02bd83 /src/Commerce.ts#L43 ) *
0 commit comments