docs-util: reorder workflow execution examples (#10955)

* docs-util: reorder workflow execution examples

* reorder again

* add examples header
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-01-14 11:52:50 +02:00
1 parent 4bc3f5b845
commit 98e77fad89
473 files changed
+13139 -12637

No files matched your search

@@ -46,7 +46,7 @@ const [currencies, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)","description":"The filters to apply on the retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":truLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)","description":"The filters to apply on the retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../interfaces/currency.FindConfig/page.mdx)&#60;[CurrencyDTO](../../../interfaces/currency.CurrencyDTO/page.mdx)&#62;","description":"The configurations determining how the currencies are retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a currency.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tLine truncated
## Returns
@@ -44,7 +44,7 @@ const currencies = await currencyModuleService.listCurrencies(
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)","description":"The filters to apply on the retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":truLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)","description":"The filters to apply on the retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search through currencies using this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`[]","description":"The codes to filter the currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx) \\| [BaseFilterable](../../../interfaces/currency.BaseFilterable/page.mdx)&#60;[FilterableCurrencyProps](../../../interfaces/currency.FilterableCurrencyProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../interfaces/currency.FindConfig/page.mdx)&#60;[CurrencyDTO](../../../interfaces/currency.CurrencyDTO/page.mdx)&#62;","description":"The configurations determining how the currencies are retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a currency.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tLine truncated
## Returns