You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -1026,8 +1026,9 @@ Default: `false`
1026
1026
1027
1027
Defines how the property `allItems` in [`pagination.paginate`](#pagination.paginate), [`pagination.filter`](#pagination.filter) and [`pagination.shouldContinue`](#pagination.shouldContinue) is managed.
1028
1028
1029
-
When set to `false`, the `allItems`parameter is always an empty array. If `true`, it can hugely increase memory usage when working with a large dataset.
1029
+
By default, the property `allItems` is always an empty array. This setting can be helpful to save on memory usage when working with a large dataset.
1030
1030
1031
+
When set to `true`, the property `allItems` is an array of the emitted items.
The function takes an object with the following properties:
48
48
- `response` - The current response object.
49
49
- `currentItems` - Items from the current response.
50
-
- `allItems` - An empty array, unless when `pagination.stackAllItems` is set to `true`. In the later case, an array of the emitted items.
50
+
- `allItems` - An empty array, unless `pagination.stackAllItems` is set to `true`, in which case, it's an array of the emitted items.
51
51
52
-
It should return an object representing Got options pointing to the next page.
53
-
The options are merged automatically with the previous request, therefore the options returned `pagination.paginate(...)` must reflect changes only.
54
-
If there are no more pages, `false` should be returned.
52
+
It should return an object representing Got options pointing to the next page. The options are merged automatically with the previous request, therefore the options returned `pagination.paginate(...)` must reflect changes only. If there are no more pages, `false` should be returned.
0 commit comments