Skip to content

Commit a00e57d

Browse files
committed
fix: added tsdoc to showSolution
1 parent bc7689b commit a00e57d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/leetCodeExecutor.ts

+11
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,17 @@ class LeetCodeExecutor implements Disposable {
115115
}
116116
}
117117

118+
/**
119+
* This function returns solution of a problem identified by input
120+
*
121+
* @remarks
122+
* Even though this function takes the needTranslation flag, it is important to note that as of vsc-leetcode-cli 2.8.0, leetcode-cli doesn't support querying solution on CN endpoint yet. So this flag doesn't have any effect right now.
123+
*
124+
* @param input - parameter to pass to cli that can identify a problem
125+
* @param language - the source code language of the solution desired
126+
* @param needTranslation - whether or not to use endPoint translation on solution query
127+
* @returns promise of the solution string
128+
*/
118129
public async showSolution(input: string, language: string, needTranslation: boolean): Promise<string> {
119130
// solution don't support translation
120131
const cmd: string[] = [await this.getLeetCodeBinaryPath(), "show", input, "--solution", "-l", language];

0 commit comments

Comments
 (0)