Files
medusa-store/docs/content/advanced/backend/services/overview.md
Shahed Nasser 589cb18f98 docs: improved SEO of documentation (#3117)
* docs: added description to documentation pages

* docs: added more descriptions

* docs: finished improving meta description

* docs: added searchbox structured data

* docs: added breadcrumbs structured data

* docs: added how to structured data

* docs: improved 404 page

* docs: added how-to frontmatter option
2023-01-26 15:58:33 +02:00

1.7 KiB
Raw Blame History

description
description
Learn what Services are in the Medusa server. Services represent bundled helper methods that you want to use across the server.

Services

In this document, you'll learn about what Services are in Medusa.

What are Services

Services in Medusa represent bundled helper methods that you want to use across your server. By convention, they represent a certain entity or functionality in your server.

For example, you can use Medusas productService to get the list of products, as well as perform other functionalities related to products. Theres also an authService that provides functionalities like authenticating customers and users.

Custom services are TypeScript or JavaScript files located in the src/services directory of your Medusa Server installation. Each service should be a class that extends the TransactionBaseService class from the core Medusa package @medusajs/medusa.

Each file you create in src/services should hold one service and export it.

The file name is important as it determines the name of the service when you need to use it elsewhere. The name of the service will be registered as the camel-case version of the file name + Service at the end of the name.

For example, if the file name is hello.ts, the service will be registered as helloService. If the file name is hello-world.ts, the service name will be registered as helloWorldService.

The registration name of the service is important, as youll be referring to it when you want to get access to the service using dependency injection or in routes.


See Also