Skip to content

Commit 066deca

Browse files
fix: add missing option in type
1 parent dcb17ce commit 066deca

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/classes/IExecOrderbookModule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ console.log('total orders:', count);
152152
153153
| Name | Type | Description |
154154
| :------ | :------ | :------ |
155-
| `datasetAddressOrOptions` | `string` \| { `app?`: `string` ; `dataset?`: `string` ; `datasetOwner?`: `string` ; `isAppStrict?`: `boolean` ; `isRequesterStrict?`: `boolean` ; `isWorkerpoolStrict?`: `boolean` ; `maxTag?`: [`Tag`](../modules.md#tag) \| `string`[] ; `minTag?`: [`Tag`](../modules.md#tag) \| `string`[] ; `minVolume?`: [`BNish`](../modules.md#bnish) ; `page?`: `number` ; `pageSize?`: `number` ; `requester?`: `string` ; `workerpool?`: `string` } | - |
155+
| `datasetAddressOrOptions` | `string` \| { `app?`: `string` ; `bulkOnly?`: `boolean` ; `dataset?`: `string` ; `datasetOwner?`: `string` ; `isAppStrict?`: `boolean` ; `isRequesterStrict?`: `boolean` ; `isWorkerpoolStrict?`: `boolean` ; `maxTag?`: [`Tag`](../modules.md#tag) \| `string`[] ; `minTag?`: [`Tag`](../modules.md#tag) \| `string`[] ; `minVolume?`: [`BNish`](../modules.md#bnish) ; `page?`: `number` ; `pageSize?`: `number` ; `requester?`: `string` ; `workerpool?`: `string` } | - |
156156
| `options?` | `Object` | **`Deprecated`** use first parameter instead migration: replace `fetchDatasetOrderbook(datasetAddress, options)` by `fetchDatasetOrderbook({ dataset: datasetAddress, ...options })` |
157157
| `options.app?` | `string` | include orders restricted to specified app (use `'any'` to include any app) |
158158
| `options.bulkOnly?` | `boolean` | filters out orders that don't allow bulk processing (default: `false`) |

src/lib/IExecOrderbookModule.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,10 @@ export default class IExecOrderbookModule extends IExecModule {
331331
* filters out orders allowing “any” workerpool (default: `false`)
332332
*/
333333
isWorkerpoolStrict?: boolean;
334+
/**
335+
* filters out orders that don't allow bulk processing (default: `false`)
336+
*/
337+
bulkOnly?: boolean;
334338
},
335339
/**
336340
* @deprecated use first parameter instead

0 commit comments

Comments
 (0)