Skip to content

Commit b38164d

Browse files
committed
chore: update tsdocs on list* calls to reflect limitless nature
1 parent 3ede185 commit b38164d

File tree

18 files changed

+123
-123
lines changed

18 files changed

+123
-123
lines changed

packages/core/types/src/api-key/service.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ export interface IApiKeyModuleService extends IModuleService {
197197
* })
198198
* ```
199199
*
200-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
200+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
201201
*
202202
* ```ts
203203
* const apiKeys = await apiKeyModuleService.listApiKeys(
@@ -236,7 +236,7 @@ export interface IApiKeyModuleService extends IModuleService {
236236
* })
237237
* ```
238238
*
239-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
239+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
240240
*
241241
* ```ts
242242
* const [apiKeys, count] =

packages/core/types/src/auth/service.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ export interface IAuthModuleService extends IModuleService {
183183
* })
184184
* ```
185185
*
186-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
186+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
187187
*
188188
* ```ts
189189
* const authIdentities = await authModuleService.listAuthIdentities(
@@ -222,7 +222,7 @@ export interface IAuthModuleService extends IModuleService {
222222
* })
223223
* ```
224224
*
225-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
225+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
226226
*
227227
* ```ts
228228
* const [authIdentities, count] =
@@ -375,7 +375,7 @@ export interface IAuthModuleService extends IModuleService {
375375
* })
376376
* ```
377377
*
378-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
378+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
379379
*
380380
* ```ts
381381
* const providerIdentities = await authModuleService.listProviderIdentities(

packages/core/types/src/cart/service.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export interface ICartModuleService extends IModuleService {
123123
* )
124124
* ```
125125
*
126-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
126+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
127127
*
128128
* ```ts
129129
* const carts = await cartModuleService.listCarts(
@@ -182,7 +182,7 @@ export interface ICartModuleService extends IModuleService {
182182
* )
183183
* ```
184184
*
185-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
185+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
186186
*
187187
* ```ts
188188
* const [carts, count] = await cartModuleService.listAndCountCarts(
@@ -344,7 +344,7 @@ export interface ICartModuleService extends IModuleService {
344344
* })
345345
* ```
346346
*
347-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
347+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
348348
*
349349
* ```ts
350350
* const addresses = await cartModuleService.listAddresses(
@@ -558,7 +558,7 @@ export interface ICartModuleService extends IModuleService {
558558
* )
559559
* ```
560560
*
561-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
561+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
562562
*
563563
* ```ts
564564
* const lineItems = await cartModuleService.listLineItems(
@@ -791,7 +791,7 @@ export interface ICartModuleService extends IModuleService {
791791
* )
792792
* ```
793793
*
794-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
794+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
795795
*
796796
* ```ts
797797
* const shippingMethods =
@@ -965,7 +965,7 @@ export interface ICartModuleService extends IModuleService {
965965
* )
966966
* ```
967967
*
968-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
968+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
969969
*
970970
* ```ts
971971
* const lineItemAdjustments =
@@ -1136,7 +1136,7 @@ export interface ICartModuleService extends IModuleService {
11361136
* )
11371137
* ```
11381138
*
1139-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1139+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
11401140
*
11411141
* ```ts
11421142
* const shippingMethodAdjustments =
@@ -1313,7 +1313,7 @@ export interface ICartModuleService extends IModuleService {
13131313
* )
13141314
* ```
13151315
*
1316-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1316+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
13171317
*
13181318
* ```ts
13191319
* const lineItemTaxLines =
@@ -1466,7 +1466,7 @@ export interface ICartModuleService extends IModuleService {
14661466
* )
14671467
* ```
14681468
*
1469-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1469+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
14701470
*
14711471
* ```ts
14721472
* const shippingMethodTaxLines =

packages/core/types/src/currency/service.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export interface ICurrencyModuleService extends IModuleService {
4646
* })
4747
* ```
4848
*
49-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
49+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
5050
*
5151
* ```ts
5252
* const currencies = await currencyModuleService.listCurrencies(
@@ -87,7 +87,7 @@ export interface ICurrencyModuleService extends IModuleService {
8787
* })
8888
* ```
8989
*
90-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
90+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
9191
*
9292
* ```ts
9393
* const [currencies, count] =

packages/core/types/src/customer/service.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@ export interface ICustomerModuleService extends IModuleService {
691691
* )
692692
* ```
693693
*
694-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
694+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
695695
*
696696
* ```ts
697697
* const addresses = await customerModuleService.listCustomerAddresses(
@@ -752,7 +752,7 @@ export interface ICustomerModuleService extends IModuleService {
752752
* )
753753
* ```
754754
*
755-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
755+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
756756
*
757757
* ```ts
758758
* const [addresses, count] =
@@ -814,7 +814,7 @@ export interface ICustomerModuleService extends IModuleService {
814814
* )
815815
* ```
816816
*
817-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
817+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
818818
*
819819
* ```ts
820820
* const customerGroupCustomerRels =
@@ -874,7 +874,7 @@ export interface ICustomerModuleService extends IModuleService {
874874
* )
875875
* ```
876876
*
877-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
877+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
878878
*
879879
* ```ts
880880
* const customers = await customerModuleService.listCustomers(
@@ -933,7 +933,7 @@ export interface ICustomerModuleService extends IModuleService {
933933
* )
934934
* ```
935935
*
936-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
936+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
937937
*
938938
* ```ts
939939
* const [customers, count] = await customerModuleService.listAndCountCustomers(
@@ -994,7 +994,7 @@ export interface ICustomerModuleService extends IModuleService {
994994
* )
995995
* ```
996996
*
997-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
997+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
998998
*
999999
* ```ts
10001000
* const customerGroups =
@@ -1056,7 +1056,7 @@ export interface ICustomerModuleService extends IModuleService {
10561056
* )
10571057
* ```
10581058
*
1059-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1059+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
10601060
*
10611061
* ```ts
10621062
* const [customerGroups, count] =

packages/core/types/src/fulfillment/service.ts

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ export interface IFulfillmentModuleService extends IModuleService {
130130
* )
131131
* ```
132132
*
133-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
133+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
134134
*
135135
* ```ts
136136
* const fulfillmentSets = await fulfillmentModuleService.listFulfillmentSets(
@@ -191,7 +191,7 @@ export interface IFulfillmentModuleService extends IModuleService {
191191
* )
192192
* ```
193193
*
194-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
194+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
195195
*
196196
* ```ts
197197
* const [fulfillmentSets, count] =
@@ -455,7 +455,7 @@ export interface IFulfillmentModuleService extends IModuleService {
455455
* )
456456
* ```
457457
*
458-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
458+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
459459
*
460460
* ```ts
461461
* const serviceZones =
@@ -517,7 +517,7 @@ export interface IFulfillmentModuleService extends IModuleService {
517517
* )
518518
* ```
519519
*
520-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
520+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
521521
*
522522
* ```ts
523523
* const [serviceZones, count] =
@@ -822,7 +822,7 @@ export interface IFulfillmentModuleService extends IModuleService {
822822
* )
823823
* ```
824824
*
825-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
825+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
826826
*
827827
* ```ts
828828
* const geoZones = await fulfillmentModuleService.listGeoZones(
@@ -883,7 +883,7 @@ export interface IFulfillmentModuleService extends IModuleService {
883883
* )
884884
* ```
885885
*
886-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
886+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
887887
*
888888
* ```ts
889889
* const [geoZones, count] =
@@ -1155,7 +1155,7 @@ export interface IFulfillmentModuleService extends IModuleService {
11551155
* )
11561156
* ```
11571157
*
1158-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1158+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
11591159
*
11601160
* ```ts
11611161
* const shippingOptions =
@@ -1226,7 +1226,7 @@ export interface IFulfillmentModuleService extends IModuleService {
12261226
* )
12271227
* ```
12281228
*
1229-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1229+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
12301230
*
12311231
* ```ts
12321232
* const shippingOptions =
@@ -1292,7 +1292,7 @@ export interface IFulfillmentModuleService extends IModuleService {
12921292
* )
12931293
* ```
12941294
*
1295-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1295+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
12961296
*
12971297
* ```ts
12981298
* const [shippingOptions, count] =
@@ -1636,7 +1636,7 @@ export interface IFulfillmentModuleService extends IModuleService {
16361636
* )
16371637
* ```
16381638
*
1639-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1639+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
16401640
*
16411641
* ```ts
16421642
* const shippingProfiles =
@@ -1700,7 +1700,7 @@ export interface IFulfillmentModuleService extends IModuleService {
17001700
* )
17011701
* ```
17021702
*
1703-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
1703+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
17041704
*
17051705
* ```ts
17061706
* const [shippingProfiles, count] =
@@ -2015,7 +2015,7 @@ export interface IFulfillmentModuleService extends IModuleService {
20152015
* )
20162016
* ```
20172017
*
2018-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
2018+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
20192019
*
20202020
* ```ts
20212021
* const shippingOptionRules =
@@ -2079,7 +2079,7 @@ export interface IFulfillmentModuleService extends IModuleService {
20792079
* )
20802080
* ```
20812081
*
2082-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
2082+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
20832083
*
20842084
* ```ts
20852085
* const [shippingOptionRules, count] =
@@ -2452,7 +2452,7 @@ export interface IFulfillmentModuleService extends IModuleService {
24522452
* )
24532453
* ```
24542454
*
2455-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
2455+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
24562456
*
24572457
* ```ts
24582458
* const shippingOptionTypes =
@@ -2516,7 +2516,7 @@ export interface IFulfillmentModuleService extends IModuleService {
25162516
* )
25172517
* ```
25182518
*
2519-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
2519+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
25202520
*
25212521
* ```ts
25222522
* const [shippingOptionTypes, count] =
@@ -2697,7 +2697,7 @@ export interface IFulfillmentModuleService extends IModuleService {
26972697
* )
26982698
* ```
26992699
*
2700-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
2700+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
27012701
*
27022702
* ```ts
27032703
* const fulfillments =
@@ -2766,7 +2766,7 @@ export interface IFulfillmentModuleService extends IModuleService {
27662766
* )
27672767
* ```
27682768
*
2769-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
2769+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
27702770
*
27712771
* ```ts
27722772
* const [fulfillments, count] =

packages/core/types/src/notification/service.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export interface INotificationModuleService extends IModuleService {
131131
* )
132132
* ```
133133
*
134-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
134+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
135135
*
136136
* ```ts
137137
* const notifications = await notificationModuleService.listNotifications(
@@ -193,7 +193,7 @@ export interface INotificationModuleService extends IModuleService {
193193
* )
194194
* ```
195195
*
196-
* By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
196+
* By default, all records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
197197
*
198198
* ```ts
199199
* const [notifications, count] =

0 commit comments

Comments
 (0)