Skip to content

Commit c27c15d

Browse files
committed
docs(desktop): document the import entry parser
1 parent 33e3a77 commit c27c15d

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎apps/desktop/src/main/desktop-executor/protocol.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,10 @@ export function parseCompletionOutcome(body: unknown): DesktopCompletionOutcome
195195
: null
196196
}
197197

198+
/**
199+
* Reads Sim's answer to an import entry: the id and name it stored the entry as. Null when either
200+
* is missing or empty, which the client reports as a malformed response.
201+
*/
198202
export function parseImportedEntry(body: unknown): DesktopImportedEntry | null {
199203
if (!isRecordLike(body) || typeof body.id !== 'string' || typeof body.name !== 'string')
200204
return null

0 commit comments

Comments
 (0)