fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
103 lines
3.1 KiB
Plaintext
103 lines
3.1 KiB
Plaintext
---
|
||
description: 'Learn how to create a service in Medusa. This guide also includes how to use services in other services, subscribers, and endpoints.'
|
||
addHowToData: true
|
||
---
|
||
|
||
import Troubleshooting from '@site/src/components/Troubleshooting'
|
||
import ServiceLifetimeSection from '../../troubleshooting/awilix-resolution-error/_service-lifetime.md'
|
||
|
||
# How to Extend a Service
|
||
|
||
In this document, you’ll learn how to extend a core service in Medusa.
|
||
|
||
## Overview
|
||
|
||
Medusa’s core services cover a wide range of functionalities related to each domain or entity. You can extend these services to add custom methods or override existing methods.
|
||
|
||
### Word of Caution about Overriding
|
||
|
||
Extending services to add new methods shouldn't cause any issues within your commerce application. However, if you extend them to override their existing methods, you should be aware that this could have negative implications, such as unanticipated bugs, especially when you try to upgrade the core Medusa package to a newer version.
|
||
|
||
---
|
||
|
||
## Step 1: Create the Service File
|
||
|
||
In your Medusa backend, create the file `src/services/product.ts`. This file will hold your extended service.
|
||
|
||
Note that the name of the file must be the same as the name of the original service in the core package. So, if you’re extending the `ProductService`, the file’s name should be `product.ts`. On the other hand, if you’re extending the `CustomerService`, the file’s name should be `customer.ts`.
|
||
|
||
---
|
||
|
||
## Step 2: Implementing the Service
|
||
|
||
In the file, you can import the original service from the Medusa core, then create your service that extends the core service.
|
||
|
||
For example, to extend the Product service:
|
||
|
||
```ts title=src/services/product.ts
|
||
import {
|
||
ProductService as MedusaProductService,
|
||
} from "@medusajs/medusa"
|
||
|
||
class ProductService extends MedusaProductService {
|
||
// TODO add customizations
|
||
}
|
||
|
||
export default ProductService
|
||
```
|
||
|
||
Notice that you alias the `ProductService` of the core to avoid naming conflicts.
|
||
|
||
Within the service, you can add new methods or extend existing ones.
|
||
|
||
You can also change the lifetime of the service:
|
||
|
||
```ts title=src/services/product.ts
|
||
import { Lifetime } from "awilix"
|
||
import {
|
||
ProductService as MedusaProductService,
|
||
} from "@medusajs/medusa"
|
||
|
||
class ProductService extends MedusaProductService {
|
||
// The default life time for a core service is SINGLETON
|
||
static LIFE_TIME = Lifetime.SCOPED
|
||
|
||
// ...
|
||
}
|
||
|
||
export default ProductService
|
||
```
|
||
|
||
You can learn more details about the service lifetime and other considerations when creating a service in the [Create Service documentation](./create-service.mdx).
|
||
|
||
---
|
||
|
||
## Step 3: Test it Out
|
||
|
||
To test out your customization, start by transpiling your files by running the following command in the root directory of the Medusa backend:
|
||
|
||
```bash npm2yarn
|
||
npm run build
|
||
```
|
||
|
||
Then, start the backend:
|
||
|
||
```bash npm2yarn
|
||
npx medusa develop
|
||
```
|
||
|
||
You should see the customizations you made in effect.
|
||
|
||
---
|
||
|
||
## Troubleshooting
|
||
|
||
<Troubleshooting
|
||
sections={[
|
||
{
|
||
title: 'AwilixResolutionError: Could Not Resolve X (Service Lifetime)',
|
||
content: <ServiceLifetimeSection />
|
||
}
|
||
]}
|
||
/>
|