@medusajs/utils
v2.22.7
Published
Medusa utilities functions shared by Medusa core and Modules
Keywords
Readme
@medusajs/utils is Medusa's shared utilities library: configuration helpers, module and data model builders, error classes, container keys, and helpers used across Medusa core, modules, and providers. Applications, plugins, and modules should import it through @medusajs/framework/utils, which re-exports this package; import @medusajs/utils directly only when you can't depend on @medusajs/framework.
At a glance
| | |
| --- | --- |
| Package | @medusajs/utils |
| Type | Core library |
| Import from | @medusajs/framework/utils |
Features
- Configuration:
defineConfigformedusa-config.tsandloadEnvfor loading.envfiles. - Modules:
Module,ModuleProvider,MedusaService, theModulesenum of module keys, anddefineLinkfor module links. - Data models: the
modelbuilder (DML) for defining data models. - Errors and container:
MedusaErrorandContainerRegistrationKeys. - Domain helpers: utilities and enums for products, pricing, orders, payments, fulfillment, promotions, totals (
BigNumber), and more.
Usage
import { model } from "@medusajs/framework/utils"
const Post = model.define("post", {
id: model.id().primaryKey(),
title: model.text(),
})
export default Post