Skip to content

Commit 03d6559

Browse files
committed
Add comments to types pulled from Code
1 parent e93430c commit 03d6559

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

src/node/main.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ export const shouldSpawnCliProcess = (args: UserProvidedArgs): boolean => {
2323
)
2424
}
2525

26+
/**
27+
* Arguments supported by Code's socket. It can be used to perform actions from
28+
* the CLI in a running instance of Code (for example to open a file).
29+
*/
2630
export interface OpenCommandPipeArgs {
2731
type: "open"
2832
fileURIs?: string[]

src/node/routes/vscode.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ import { SocketProxyProvider } from "../socket"
1212
import { isFile, loadAMDModule } from "../util"
1313
import { Router as WsRouter } from "../wsRouter"
1414

15+
/**
16+
* This is the API of Code's web client server. code-server delegates requests
17+
* to Code here.
18+
*/
1519
export interface IServerAPI {
1620
handleRequest(req: http.IncomingMessage, res: http.ServerResponse): Promise<void>
1721
handleUpgrade(req: http.IncomingMessage, socket: net.Socket): void

0 commit comments

Comments
 (0)