FileSystem | Theia TypeDoc

Hierarchy

FileSystem

Index

Methods

access

access(uri: string, mode?: number): Promise<boolean>

- Defined in packages/filesystem/src/common/filesystem.ts:175
Tests a user's permissions for the file or directory specified by URI. The mode argument is an optional integer that specifies the accessibility checks to be performed. Check FileAccess.Constants for possible values of mode. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. FileAccess.Constants.W_OK | FileAccess.Constants.R_OK). If mode is not defined, FileAccess.Constants.F_OK will be used instead.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.access instead

Parameters
- uri: string
- Optional mode: number
Returns Promise<boolean>

copy

copy(sourceUri: string, targetUri: string, options?: { overwrite?: boolean; recursive?: boolean }): Promise<FileStat>

- Defined in packages/filesystem/src/common/filesystem.ts:99
Copies the file to a path identified by the resource.

The optional parameter overwrite can be set to replace an existing file at the location.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.copy instead

Parameters
- sourceUri: string
- targetUri: string
- Optional options: { overwrite?: boolean; recursive?: boolean }
  - Optional overwrite?: boolean
  - Optional recursive?: boolean
Returns Promise<FileStat>

createFile

createFile(uri: string, options?: { content?: string; encoding?: string }): Promise<FileStat>

- Defined in packages/filesystem/src/common/filesystem.ts:109
Creates a new file with the given path. The returned promise will have the stat model object as a result.

The optional parameter content can be used as value to fill into the new file.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.create instead

Parameters
- uri: string
- Optional options: { content?: string; encoding?: string }
  - Optional content?: string
  - Optional encoding?: string
Returns Promise<FileStat>

createFolder

createFolder(uri: string): Promise<FileStat>

- Defined in packages/filesystem/src/common/filesystem.ts:117
Creates a new folder with the given path. The returned promise will have the stat model object as a result.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.createFolder instead

Parameters
- uri: string
Returns Promise<FileStat>

delete

delete(uri: string, options?: FileDeleteOptions): Promise<void>

- Defined in packages/filesystem/src/common/filesystem.ts:131
Deletes the provided file. The optional moveToTrash parameter allows to move the file to trash.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.delete instead

Parameters
- uri: string
- Optional options: FileDeleteOptions
Returns Promise<void>

exists

exists(uri: string): Promise<boolean>

- Defined in packages/filesystem/src/common/filesystem.ts:44
Finds out if a file identified by the resource exists.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.exists instead

Parameters
- uri: string
Returns Promise<boolean>

getCurrentUserHome

getCurrentUserHome(): Promise<undefined | FileStat>

- Defined in packages/filesystem/src/common/filesystem.ts:157
Returns a promise that resolves to a file stat representing the current user's home directory.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use EnvVariablesServer.getHomeDirUri instead

Returns Promise<undefined | FileStat>

getDrives

getDrives(): Promise<string[]>

- Defined in packages/filesystem/src/common/filesystem.ts:164
Resolves to an array of URIs pointing to the available drives on the filesystem.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use EnvVariablesServer.getDrives instead

Returns Promise<string[]>

getEncoding

getEncoding(uri: string): Promise<string>

- Defined in packages/filesystem/src/common/filesystem.ts:138
Returns the encoding of the given file resource.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908) use FileService.read without autoGuessEncoding option instead

Parameters
- uri: string
Returns Promise<string>

getFileStat

getFileStat(uri: string): Promise<undefined | FileStat>

- Defined in packages/filesystem/src/common/filesystem.ts:37
Returns the file stat for the given URI.

If the uri points to a folder it will contain one level of unresolved children.

undefined if a file for the given URI does not exist.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.resolve instead

Parameters
- uri: string
Returns Promise<undefined | FileStat>

getFsPath

getFsPath(uri: string): Promise<undefined | string>

- Defined in packages/filesystem/src/common/filesystem.ts:187
Returns the path of the given file URI, specific to the backend's operating system. If the URI is not a file URI, undefined is returned.

USE WITH CAUTION: You should always prefer URIs to paths if possible, as they are portable and platform independent. Paths should only be used in cases you directly interact with the OS, e.g. when running a command on the shell.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.fsPath instead

Parameters
- uri: string
Returns Promise<undefined | string>

getRoots

getRoots(): Promise<FileStat[]>

- Defined in packages/filesystem/src/common/filesystem.ts:150
Return list of available roots.

Returns Promise<FileStat[]>

guessEncoding

guessEncoding(uri: string): Promise<undefined | string>

- Defined in packages/filesystem/src/common/filesystem.ts:145
Guess encoding of a given file based on its content.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.read with autoGuessEncoding option instead

Parameters
- uri: string
Returns Promise<undefined | string>

move

move(sourceUri: string, targetUri: string, options?: FileMoveOptions): Promise<FileStat>

Moves the file to a new path identified by the resource.

The optional parameter overwrite can be set to replace an existing file at the location.

	missing	file	empty dir	dir
missing	x	x	x	x
file	✓	x	x	x
empty dir	✓	x	x	overwrite
dir	✓	x	overwrite	overwrite

deprecated: since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.move instead

Parameters

sourceUri: string
targetUri: string
Optional options: FileMoveOptions

Returns Promise<FileStat>

resolveContent

resolveContent(uri: string, options?: { encoding?: string }): Promise<{ content: string; stat: FileStat }>

- Defined in packages/filesystem/src/common/filesystem.ts:51
Resolve the contents of a file identified by the resource.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.read instead

Parameters
- uri: string
- Optional options: { encoding?: string }
  - Optional encoding?: string
Returns Promise<{ content: string; stat: FileStat }>

setContent

setContent(file: FileStat, content: string, options?: { encoding?: string }): Promise<FileStat>

- Defined in packages/filesystem/src/common/filesystem.ts:58
Updates the content replacing its previous value.

deprecated

since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.write instead

Parameters
- file: FileStat
- content: string
- Optional options: { encoding?: string }
  - Optional encoding?: string
Returns Promise<FileStat>

touchFile

touchFile(uri: string): Promise<FileStat>

- Defined in packages/filesystem/src/common/filesystem.ts:123
Creates a new empty file if the given path does not exist and otherwise will set the mtime and atime of the file to the current date.

Parameters
- uri: string
Returns Promise<FileStat>

updateContent

updateContent(file: FileStat, contentChanges: TextDocumentContentChangeEvent[], options?: { encoding?: string; overwriteEncoding?: string }): Promise<FileStat>

Updates the content replacing its previous value.

The optional parameter overwriteEncoding can be used to transform the encoding of a file.

	encoding	overwriteEncoding	behaviour
1	undefined	undefined	read & write file in default encoding
2	undefined	✓	read file in default encoding; write file in `overwriteEncoding`
3	✓	undefined	read & write file in `encoding`
4	✓	✓	read file in `encoding`; write file in `overwriteEncoding`

deprecated: since 1.4.0 - in order to support VS Code FS API (https://github.com/eclipse-theia/theia/pull/7908), use FileService.write instead

Parameters

file: FileStat
contentChanges: TextDocumentContentChangeEvent[]
Optional options: { encoding?: string; overwriteEncoding?: string }
- Optional encoding?: string
- Optional overwriteEncoding?: string

Hierarchy

Index

Methods

Methods

access

Parameters

uri: string

Optional mode: number

Returns Promise<boolean>

copy

Parameters

sourceUri: string

targetUri: string

Optional options: { overwrite?: boolean; recursive?: boolean }

Optional overwrite?: boolean

Optional recursive?: boolean

Returns Promise<FileStat>

createFile

Parameters

uri: string

Optional options: { content?: string; encoding?: string }

Optional content?: string

Optional encoding?: string

Returns Promise<FileStat>

createFolder

Parameters

uri: string

Returns Promise<FileStat>

delete

Parameters

uri: string

Optional options: FileDeleteOptions

Returns Promise<void>

exists

Parameters

uri: string

Returns Promise<boolean>

getCurrentUserHome

Returns Promise<undefined | FileStat>

getDrives

Returns Promise<string[]>

getEncoding

Parameters

uri: string

Returns Promise<string>

getFileStat

Parameters

uri: string

Returns Promise<undefined | FileStat>

getFsPath

Parameters

uri: string

Returns Promise<undefined | string>

getRoots

Returns Promise<FileStat[]>

guessEncoding

Parameters

uri: string

Returns Promise<undefined | string>

move

Parameters

sourceUri: string

targetUri: string

Optional options: FileMoveOptions

Returns Promise<FileStat>

resolveContent

Parameters

uri: string

Optional options: { encoding?: string }

Optional encoding?: string

Returns Promise<{ content: string; stat: FileStat }>

setContent

Parameters

file: FileStat

content: string

Optional options: { encoding?: string }

Optional encoding?: string

Returns Promise<FileStat>

touchFile

Parameters