Skip to content

Commit 9197c81

Browse files
docs: maxDatasetPerTask option doc
1 parent 2ccade9 commit 9197c81

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

docs/classes/IExecOrderModule.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -532,11 +532,11 @@ const requestorderTemplate = await createRequestorder({
532532

533533
#### Parameters
534534

535-
| Name | Type |
536-
| :------ | :------ |
537-
| `datasetorders` | [`ConsumableDatasetorder`](../interfaces/internal_.ConsumableDatasetorder.md)[] |
538-
| `options?` | `Object` |
539-
| `options.maxDatasetPerTask?` | `number` |
535+
| Name | Type | Description |
536+
| :------ | :------ | :------ |
537+
| `datasetorders` | [`ConsumableDatasetorder`](../interfaces/internal_.ConsumableDatasetorder.md)[] | - |
538+
| `options?` | `Object` | - |
539+
| `options.maxDatasetPerTask?` | `number` | Maximum number of datasets to include in a single task **`Default`** ```ts 100 ``` |
540540

541541
#### Returns
542542

src/common/execution/order-helper.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ export const checkAppRequirements = async (
207207
}
208208
};
209209

210-
const MAX_DATASET_PER_TASK = 100; // TODO confirm value
210+
const MAX_DATASET_PER_TASK = 100;
211211

212212
const ipfsUpload = async ({
213213
content,

src/lib/IExecOrderModule.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,6 +1106,10 @@ export default class IExecOrderModule extends IExecModule {
11061106
prepareDatasetBulk(
11071107
datasetorders: ConsumableDatasetorder[],
11081108
options?: {
1109+
/**
1110+
* Maximum number of datasets to include in a single task
1111+
* @default 100
1112+
*/
11091113
maxDatasetPerTask?: number;
11101114
},
11111115
): Promise<{ cid: string; volume: number }>;

0 commit comments

Comments
 (0)