Interface CustomDocumentOpenContext

Additional information about the opening custom document.

interface CustomDocumentOpenContext {
backupId?: string;
untitledDocumentData?: Uint8Array;
}

Properties

backupId?: string

The id of the backup to restore the document from or undefined if there is no backup.

If this is provided, your extension should restore the editor from the backup instead of reading the file from the user's workspace.

untitledDocumentData?: Uint8Array

If the URI is an untitled file, this will be populated with the byte data of that file.

If this is provided, your extension should utilize this byte data rather than executing fs APIs on the URI passed in.