FileService

class

Properties

canHandle()

Signature

canHandle(uri: Uri): boolean

Parameters

• uri (Uri) - monaco.Uri to test.

Returns

boolean

close()

Signature

close(uri: Uri): Promise<void>

Parameters

• uri (Uri)

Returns

Promise<void>

contentChange()

Signature

contentChange(uri: Uri): Observable<IContent | undefined>

Parameters

• uri (Uri) - The URI of the file.

Returns

Observable<IContent | undefined>

copy()

Signature

copy(source: IFile[], destination: IFile): Promise<void>

Parameters

• source (IFile[])
• destination (IFile)

Returns

Promise<void>

createDirectory()

Signature

createDirectory(parent: IFile, dirName: string): Promise<void>

Parameters

• parent (IFile)
• dirName (string)

Returns

Promise<void>

createFile()

Signature

createFile(parent: IFile, fileName: string): Promise<void>

Parameters

• parent (IFile)
• fileName (string)

Returns

Promise<void>

deactivate()

Signature

deactivate(): void

Returns

void

delete()

Signature

delete(entry: IFile): Promise<void>

Parameters

• entry (IFile)

Returns

Promise<void>

deleteAll()

Signature

deleteAll(entries: IFile[]): Promise<void>

Parameters

• entries (IFile[])

Returns

Promise<void>

emitTreeChange()

Signature

emitTreeChange(): void

Returns

void

entryId()

Signature

entryId(uri: Uri): string

Parameters

• uri (Uri)

Returns

string

entryName()

Signature

entryName(uri: Uri): string

Parameters

• uri (Uri) - The URI for which to get the entry name.

Returns

string

find()

Signature

find(uri: Uri): Promise<IFile | undefined>

Parameters

• uri (Uri) - The uri to find.

Returns

Promise<IFile | undefined>

findAll()

Signature

findAll(predicate: FilePredicate): IFile[]

Parameters

• predicate (FilePredicate) - The predicate to filter the files.

Returns

IFile[]

findChildren()

Signature

findChildren(entry: IFile): IFile[]

Parameters

• entry (IFile) - The entry to find its children.

Returns

IFile[]

getProvider()

Signature

getProvider(scheme: string): T | undefined

Parameters

• scheme (string)

Returns

T | undefined

hasCapability()

Signature

hasCapability(uri: Uri, capability: FileSystemProviderCapabilities): boolean

Parameters

• uri (Uri) - monaco.Uri to test.
• capability (FileSystemProviderCapabilities) - The required capability.

Returns

boolean

hasCapabilityForAnyProvider()

Signature

hasCapabilityForAnyProvider(capability: FileSystemProviderCapabilities): boolean

Parameters

• capability (FileSystemProviderCapabilities)

Returns

boolean

hasProvider()

Signature

hasProvider(scheme: string): boolean

Parameters

• scheme (string)

Returns

boolean

isAncestor()

Signature

isAncestor(uri: Uri, candidate: Uri): boolean

Parameters

• uri (Uri) - The uri to test.
• candidate (Uri) - The candidate to test.

Returns

boolean

isDirty()

Signature

isDirty(uri?: Uri): boolean

Parameters

• uri (Uri) - An optional uri to test.

Returns

boolean

isParent()

Signature

isParent(uri: Uri, candidate: Uri): boolean

Parameters

• uri (Uri) - The uri to test.
• candidate (Uri) - The candidate to test.

Returns

boolean

isRoot()

Signature

isRoot(uri: Uri): boolean

Parameters

• uri (Uri) - The uri to test.

Returns

boolean

listProviders()

Signature

listProviders(): readonly IFileSystemProvider[]

Returns

readonly IFileSystemProvider[]

move()

Signature

move(source: IFile, destination: IFile): Promise<void>

Parameters

• source (IFile)
• destination (IFile)

Returns

Promise<void>

normalize()

Signature

normalize(entries: IFile[]): IFile[]

Parameters

• entries (IFile[]) - The entries to normalize.

Returns

IFile[]

open()

Signature

open(uri: Uri): Promise<IContent>

Parameters

• uri (Uri) - The URI of the file to open.

Returns

Promise<IContent>

readFile()

Signature

readFile(uri: Uri): Promise<string>

Parameters

• uri (Uri)

Returns

Promise<string>

refresh()

Signature

refresh(): Promise<void>

Returns

Promise<void>

registerFolders()

Signature

registerFolders(...folders: IFolder[]): Promise<void>

Parameters

• ...folders (IFolder[]) - The folders to register.

Returns

Promise<void>

registerFolderSorter()

Signature

registerFolderSorter(sorter: (a: IFolder, b: IFolder) => number): void

Parameters

• sorter ((a: IFolder, b: IFolder) => number) - The sorter function.

Returns

void

registerNameProvider()

Signature

registerNameProvider(provider: (uri: Uri) => string): void

Parameters

• provider ((uri: Uri) => string) - The name provider function.

Returns

void

registerProvider()

Signature

registerProvider(provider: IFileSystemProvider): void

Parameters

• provider (IFileSystemProvider) - The file system provider that should be registered.

Returns

void

rename()

Signature

rename(entry: IFile, newName: string): Promise<void>

Parameters

• entry (IFile)
• newName (string)

Returns

Promise<void>

replaceFolder()

Signature

replaceFolder(oldUri: Uri, newFolder: IFolder): Promise<void>

Parameters

• oldUri (Uri) - The URI of the folder to be replaced.
• newFolder (IFolder) - The new folder object.

Returns

Promise<void>

save()

Signature

save(uri: Uri): Promise<void>

Parameters

• uri (Uri) - monaco.Uri to save.

Returns

Promise<void>

search()

Signature

search(form: SearchForm): Promise<SearchResult<Uri>[]>

Parameters

• form (SearchForm) - The search form.

Returns

Promise<SearchResult<Uri>[]>

unregisterFolders()

Signature

unregisterFolders(...uris: Uri[]): void

Parameters

• ...uris (Uri[]) - The URIs of the folders to unregister.

Returns

void

update()

Signature

update(uri: Uri, content: string): void

Parameters

• uri (Uri) - The URI of the file to update.
• content (string) - The new content of the file.

Returns

void

upload()

Signature

upload(file: File, destination: IFile): Promise<void>

Parameters

• file (File)
• destination (IFile)

Returns

Promise<void>

writeFile()

Signature

writeFile(uri: Uri, content: string): Promise<void>

Parameters

• uri (Uri)
• content (string)

Returns

Promise<void>