asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
bb87db83424e2625e273fd5cf06cece37245b6da
medusa-store/www/apps/docs/content/references/services/classes/services.BatchJobService.mdx
Shahed Nasser bb87db8342 docs: prep for v2 documentation (#6710) 
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00

192 lines
13 KiB
Plaintext
Raw Blame History

---
displayed_sidebar: servicesSidebar
---
import TypeList from "@site/src/components/TypeList"
# BatchJobService
## constructor
### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="new BatchJobService"/>
___
## Properties
<TypeList types={[{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"Events.CREATED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.created\"","expandable":false,"children":[]},{"name":"Events.UPDATED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.updated\"","expandable":false,"children":[]},{"name":"Events.PRE_PROCESSED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.pre_processed\"","expandable":false,"children":[]},{"name":"Events.CONFIRMED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.confirmed\"","expandable":false,"children":[]},{"name":"Events.PROCESSING","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.processing\"","expandable":false,"children":[]},{"name":"Events.COMPLETED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.completed\"","expandable":false,"children":[]},{"name":"Events.CANCELED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.canceled\"","expandable":false,"children":[]},{"name":"Events.FAILED","type":"`string`","description":"","optional":false,"defaultValue":"\"batch.failed\"","expandable":false,"children":[]},{"name":"batchJobRepository_","type":"Repository&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"eventBus_","type":"[EventBusService](services.EventBusService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"strategyResolver_","type":"[StrategyResolverService](services.StrategyResolverService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"batchJobStatusMapToProps","type":"Map&#60;[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx), object&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="BatchJobService"/>
___
## Accessors
### activeManager\_
#### Returns
<TypeList types={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="activeManager_"/>
___
## Methods
### withTransaction
#### Parameters
<TypeList types={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="withTransaction"/>
#### Returns
<TypeList types={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="withTransaction"/>
### shouldRetryTransaction\_
#### Parameters
<TypeList types={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="shouldRetryTransaction_"/>
#### Returns
<TypeList types={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="shouldRetryTransaction_"/>
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type Parameters
<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="atomicPhase_"/>
#### Parameters
<TypeList types={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: TError) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: TError) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="atomicPhase_"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} sectionTitle="atomicPhase_"/>
### retrieve
#### Parameters
<TypeList types={[{"name":"batchJobId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} sectionTitle="retrieve"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="retrieve"/>
### listAndCount
#### Parameters
<TypeList types={[{"name":"selector","type":"[FilterableBatchJobProps](../../medusa/classes/medusa.FilterableBatchJobProps.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="listAndCount"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[[BatchJob](../../entities/classes/entities.BatchJob.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="listAndCount"/>
### create
#### Parameters
<TypeList types={[{"name":"data","type":"[BatchJobCreateProps](../../medusa/types/medusa.BatchJobCreateProps.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="create"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="create"/>
### update
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"Partial&#60;Pick&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx), \"context\" \\| \"result\"&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="update"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="update"/>
### confirm
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="confirm"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="confirm"/>
### complete
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="complete"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="complete"/>
### cancel
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="cancel"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="cancel"/>
### setPreProcessingDone
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="setPreProcessingDone"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="setPreProcessingDone"/>
### setProcessing
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="setProcessing"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="setProcessing"/>
### setFailed
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="setFailed"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="setFailed"/>
### prepareBatchJobForProcessing
#### Parameters
<TypeList types={[{"name":"data","type":"[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"Request&#60;ParamsDictionary, any, any, ParsedQs, Record&#60;string, any&#62;&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="prepareBatchJobForProcessing"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[CreateBatchJobInput](../../medusa/types/medusa.CreateBatchJobInput.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="prepareBatchJobForProcessing"/>
### updateStatus
#### Parameters
<TypeList types={[{"name":"batchJobOrId","type":"`string` \\| [BatchJob](../../entities/classes/entities.BatchJob.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="updateStatus"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[BatchJob](../../entities/classes/entities.BatchJob.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="updateStatus"/>
Reference in New Issue View Git Blame Copy Permalink