medusa-store/docs/content/references/services/classes/SalesChannelService.md

Class: SalesChannelService

Hierarchy

• TransactionBaseService<SalesChannelService>

  ↳ SalesChannelService

Constructors

constructor

• new SalesChannelService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService<SalesChannelService&gt;.constructor

Defined in

services/sales-channel.ts:37

Properties

configModule

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

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

services/sales-channel.ts:34

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/sales-channel.ts:30

---

salesChannelRepository_

• Protected Readonly salesChannelRepository_: typeof SalesChannelRepository

Defined in

services/sales-channel.ts:33

---

storeService_

• Protected Readonly storeService_: StoreService

Defined in

services/sales-channel.ts:35

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/sales-channel.ts:31

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
UPDATED	string

Defined in

services/sales-channel.ts:24

Methods

atomicPhase_

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

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

create

▸ create(data): Promise<SalesChannel>

Parameters

Name	Type
data	CreateSalesChannelInput

Returns

Promise<SalesChannel>

Defined in

services/sales-channel.ts:102

---

createDefault

▸ createDefault(): Promise<SalesChannel>

Returns

Promise<SalesChannel>

Defined in

services/sales-channel.ts:182

---

delete

▸ delete(salesChannelId): Promise<void>

Parameters

Name	Type	Description
salesChannelId	string

Returns

Promise<void>

Defined in

services/sales-channel.ts:154

---

listAndCount

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

Parameters

Name	Type
selector	QuerySelector<any>
config	FindConfig<any>

Returns

Promise<[SalesChannel[], number]>

Defined in

services/sales-channel.ts:88

---

retrieve

▸ retrieve(salesChannelId, config?): Promise<SalesChannel>

Parameters

Name	Type
salesChannelId	string
config	FindConfig<SalesChannel>

Returns

Promise<SalesChannel>

Defined in

services/sales-channel.ts:59

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

update

▸ update(salesChannelId, data): Promise<SalesChannel>

Parameters

Name	Type
salesChannelId	string
data	Partial<CreateSalesChannelInput>

Returns

Promise<SalesChannel>

Defined in

services/sales-channel.ts:119

---

withTransaction

▸ withTransaction(transactionManager?): SalesChannelService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

SalesChannelService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16