Class EmptyFileSystemProvider

Provides methods to interact with an abstract file system. The default implementation is based on the node.js fs API.

Implements

FileSystemProvider

Index

Constructors

Methods

exists existsSync readBinary readBinarySync readDirectory readDirectorySync readFile readFileSync stat statSync

Constructors

constructor

new EmptyFileSystemProvider(): EmptyFileSystemProvider
Returns EmptyFileSystemProvider

Methods

exists

exists(): Promise<boolean>
Checks if a file exists at the specified URI.

Returns Promise<boolean>
true if a file exists at the specified URI, false otherwise.
Implementation of FileSystemProvider.exists
- Defined in packages/langium/src/workspace/file-system-provider.ts:84

existsSync

existsSync(): boolean
Checks if a file exists at the specified URI synchronously.

Returns boolean
true if a file exists at the specified URI, false otherwise.
Implementation of FileSystemProvider.existsSync
- Defined in packages/langium/src/workspace/file-system-provider.ts:88

readBinary

readBinary(): Promise<Uint8Array<ArrayBufferLike>>
Reads a binary file asynchronously from a given URI.

Returns Promise<Uint8Array<ArrayBufferLike>>
The binary content of the file with the specified URI.
Implementation of FileSystemProvider.readBinary
- Defined in packages/langium/src/workspace/file-system-provider.ts:92

readBinarySync

readBinarySync(): Uint8Array
Reads a binary file synchronously from a given URI.

Returns Uint8Array
The binary content of the file with the specified URI.
Implementation of FileSystemProvider.readBinarySync
- Defined in packages/langium/src/workspace/file-system-provider.ts:96

readDirectory

readDirectory(): Promise<FileSystemNode[]>
Reads the directory information for the given URI.

Returns Promise<FileSystemNode[]>
The list of file system entries that are contained within the specified directory.
Implementation of FileSystemProvider.readDirectory
- Defined in packages/langium/src/workspace/file-system-provider.ts:108

readDirectorySync

readDirectorySync(): FileSystemNode[]
Reads the directory information for the given URI synchronously.

Returns FileSystemNode[]
The list of file system entries that are contained within the specified directory.
Implementation of FileSystemProvider.readDirectorySync
- Defined in packages/langium/src/workspace/file-system-provider.ts:112

readFile

readFile(): Promise<string>
Reads a document asynchronously from a given URI.

Returns Promise<string>
The string content of the file with the specified URI.
Implementation of FileSystemProvider.readFile
- Defined in packages/langium/src/workspace/file-system-provider.ts:100

readFileSync

readFileSync(): string
Reads a document synchronously from a given URI.

Returns string
The string content of the file with the specified
Implementation of FileSystemProvider.readFileSync
- Defined in packages/langium/src/workspace/file-system-provider.ts:104

stat

stat(_uri: URI): Promise<FileSystemNode>
Gets the status of a file or directory. The status includes meta data such as whether the node is a file or directory.
Parameters
- _uri: URI
Returns Promise<FileSystemNode>
Implementation of FileSystemProvider.stat
- Defined in packages/langium/src/workspace/file-system-provider.ts:77

statSync

statSync(_uri: URI): FileSystemNode
Gets the status of a file or directory synchronously. The status includes meta data such as whether the node is a file or directory.
Parameters
- _uri: URI
Returns FileSystemNode
Implementation of FileSystemProvider.statSync
- Defined in packages/langium/src/workspace/file-system-provider.ts:81