Class DatalayerFileSystemProvider

Virtual file system provider that maps Datalayer documents to clean URI scheme. Allows VS Code to display "datalayer://Space Name/Notebook.ipynb" instead of temp paths. Persists mappings across VS Code restarts using globalState.

Example

const provider = DatalayerFileSystemProvider.getInstance();
provider.initialize(context);
const virtualUri = provider.registerMapping('My Space/notebook.ipynb', '/tmp/real-path.ipynb');

Implements

FileSystemProvider

Constructors

`Private`constructor

new DatalayerFileSystemProvider(): DatalayerFileSystemProvider
Returns DatalayerFileSystemProvider
- Defined in src/providers/documentsFileSystemProvider.ts:46

Properties

`Private`_emitter

_emitter: EventEmitter<FileChangeEvent[]> = ...

`Private` `Optional`context

context?: ExtensionContext

`Readonly`onDidChangeFile

onDidChangeFile: Event<FileChangeEvent[]> = ...

Event fired when files change in the virtual file system.

`Private`realToVirtual

realToVirtual: Map<string, Uri> = ...

`Private`virtualToReal

virtualToReal: Map<string, string> = ...

`Private` `Static`instance

instance: DatalayerFileSystemProvider

`Private` `Static` `Readonly`STORAGE_KEY

STORAGE_KEY: "datalayer.documentMappings"

Methods

createDirectory

createDirectory(uri: Uri): void
Create a new directory.
Parameters
- uri: Uri
  The URI of the directory to create
Returns void
Implementation of vscode.FileSystemProvider.createDirectory
- Defined in src/providers/documentsFileSystemProvider.ts:258

delete

delete(uri: Uri, options: { recursive: boolean }): void
Delete a file or directory.
Parameters
- uri: Uri
  The URI to delete
- options: { recursive: boolean }
  Delete options (recursive flag)
Returns void
Implementation of vscode.FileSystemProvider.delete
- Defined in src/providers/documentsFileSystemProvider.ts:331

dispose

dispose(): void
Clean up all mappings.

Returns void
- Defined in src/providers/documentsFileSystemProvider.ts:396

getRealPath

getRealPath(uri: Uri): string
Get the real file path for a virtual URI.
Parameters
- uri: Uri
  Virtual URI to resolve
Returns string
Real file path or undefined if not found
- Defined in src/providers/documentsFileSystemProvider.ts:157

getVirtualUri

getVirtualUri(realPath: string): Uri
Get the virtual URI for a real file path.
Parameters
- realPath: string
  Real file path to resolve
Returns Uri
Virtual URI or undefined if not found
- Defined in src/providers/documentsFileSystemProvider.ts:170

initialize

initialize(context: ExtensionContext): void
Initialize the provider with extension context for persistent storage. Restores any previously saved mappings from globalState.
Parameters
- context: ExtensionContext
  Extension context for accessing globalState
Returns void
- Defined in src/providers/documentsFileSystemProvider.ts:65

`Private`loadMappings

loadMappings(): void
Load saved mappings from persistent storage. Only restores mappings where the real file still exists.

Returns void
- Defined in src/providers/documentsFileSystemProvider.ts:74

readDirectory

readDirectory(uri: Uri): [string, FileType][]
Read the contents of a directory.
Parameters
- uri: Uri
  The URI of the directory
Returns [string, FileType][]
Array of [name, type] tuples representing directory contents
Implementation of vscode.FileSystemProvider.readDirectory
- Defined in src/providers/documentsFileSystemProvider.ts:232

readFile

readFile(uri: Uri): Uint8Array
Read the contents of a file. Mappings are restored from persistent storage during initialization, so this should always find the real path for valid documents.
Parameters
- uri: Uri
  The URI of the file to read
Returns Uint8Array
The file contents as a byte array
Implementation of vscode.FileSystemProvider.readFile
- Defined in src/providers/documentsFileSystemProvider.ts:277

registerMapping

registerMapping(virtualPath: string, realPath: string): Uri
Register a mapping between a virtual URI and a real file path. Persists the mapping to globalState for restoration after restart.
Parameters
- virtualPath: string
  Clean path for the virtual URI (e.g., "Space Name/Notebook.ipynb")
- realPath: string
  Actual file system path to the document
Returns Uri
The created virtual URI with datalayer:// scheme
- Defined in src/providers/documentsFileSystemProvider.ts:126

removeMapping

removeMapping(uri: Uri): void
Remove a mapping for a closed document. Updates persistent storage.
Parameters
- uri: Uri
  Virtual URI to remove
Returns void
- Defined in src/providers/documentsFileSystemProvider.ts:180

rename

rename(oldUri: Uri, newUri: Uri, options: { overwrite: boolean }): void
Rename or move a file or directory.
Parameters
- oldUri: Uri
  The current URI
- newUri: Uri
  The new URI
- options: { overwrite: boolean }
  Rename options (overwrite flag)
Returns void
Implementation of vscode.FileSystemProvider.rename
- Defined in src/providers/documentsFileSystemProvider.ts:360

`Private`saveMappings

saveMappings(): Promise<void>
Save current mappings to persistent storage.

Returns Promise<void>
- Defined in src/providers/documentsFileSystemProvider.ts:101

stat

stat(uri: Uri): FileStat
Get metadata about a file or directory.
Parameters
- uri: Uri
  The URI of the file or directory
Returns FileStat
Metadata about the file or directory
Implementation of vscode.FileSystemProvider.stat
- Defined in src/providers/documentsFileSystemProvider.ts:209

watch

watch(_uri: Uri): Disposable
Watch a file or directory for changes.
Parameters
- _uri: Uri
  The URI to watch
Returns Disposable
A disposable that stops watching when disposed
Implementation of vscode.FileSystemProvider.watch
- Defined in src/providers/documentsFileSystemProvider.ts:199

writeFile

writeFile(
    uri: Uri,
    content: Uint8Array,
    options: { create: boolean; overwrite: boolean },
): void
Write data to a file.
Parameters
- uri: Uri
  The URI of the file to write
- content: Uint8Array
  The content to write
- options: { create: boolean; overwrite: boolean }
  Write options (create and overwrite flags)
Returns void
Implementation of vscode.FileSystemProvider.writeFile
- Defined in src/providers/documentsFileSystemProvider.ts:298

`Static`getInstance

getInstance(): DatalayerFileSystemProvider
Gets the singleton instance of DatalayerFileSystemProvider.

Returns DatalayerFileSystemProvider
The singleton instance
- Defined in src/providers/documentsFileSystemProvider.ts:52

Class DatalayerFileSystemProvider

Example

Implements

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns DatalayerFileSystemProvider

Properties

Private_emitter

Private Optionalcontext

ReadonlyonDidChangeFile

PrivaterealToVirtual

PrivatevirtualToReal

Private Staticinstance

Private Static ReadonlySTORAGE_KEY

Methods

createDirectory

Parameters

Returns void

delete

Parameters

Returns void

dispose

Returns void

getRealPath

Parameters

Returns string

getVirtualUri

Parameters

Returns Uri

initialize

Parameters

Returns void

PrivateloadMappings

Returns void

readDirectory

Parameters

Returns [string, FileType][]

readFile

Parameters

Returns Uint8Array

registerMapping

Parameters

Returns Uri

removeMapping

Parameters

Returns void

rename

Parameters

Returns void

PrivatesaveMappings

Returns Promise<void>

stat

Parameters

Returns FileStat

watch

Parameters

Returns Disposable

writeFile

Parameters

Returns void

StaticgetInstance

Returns DatalayerFileSystemProvider

Settings

On This Page

`Private`constructor

`Private`_emitter

`Private` `Optional`context

`Readonly`onDidChangeFile

`Private`realToVirtual

`Private`virtualToReal

`Private` `Static`instance

`Private` `Static` `Readonly`STORAGE_KEY

`Private`loadMappings

`Private`saveMappings

`Static`getInstance