feat(medusa-js, medusa-react): Update jsdoc with experimental annotation for sales channels (#1811)

**What**
- Add tag to indicate methods are part of an experimental feature under development

**Why**
- To notify developers because we cant support featureflags in the same way from the client side libraries.
This commit is contained in:
Philip Korsholm
2022-07-06 17:38:26 +02:00
committed by GitHub
parent 9d19cc0818
commit 428a801293
3 changed files with 19 additions and 2 deletions

View File

@@ -6,7 +6,9 @@ import { ResponsePromise } from "../../typings"
import BaseResource from "../base"
class AdminSalesChannelsResource extends BaseResource {
/**
/** retrieve a sales channel
* @experimental This feature is under development and may change in the future.
* To use this feature please enable featureflag `sales_channels` in your medusa backend project.
* @description gets a sales channel
* @returns a medusa sales channel
*/
@@ -23,7 +25,10 @@ class AdminSalesChannelsResource extends BaseResource {
customHeaders: Record<string, any> = {}
): ResponsePromise<any> {}*/
/** @description updates a sales channel
/** update a sales channel
* @experimental This feature is under development and may change in the future.
* To use this feature please enable featureflag `sales_channels` in your medusa backend project.
* @description updates a sales channel
* @returns the updated medusa sales channel
*/
update(

View File

@@ -8,6 +8,12 @@ import { useMedusa } from "../../../contexts"
import { buildOptions } from "../../utils/buildOptions"
import { adminSalesChannelsKeys } from "./queries"
/** update a sales channel
* @experimental This feature is under development and may change in the future.
* To use this feature please enable featureflag `sales_channels` in your medusa backend project.
* @description updates a sales channel
* @returns the updated medusa sales channel
*/
export const useAdminUpdateSalesChannel = (
id: string,
options?: UseMutationOptions<

View File

@@ -13,6 +13,12 @@ export const adminSalesChannelsKeys = queryKeysFactory(
type SalesChannelsQueryKeys = typeof adminSalesChannelsKeys
/** retrieve a sales channel
* @experimental This feature is under development and may change in the future.
* To use this feature please enable featureflag `sales_channels` in your medusa backend project.
* @description gets a sales channel
* @returns a medusa sales channel
*/
export const useAdminSalesChannel = (
id: string,
options?: UseQueryOptionsWrapper<