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
medusa/src/services/product-category.ts:40
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
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__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
medusa/src/interfaces/transaction-base-service.ts:15
eventBusService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBusService_: EventBusServiceCopy to Clipboard
Defined in
medusa/src/services/product-category.ts:32
manager_
• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
productCategoryRepo_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productCategoryRepo_: TreeRepositoryCopy to Clipboard<ProductCategoryCopy to Clipboard> & { addProductsCopy to Clipboard: (productCategoryIdCopy to Clipboard: stringCopy to Clipboard, productIdsCopy to Clipboard: stringCopy to Clipboard[]) => PromiseCopy to Clipboard<voidCopy to Clipboard> ; findOneWithDescendantsCopy to Clipboard: (queryCopy to Clipboard: FindOneOptionsCopy to Clipboard<ProductCategoryCopy to Clipboard>, treeScopeCopy to Clipboard: QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard>) => PromiseCopy to Clipboard<nullCopy to Clipboard | ProductCategoryCopy to Clipboard> ; getFreeTextSearchResultsAndCountCopy to Clipboard: (optionsCopy to Clipboard: ExtendedFindConfigCopy to Clipboard<ProductCategoryCopy to Clipboard>, q?Copy to Clipboard: stringCopy to Clipboard, treeScopeCopy to Clipboard: QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard>, includeTreeCopy to Clipboard: booleanCopy to Clipboard) => PromiseCopy to Clipboard<[ProductCategoryCopy to Clipboard[], numberCopy to Clipboard]> ; removeProductsCopy to Clipboard: (productCategoryIdCopy to Clipboard: stringCopy to Clipboard, productIdsCopy to Clipboard: stringCopy to Clipboard[]) => PromiseCopy to Clipboard<DeleteResultCopy to Clipboard> }
Defined in
medusa/src/services/product-category.ts:31
transactionManager_
• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
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
medusa/src/services/product-category.ts:34
Accessors
activeManager_
• ProtectedCopy to Clipboard getCopy to Clipboard activeManager_(): EntityManagerCopy to Clipboard
Returns
EntityManagerCopy to Clipboard
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
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
medusa/src/services/product-category.ts:314
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
medusa/src/interfaces/transaction-base-service.ts:56
create
▸ create(productCategoryInputCopy to Clipboard): PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
Creates a product category
Parameters
| Name | Type | Description |
|---|---|---|
productCategoryInputCopy to Clipboard | CreateProductCategoryInputCopy to Clipboard | parameters to create a product category |
Returns
PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
created product category
Defined in
medusa/src/services/product-category.ts:187
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
medusa/src/services/product-category.ts:268
fetchReorderConditions
▸ ProtectedCopy to Clipboard fetchReorderConditions(productCategoryCopy to Clipboard, inputCopy to Clipboard, shouldDeleteElement?Copy to Clipboard): ReorderConditionsCopy to Clipboard
Parameters
| Name | Type | Default value |
|---|---|---|
productCategoryCopy to Clipboard | ProductCategoryCopy to Clipboard | undefinedCopy to Clipboard |
inputCopy to Clipboard | UpdateProductCategoryInputCopy to Clipboard | undefinedCopy to Clipboard |
shouldDeleteElementCopy to Clipboard | booleanCopy to Clipboard | falseCopy to Clipboard |
Returns
ReorderConditionsCopy to Clipboard
Defined in
medusa/src/services/product-category.ts:349
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 | Description |
|---|---|---|
selectorCopy to Clipboard | TreeQuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> | Filter options for product category. |
configCopy to Clipboard | FindConfigCopy to Clipboard<ProductCategoryCopy to Clipboard> | Configuration for query. |
treeSelectorCopy to Clipboard | QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> | Filter options for product category tree relations |
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
medusa/src/services/product-category.ts:61
performReordering
▸ ProtectedCopy to Clipboard performReordering(repositoryCopy to Clipboard, conditionsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
repositoryCopy to Clipboard | TreeRepositoryCopy to Clipboard<ProductCategoryCopy to Clipboard> & { addProductsCopy to Clipboard: (productCategoryIdCopy to Clipboard: stringCopy to Clipboard, productIdsCopy to Clipboard: stringCopy to Clipboard[]) => PromiseCopy to Clipboard<voidCopy to Clipboard> ; findOneWithDescendantsCopy to Clipboard: (queryCopy to Clipboard: FindOneOptionsCopy to Clipboard<ProductCategoryCopy to Clipboard>, treeScopeCopy to Clipboard: QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard>) => PromiseCopy to Clipboard<nullCopy to Clipboard | ProductCategoryCopy to Clipboard> ; getFreeTextSearchResultsAndCountCopy to Clipboard: (optionsCopy to Clipboard: ExtendedFindConfigCopy to Clipboard<ProductCategoryCopy to Clipboard>, q?Copy to Clipboard: stringCopy to Clipboard, treeScopeCopy to Clipboard: QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard>, includeTreeCopy to Clipboard: booleanCopy to Clipboard) => PromiseCopy to Clipboard<[ProductCategoryCopy to Clipboard[], numberCopy to Clipboard]> ; removeProductsCopy to Clipboard: (productCategoryIdCopy to Clipboard: stringCopy to Clipboard, productIdsCopy to Clipboard: stringCopy to Clipboard[]) => PromiseCopy to Clipboard<DeleteResultCopy to Clipboard> } |
conditionsCopy to Clipboard | ReorderConditionsCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Defined in
medusa/src/services/product-category.ts:377
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
medusa/src/services/product-category.ts:333
retrieve
▸ retrieve(productCategoryIdCopy to Clipboard, config?Copy to Clipboard, selector?Copy to Clipboard, treeSelector?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> | |
treeSelectorCopy to Clipboard | QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
the product category.
Defined in
medusa/src/services/product-category.ts:139
retrieveByHandle
▸ retrieveByHandle(handleCopy to Clipboard, config?Copy to Clipboard, selector?Copy to Clipboard, treeSelector?Copy to Clipboard): PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
Retrieves a product category by handle.
Parameters
| Name | Type | Description |
|---|---|---|
handleCopy to Clipboard | stringCopy to Clipboard | the handle of the category |
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> | |
treeSelectorCopy to Clipboard | QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
the product category.
Defined in
medusa/src/services/product-category.ts:165
retrieve_
▸ ProtectedCopy to Clipboard retrieve_(config?Copy to Clipboard, selector?Copy to Clipboard, treeSelector?Copy to Clipboard): PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
A generic retrieve for fining product categories by different attributes.
Parameters
| Name | Type | Description |
|---|---|---|
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> | |
treeSelectorCopy to Clipboard | QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard> |
Returns
PromiseCopy to Clipboard<ProductCategoryCopy to Clipboard>
the product category.
Defined in
medusa/src/services/product-category.ts:102
shiftSiblings
▸ ProtectedCopy to Clipboard shiftSiblings(repositoryCopy to Clipboard, conditionsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
repositoryCopy to Clipboard | TreeRepositoryCopy to Clipboard<ProductCategoryCopy to Clipboard> & { addProductsCopy to Clipboard: (productCategoryIdCopy to Clipboard: stringCopy to Clipboard, productIdsCopy to Clipboard: stringCopy to Clipboard[]) => PromiseCopy to Clipboard<voidCopy to Clipboard> ; findOneWithDescendantsCopy to Clipboard: (queryCopy to Clipboard: FindOneOptionsCopy to Clipboard<ProductCategoryCopy to Clipboard>, treeScopeCopy to Clipboard: QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard>) => PromiseCopy to Clipboard<nullCopy to Clipboard | ProductCategoryCopy to Clipboard> ; getFreeTextSearchResultsAndCountCopy to Clipboard: (optionsCopy to Clipboard: ExtendedFindConfigCopy to Clipboard<ProductCategoryCopy to Clipboard>, q?Copy to Clipboard: stringCopy to Clipboard, treeScopeCopy to Clipboard: QuerySelectorCopy to Clipboard<ProductCategoryCopy to Clipboard>, includeTreeCopy to Clipboard: booleanCopy to Clipboard) => PromiseCopy to Clipboard<[ProductCategoryCopy to Clipboard[], numberCopy to Clipboard]> ; removeProductsCopy to Clipboard: (productCategoryIdCopy to Clipboard: stringCopy to Clipboard, productIdsCopy to Clipboard: stringCopy to Clipboard[]) => PromiseCopy to Clipboard<DeleteResultCopy to Clipboard> } |
conditionsCopy to Clipboard | ReorderConditionsCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Defined in
medusa/src/services/product-category.ts:415
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
medusa/src/interfaces/transaction-base-service.ts:37
transformParentIdToEntity
▸ ProtectedCopy to Clipboard transformParentIdToEntity(productCategoryInputCopy to Clipboard): PromiseCopy to Clipboard<CreateProductCategoryInputCopy to Clipboard | UpdateProductCategoryInputCopy to Clipboard>
Accepts an input object and transforms product_category_id into product_category entity.
Parameters
| Name | Type | Description |
|---|---|---|
productCategoryInputCopy to Clipboard | CreateProductCategoryInputCopy to Clipboard | UpdateProductCategoryInputCopy to Clipboard | params used to create/update |
Returns
PromiseCopy to Clipboard<CreateProductCategoryInputCopy to Clipboard | UpdateProductCategoryInputCopy to Clipboard>
transformed productCategoryInput
Defined in
medusa/src/services/product-category.ts:513
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
medusa/src/services/product-category.ts:221
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