How to Use File Module

In this document, you’ll learn about the different methods in the File Module's service and how to use them.

Resolve File Module's Service#

In your workflow's step, you can resolve the File Module's service from the Medusa container:

Code
1import { Modules } from "@medusajs/framework/utils"2import { createStep } from "@medusajs/framework/workflows-sdk"3
4const step1 = createStep(5  "step-1",6  async ({}, { container }) => {7    const fileModuleService = container.resolve(8      Modules.FILE9    )10    11    // TODO use fileModuleService12  } 13)

You can then use the File Module's service's methods in the step. The rest of this guide details these methods.

createFiles#

createFiles(data, sharedContext?): Promise<FileDTO[]>#

This method uploads files to the designated file storage system.

Example

Code
1const [file] = await fileModuleService.createFiles([{2  filename: "product.png",3  mimeType: "image/png",4  content: "somecontent" // binary string5}])

Parameters

Returns

createFiles(data, sharedContext?): Promise<FileDTO>#

This method uploads a file to the designated file storage system.

Example

Code
1const file = await fileModuleService.createFiles({2  filename: "product.png",3  mimeType: "image/png",4  content: "somecontent" // binary string5})

Parameters

Returns

deleteFiles#

deleteFiles(ids, sharedContext?): Promise<void>#

This method deletes files by their IDs.

Example

Code
await fileModuleService.deleteFiles(["file_123"])

Parameters

Returns

deleteFiles(id, sharedContext?): Promise<void>#

This method deletes a file by its ID.

Example

Code
await fileModuleService.deleteFiles("file_123")

Parameters

Returns

getAsBuffer#

This method retrieves a file by its ID and returns the file contents as a buffer. Under the hood, it will use the file provider that was used to upload the file to retrieve the buffer.

Example#

Code
1const contents = await fileModuleService.getAsBuffer("file_123")2contents.toString('utf-8')

Parameters#

Returns#

getDownloadStream#

This method retrieves a file by its ID and returns a stream to download the file. Under the hood, it will use the file provider that was used to upload the file to retrievethe stream.

Example#

Code
1const stream = await fileModuleService.getDownloadStream("file_123")2writeable.pipe(stream)

Parameters#

Returns#

getProvider#

This method returns the service of the configured File Module Provider in medusa-config.ts. This is useful if you want to execute custom methods defined in the provider's service or you need direct access to it.

Example#

Code
1const s3ProviderService = fileModuleService.getProvider()2// TODO: perform custom actions with the provider

Returns#

getUploadFileUrls#

getUploadFileUrls(data, sharedContext?): Promise<UploadFileUrlDTO>#

This method gets the upload URL for a file.

Example

Code
1const uploadInfo = await fileModuleService.getUploadFileUrls({2  filename: "product.png",3  mimeType: "image/png",4})

Parameters

Returns

getUploadFileUrls(data, sharedContext?): Promise<UploadFileUrlDTO[]>#

This method uploads files to the designated file storage system.

Example

Code
1const [uploadInfo] = await fileModuleService.getUploadFileUrls([{2  filename: "product.png",3  mimeType: "image/png",4}])

Parameters

Returns

listAndCountFiles#

This method is used to list files and their count. It only supports filtering by ID.

Example#

Code
const [files] = await fileModuleService.listAndCountFiles({ id: "file_123" })

Parameters#

Returns#

listFiles#

This method is used to list files. It only supports filtering by ID.

Example#

Code
const files = await fileModuleService.listFiles({ id: ["file_123", "file_456"] })

Parameters#

Returns#

retrieveFile#

This method retrieves a file with a downloadable URL by its ID.

Example#

Code
const file = await fileModuleService.retrieveFile("file_123")

Parameters#

Returns#