chore: small tsdoc changes for remoteLink and remoteQueryConfig (#10837)

This commit is contained in:
Shahed Nasser
2025-01-06 14:01:46 +02:00
committed by GitHub
parent 8224466dd7
commit c440068d49
3 changed files with 11 additions and 3 deletions

View File

@@ -111,6 +111,8 @@ export interface MedusaRequest<
/**
* An object containing fields and variables to be used with the remoteQuery
*
* @version 2.1.4
*/
queryConfig: {
fields: string[]
@@ -118,7 +120,7 @@ export interface MedusaRequest<
}
/**
* @deprecated. Instead use "req.queryConfig"
* @deprecated Use {@link queryConfig} instead.
*/
remoteQueryConfig: MedusaRequest["queryConfig"]

View File

@@ -36,9 +36,12 @@ import { AwilixContainer, ResolveOptions } from "awilix"
declare module "@medusajs/types" {
export interface ModuleImplementations {
/**
* @deprecated. Instead use "link"
* @deprecated use {@link ContainerRegistrationKeys.LINK} instead.
*/
[ContainerRegistrationKeys.REMOTE_LINK]: Link
/**
* @version 2.1.4
*/
[ContainerRegistrationKeys.LINK]: Link
[ContainerRegistrationKeys.CONFIG_MODULE]: ConfigModule
[ContainerRegistrationKeys.PG_CONNECTION]: Knex<any>

View File

@@ -6,9 +6,12 @@ export const ContainerRegistrationKeys = {
REMOTE_QUERY: "remoteQuery",
QUERY: "query",
/**
* @deprecated. Instead use "ContainerRegistrationKeys.LINK"
* @deprecated use {@link ContainerRegistrationKeys.LINK} instead.
*/
REMOTE_LINK: "remoteLink",
/**
* @version 2.1.4
*/
LINK: "link",
FEATURE_FLAG_ROUTER: "featureFlagRouter",
} as const