Class VirtualFileSystemProvider

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

delete exists existsSync insert readBinary readBinarySync readDirectory readDirectorySync readFile readFileSync stat statSync

Constructors

constructor

new VirtualFileSystemProvider(): VirtualFileSystemProvider
Returns VirtualFileSystemProvider

Methods

delete

delete(uri: string | URI): void
Parameters
- uri: string | URI
Returns void
- Defined in packages/langium/src/test/virtual-file-system.ts:19

exists

exists(uri: URI): Promise<boolean>
Checks if a file exists at the specified URI.
Parameters
- uri: URI
Returns Promise<boolean>
true if a file exists at the specified URI, false otherwise.
Implementation of FileSystemProvider.exists
- Defined in packages/langium/src/test/virtual-file-system.ts:40

existsSync

existsSync(uri: URI): boolean
Checks if a file exists at the specified URI synchronously.
Parameters
- uri: URI
Returns boolean
true if a file exists at the specified URI, false otherwise.
Implementation of FileSystemProvider.existsSync
- Defined in packages/langium/src/test/virtual-file-system.ts:44

insert

insert(uri: string | URI, content: string): void
Parameters
- uri: string | URI
- content: string
Returns void
- Defined in packages/langium/src/test/virtual-file-system.ts:15

readBinary

readBinary(uri: URI): Promise<Uint8Array<ArrayBufferLike>>
Reads a binary file asynchronously from a given URI.
Parameters
- uri: URI
Returns Promise<Uint8Array<ArrayBufferLike>>
The binary content of the file with the specified URI.
Implementation of FileSystemProvider.readBinary
- Defined in packages/langium/src/test/virtual-file-system.ts:47

readBinarySync

readBinarySync(uri: URI): Uint8Array
Reads a binary file synchronously from a given URI.
Parameters
- uri: URI
Returns Uint8Array
The binary content of the file with the specified URI.
Implementation of FileSystemProvider.readBinarySync
- Defined in packages/langium/src/test/virtual-file-system.ts:51

readDirectory

readDirectory(uri: URI): Promise<FileSystemNode[]>
Reads the directory information for the given URI.
Parameters
- uri: 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/test/virtual-file-system.ts:69

readDirectorySync

readDirectorySync(uri: URI): FileSystemNode[]
Reads the directory information for the given URI synchronously.
Parameters
- uri: URI
Returns FileSystemNode[]
The list of file system entries that are contained within the specified directory.
Implementation of FileSystemProvider.readDirectorySync
- Defined in packages/langium/src/test/virtual-file-system.ts:73

readFile

readFile(uri: URI): Promise<string>
Reads a document asynchronously from a given URI.
Parameters
- uri: URI
Returns Promise<string>
The string content of the file with the specified URI.
Implementation of FileSystemProvider.readFile
- Defined in packages/langium/src/test/virtual-file-system.ts:56

readFileSync

readFileSync(uri: URI): string
Reads a document synchronously from a given URI.
Parameters
- uri: URI
Returns string
The string content of the file with the specified
Implementation of FileSystemProvider.readFileSync
- Defined in packages/langium/src/test/virtual-file-system.ts:60

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
  The URI of the file or directory.
Returns Promise<FileSystemNode>
Implementation of FileSystemProvider.stat
- Defined in packages/langium/src/test/virtual-file-system.ts:23

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
  The URI of the file or directory.
Returns FileSystemNode
Implementation of FileSystemProvider.statSync
- Defined in packages/langium/src/test/virtual-file-system.ts:27