Silo

Appearance

Interface: EditorService ​

Defined in: packages/sdk/src/editor-service.ts:155

The editor & document domain, exposed as ExtensionContext.editors. Open files into editor tabs, drive the active editor (save / close), and let editor viewers register save handlers. The single entry point for opening editors — prefer it over reaching into workspace/editor state.

Methods ​

open() ​

ts
open(path, opts?): void;

Defined in: packages/sdk/src/editor-service.ts:160

Open a file in an editor tab. Promotes an existing preview, focuses an already-open tab, or opens a new one.

Parameters ​

path ​

string

opts? ​

OpenFileOptions

Returns ​

void

openUntitled() ​

ts
openUntitled(opts?): void;

Defined in: packages/sdk/src/editor-service.ts:162

Open a fresh untitled editor.

Parameters ​

opts? ​

OpenFileOptions

Returns ​

void

openDiff() ​

ts
openDiff(spec, opts?): void;

Defined in: packages/sdk/src/editor-service.ts:167

Open a diff view. The content is supplied by the provider named in spec — the editor itself is content-agnostic.

Parameters ​

spec ​

OpenDiffSpec

opts? ​

OpenFileOptions

Returns ​

void

save() ​

ts
save(): boolean;

Defined in: packages/sdk/src/editor-service.ts:169

Save the active editor. Returns false if there's no active saveable editor.

Returns ​

boolean

saveAs() ​

ts
saveAs(): boolean;

Defined in: packages/sdk/src/editor-service.ts:171

Save-as the active editor. Returns false if unavailable.

Returns ​

boolean

closeActive() ​

ts
closeActive(): boolean;

Defined in: packages/sdk/src/editor-service.ts:173

Close the active dock panel. Returns false if there's nothing to close.

Returns ​

boolean

editorsFor() ​

ts
editorsFor(path): EditorViewInfo[];

Defined in: packages/sdk/src/editor-service.ts:182

List the editor views that match path (or null for an untitled buffer), highest-priority first, each flagged whether it's the one the host resolves by default. Read-only enumeration for building "Open With" menus and the breadcrumb view-switcher. Returns [] only when nothing matches — in practice never empty for a real path, since the core text editor matches everything.

Parameters ​

path ​

string | null

Returns ​

EditorViewInfo[]

setViewType() ​

ts
setViewType(
   editorId, 
   viewType, 
   opts?): void;

Defined in: packages/sdk/src/editor-service.ts:191

Switch an already-open editor tab to a different view in place — without closing and reopening it — and persist the choice on the tab. No-op if the editor isn't found, viewType names no registered editor, or that editor doesn't match the tab's file. The panel remounts onto the new view, so per-instance state (scroll, selection) resets — expected, it's a different presenter.

Parameters ​

editorId ​

string

viewType ​

string

opts? ​
workspaceId? ​

string

Returns ​

void

registerSaveHandler() ​

ts
registerSaveHandler(editorId, handlers): Disposable;

Defined in: packages/sdk/src/editor-service.ts:201

Register save handlers for an editor instance (by its editorId), so the active-editor save / saveAs dispatch to it while it's focused. Dispose to unregister (do this when the editor unmounts).

Parameters ​

editorId ​

string

handlers ​

EditorSaveHandlers

Returns ​

Disposable

registerDiffContentProvider() ​

ts
registerDiffContentProvider(providerId, provider): Disposable;

Defined in: packages/sdk/src/editor-service.ts:210

Register a DiffContentProvider under providerId. A diff opened with that providerId (see OpenDiffSpec) resolves its two sides through this provider, on every mount. Dispose to unregister.

Parameters ​

providerId ​

string

provider ​

DiffContentProvider

Returns ​

Disposable