medusa-starter/src/services

Custom services

You may define custom services that will be registered on the global container by creating files in the /services directory that export an instance of BaseService.

// my.js

import { BaseService } from "medusa-interfaces";

class MyService extends BaseService {
  constructor({ productService }) {
    super();

    this.productService_ = productService
  }

  async getProductMessage() {
    const [product] = await this.productService_.list({}, { take: 1 })

    return `Welcome to ${product.title}!`
  }
}

export default MyService;

The first argument to the constructor is the global giving you access to easy dependency injection. The container holds all registered services from the core, installed plugins and from other files in the /services directory. The registration name is a camelCased version of the file name with the type appended i.e.: my.js is registered as myService, custom-thing.js is registerd as customThingService.

You may use the services you define here in custom endpoints by resolving the services defined.

import { Router } from "express"

export default () => {
  const router = Router()

  router.get("/hello-product", async (req, res) => {
    const myService = req.scope.resolve("myService")

    res.json({
      message: await myService.getProductMessage()
    })
  })

  return router;
}