Class: ProductCategoryService
Provides layer to manipulate product categories.
Hierarchy
TransactionBaseServiceCopy to Clipboard↳
ProductCategoryServiceCopy to Clipboard
Constructors
constructor
• new ProductCategoryService(__namedParametersCopy to Clipboard)
Parameters
| Name | Type |
|---|---|
__namedParametersCopy to Clipboard | InjectedDependenciesCopy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/product-category.ts:35
Properties
__configModule__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
eventBusService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBusService_: EventBusServiceCopy to Clipboard
Defined in
packages/medusa/src/services/product-category.ts:25
manager_
• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/product-category.ts:27
productCategoryRepo_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productCategoryRepo_: typeof ProductCategoryRepositoryCopy to Clipboard
Defined in
packages/medusa/src/services/product-category.ts:24
transactionManager_
• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/product-category.ts:26
Events
▪ StaticCopy to Clipboard Events: ObjectCopy to Clipboard
Type declaration
| Name | Type |
|---|---|
CREATEDCopy to Clipboard | stringCopy to Clipboard |
DELETEDCopy to Clipboard | stringCopy to Clipboard |
UPDATEDCopy to Clipboard | stringCopy to Clipboard |
Defined in
packages/medusa/src/services/product-category.ts:29
Methods
addProducts
▸ addProducts(productCategoryIdCopy to Clipboard, productIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Add a batch of product to a product category
Parameters
| Name | Type | Description |
|---|---|---|
productCategoryIdCopy to Clipboard | stringCopy to Clipboard | The id of the product category on which to add the products |
productIdsCopy to Clipboard | stringCopy to Clipboard[] | The products ids to attach to the product category |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
the product category on which the products have been added
Defined in
packages/medusa/src/services/product-category.ts:227
atomicPhase_
▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>
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 |
|---|
TResultCopy to Clipboard |
TErrorCopy to Clipboard |
Parameters
| Name | Type | Description |
|---|---|---|
workCopy to Clipboard | (transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler?Copy to Clipboard | IsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail?Copy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | Potential error handler |
Returns
PromiseCopy to Clipboard<TResultCopy to Clipboard>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:50
create
▸ create(productCategoryInputCopy to Clipboard): PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
Creates a product category
Parameters
| Name | Type |
|---|---|
productCategoryInputCopy to Clipboard | CreateProductCategoryInputCopy to Clipboard |
Returns
PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
created product category
Defined in
packages/medusa/src/services/product-category.ts:132
delete
▸ delete(productCategoryIdCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Deletes a product category
Parameters
| Name | Type | Description |
|---|---|---|
productCategoryIdCopy to Clipboard | stringCopy to Clipboard | is the id of the product category to delete |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
a promise
Defined in
packages/medusa/src/services/product-category.ts:191
listAndCount
▸ listAndCount(selectorCopy to Clipboard, config?Copy to Clipboard, treeSelector?Copy to Clipboard): PromiseCopy to Clipboard<[ProductCategoryCopy to Clipboard[], numberCopy to Clipboard]>
Lists product category based on the provided parameters and includes the count of product category that match the query.
Parameters
| Name | Type |
|---|---|
selectorCopy to Clipboard | QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> |
configCopy to Clipboard | FindConfigCopy to Clipboard<ProductCategoryCopy to Clipboard> |
treeSelectorCopy to Clipboard | QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<[ProductCategoryCopy to Clipboard[], numberCopy to Clipboard]>
an array containing the product category as the first element and the total count of product category that matches the query as the second element.
Defined in
packages/medusa/src/services/product-category.ts:55
removeProducts
▸ removeProducts(productCategoryIdCopy to Clipboard, productIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Remove a batch of product from a product category
Parameters
| Name | Type | Description |
|---|---|---|
productCategoryIdCopy to Clipboard | stringCopy to Clipboard | The id of the product category on which to remove the products |
productIdsCopy to Clipboard | stringCopy to Clipboard[] | The products ids to remove from the product category |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
the product category on which the products have been removed
Defined in
packages/medusa/src/services/product-category.ts:245
retrieve
▸ retrieve(productCategoryIdCopy to Clipboard, config?Copy to Clipboard, selector?Copy to Clipboard): PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
Retrieves a product category by id.
Parameters
| Name | Type | Description |
|---|---|---|
productCategoryIdCopy to Clipboard | stringCopy to Clipboard | the id of the product category to retrieve. |
configCopy to Clipboard | FindConfigCopy to Clipboard<ProductCategoryCopy to Clipboard> | the config of the product category to retrieve. |
selectorCopy to Clipboard | SelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> | - |
Returns
PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
the product category.
Defined in
packages/medusa/src/services/product-category.ts:92
shouldRetryTransaction_
▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard
Parameters
| Name | Type |
|---|---|
errCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard } |
Returns
booleanCopy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(productCategoryIdCopy to Clipboard, productCategoryInputCopy to Clipboard): PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
Updates a product category
Parameters
| Name | Type | Description |
|---|---|---|
productCategoryIdCopy to Clipboard | stringCopy to Clipboard | id of product category to update |
productCategoryInputCopy to Clipboard | UpdateProductCategoryInputCopy to Clipboard | parameters to update in product category |
Returns
PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
updated product category
Defined in
packages/medusa/src/services/product-category.ts:156
withTransaction
▸ withTransaction(transactionManager?Copy to Clipboard): ProductCategoryServiceCopy to Clipboard
Parameters
| Name | Type |
|---|---|
transactionManager?Copy to Clipboard | EntityManagerCopy to Clipboard |
Returns
ProductCategoryServiceCopy to Clipboard
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14