asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
5c2f15cfc445e764ac4899e4e5add7e238b397bf
medusa-store/www/docs/content/references/services/classes/BatchJobService.md
Shahed Nasser 914d773d3a api-ref: custom API reference (#4770) 
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
2023-08-15 18:07:54 +03:00

11 KiB
Raw Blame History

Class: BatchJobService

Hierarchy

  • TransactionBaseService

    ↳ BatchJobService

Constructors

constructor

• new BatchJobService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/batch-job.ts:91

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

batchJobRepository_

• Protected Readonly batchJobRepository_: Repository<BatchJob>

Defined in

medusa/src/services/batch-job.ts:39

batchJobStatusMapToProps

• Protected batchJobStatusMapToProps: Map<BatchJobStatus, { entityColumnName: string ; eventType: string }>

Defined in

medusa/src/services/batch-job.ts:43

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/batch-job.ts:40

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

strategyResolver_

• Protected Readonly strategyResolver_: StrategyResolverService

Defined in

medusa/src/services/batch-job.ts:41

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Events

▪ Static Readonly Events: Object

Type declaration

Name Type
CANCELED string
COMPLETED string
CONFIRMED string
CREATED string
FAILED string
PRE_PROCESSED string
PROCESSING string
UPDATED string

Defined in

medusa/src/services/batch-job.ts:28

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

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

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult> the transactional work to be done
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult> the isolation level to be used for the work.
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult> Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

cancel

▸ cancel(batchJobOrId): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:270

complete

▸ complete(batchJobOrId): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:252

confirm

▸ confirm(batchJobOrId): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:234

create

▸ create(data): Promise<BatchJob>

Parameters

Name Type
data BatchJobCreateProps

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:144

listAndCount

▸ listAndCount(selector?, config?): Promise<[BatchJob[], number]>

Parameters

Name Type
selector FilterableBatchJobProps
config FindConfig<BatchJob>

Returns

Promise<[BatchJob[], number]>

Defined in

medusa/src/services/batch-job.ts:132

prepareBatchJobForProcessing

▸ prepareBatchJobForProcessing(data, req): Promise<CreateBatchJobInput>

Parameters

Name Type
data CreateBatchJobInput
req Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Returns

Promise<CreateBatchJobInput>

Defined in

medusa/src/services/batch-job.ts:367

retrieve

▸ retrieve(batchJobId, config?): Promise<BatchJob>

Parameters

Name Type
batchJobId string
config FindConfig<BatchJob>

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:104

setFailed

▸ setFailed(batchJobOrId, error?): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob
error? string | BatchJobResultError

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:341

setPreProcessingDone

▸ setPreProcessingDone(batchJobOrId): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:288

setProcessing

▸ setProcessing(batchJobOrId): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:321

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

update

▸ update(batchJobOrId, data): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob
data Partial<Pick<BatchJob, "context" | "result">>

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:161

updateStatus

▸ Protected updateStatus(batchJobOrId, status): Promise<BatchJob>

Parameters

Name Type
batchJobOrId string | BatchJob
status BatchJobStatus

Returns

Promise<BatchJob>

Defined in

medusa/src/services/batch-job.ts:200

withTransaction

▸ withTransaction(transactionManager?): BatchJobService

Parameters

Name Type
transactionManager? EntityManager

Returns

BatchJobService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Reference in New Issue View Git Blame Copy Permalink