Interface FileSystemProvider

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

interface FileSystemProvider {
    exists(uri: URI): Promise<boolean>;
    existsSync(uri: URI): boolean;
    readBinary(uri: URI): Promise<Uint8Array<ArrayBufferLike>>;
    readBinarySync(uri: URI): Uint8Array;
    readDirectory(uri: URI): Promise<FileSystemNode[]>;
    readDirectorySync(uri: URI): FileSystemNode[];
    readFile(uri: URI): Promise<string>;
    readFileSync(uri: URI): string;
    stat(uri: URI): Promise<FileSystemNode>;
    statSync(uri: URI): FileSystemNode;
}

Implemented by

Index

Methods

exists existsSync readBinary readBinarySync readDirectory readDirectorySync readFile readFileSync stat statSync

Methods

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.
- Defined in packages/langium/src/workspace/file-system-provider.ts:37

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.
- Defined in packages/langium/src/workspace/file-system-provider.ts:42

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.
- Defined in packages/langium/src/workspace/file-system-provider.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.
- Defined in packages/langium/src/workspace/file-system-provider.ts:52

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.
- Defined in packages/langium/src/workspace/file-system-provider.ts:67

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.
- Defined in packages/langium/src/workspace/file-system-provider.ts:72

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.
- Defined in packages/langium/src/workspace/file-system-provider.ts:57

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
- Defined in packages/langium/src/workspace/file-system-provider.ts:62

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>
- Defined in packages/langium/src/workspace/file-system-provider.ts:26

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
- Defined in packages/langium/src/workspace/file-system-provider.ts:32