feat: add JSDoc for workspace client

Signed-off-by: SuZhou-Joe <[email protected]>

Author: SuZhou-Joe

src/plugins/workspace/server/types.ts

@@ -29,12 +29,38 @@ export interface IRequestDetail {
 }
 
 export interface IWorkspaceClientImpl {
+  /**
+   * Setup function for workspace client, need to be called before any other methods.
+   * @param dep {@link CoreSetup}
+   * @returns a promise indicate if the setup has successed.
+   * @public
+   */
   setup(dep: CoreSetup): Promise<IResponse<boolean>>;
+  /**
+   * Set saved objects client that will be used inside the workspace client.
+   * @param savedObjects {@link SavedObjectsServiceStart}
+   * @returns void
+   * @public
+   */
   setSavedObjects(savedObjects: SavedObjectsServiceStart): void;
+  /**
+   * Create a workspace
+   * @param requestDetail {@link IRequestDetail}
+   * @param payload {@link WorkspaceAttribute}
+   * @returns a Promise with a new-created id for the workspace
+   * @public
+   */
   create(
     requestDetail: IRequestDetail,
     payload: Omit<WorkspaceAttribute, 'id'>
   ): Promise<IResponse<{ id: WorkspaceAttribute['id'] }>>;
+  /**
+   * List workspaces
+   * @param requestDetail {@link IRequestDetail}
+   * @param options {@link WorkspaceFindOptions}
+   * @returns a Promise with workspaces list
+   * @public
+   */
   list(
     requestDetail: IRequestDetail,
     options: WorkspaceFindOptions
@@ -45,13 +71,40 @@ export interface IWorkspaceClientImpl {
       } & Pick<SavedObjectsFindResponse, 'page' | 'per_page' | 'total'>
     >
   >;
+  /**
+   * Get the detail of a given workspace id
+   * @param requestDetail {@link IRequestDetail}
+   * @param id workspace id
+   * @returns a Promise with the detail of {@link WorkspaceAttribute}
+   * @public
+   */
   get(requestDetail: IRequestDetail, id: string): Promise<IResponse<WorkspaceAttribute>>;
+  /**
+   * Update the detail of a given workspace
+   * @param requestDetail {@link IRequestDetail}
+   * @param id workspace id
+   * @param payload {@link WorkspaceAttribute}
+   * @returns a Promise with a boolean result indicating if the update operation successed.
+   * @public
+   */
   update(
     requestDetail: IRequestDetail,
     id: string,
     payload: Omit<WorkspaceAttribute, 'id'>
   ): Promise<IResponse<boolean>>;
+  /**
+   * Delete a given workspace
+   * @param requestDetail {@link IRequestDetail}
+   * @param id workspace id
+   * @returns a Promise with a boolean result indicating if the delete operation successed.
+   * @public
+   */
   delete(requestDetail: IRequestDetail, id: string): Promise<IResponse<boolean>>;
+  /**
+   * Destroy the workspace client, should be called after the server disposes.
+   * @returns a Promise with a boolean result indicating if the destroy operation successed.
+   * @public
+   */
   destroy(): Promise<IResponse<boolean>>;
 }