Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Vincent Fugnitto <vincent.fugnitto@ericsson.com>
  • Loading branch information
tortmayr and vince-fugnitto authored Oct 8, 2020
1 parent aa01eb6 commit ff5fb65
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
9 changes: 4 additions & 5 deletions packages/filesystem/src/browser/file-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ export interface FileSystemProviderRegistrationEvent {

/**
* Represents the `FileSystemProviderCapabilitiesChange` event.
* This event is fired by the {@link FileService} if the capabilites of one of its managed
* This event is fired by the {@link FileService} if the capabilities of one of its managed
* {@link FileSystemProvider}s have changed.
*/
export interface FileSystemProviderCapabilitiesChangeEvent {
Expand Down Expand Up @@ -464,7 +464,7 @@ export class FileService {
/**
* Try to resolve file information and metadata for the given resource.
* @param resource `URI` of the resource that should be resolved.
* @param options Options to customize the resolvment process.
* @param options Options to customize the resolvement process.
*
* @return A promise that resolves if the resource could be successfully resolved.
*/
Expand Down Expand Up @@ -561,7 +561,7 @@ export class FileService {

/**
* Try to resolve file information and metadata for all given resource.
* @param toResolve An array of all the resources (and corresponding resolvment options) that should be resolved.
* @param toResolve An array of all the resources (and corresponding resolvement options) that should be resolved.
*
* @returns A promise of all resolved resources. The promise is not rejected if any of the given resources cannot be resolved.
* Instead this is reflected with the `success` flag of the corresponding {@link ResolveFileResult}.
Expand All @@ -581,7 +581,7 @@ export class FileService {
}

/**
* Tests if the given resource exists in the filesytem.
* Tests if the given resource exists in the filesystem.
* @param resource `URI` of the resource which should be tested.
* @throws Will throw an error if no {@link FileSystemProvider} is registered for the given resource.
*
Expand Down Expand Up @@ -1776,4 +1776,3 @@ export class FileService {
this.watcherErrorHandler.handleError();
}
}

10 changes: 5 additions & 5 deletions packages/filesystem/src/common/files.ts
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ export function ensureFileSystemProviderError(error?: Error): Error {

export const FileSystemProvider = Symbol('FileSystemProvider');
/**
* A {@link FileSystemProvider} provides the capabilities to read, write, discover, and to mangage files and folders
* A {@link FileSystemProvider} provides the capabilities to read, write, discover, and to manage files and folders
* of the underlying (potentially virtual) file system. {@link FileSystemProvider}s can be used to serve files from both the
* local disk as well as remote locations like ftp-servers, REST-services etc. A {@link FileSystemProvider} is registered for a certain
* scheme and can handle all resources whose uri does conform to that scheme.
Expand All @@ -581,7 +581,7 @@ export interface FileSystemProvider {
/**
* Watch the given resource and react to changes by firing the {@link FileSystemProvider#onDidChangeFile} event.
* @param resource `URI` of the resource to be watched.
* @param opts Options to define if the resource should be watched recursivly and to
* @param opts Options to define if the resource should be watched recursively and to
* provide a set of resources that should be excluded from watching.
*
* @returns A `Disposable` that can be invoked to stop watching the resource.
Expand All @@ -606,14 +606,14 @@ export interface FileSystemProvider {
* Retrieve the content of a given directory.
* @param resource The `URI` of the directory.
*
* @returns A map containg the {@link FileType} for each child resource (uri).
* @returns A map containing the {@link FileType} for each child resource (uri).
*/
readdir(resource: URI): Promise<[string, FileType][]>;

/**
* Delete the given resource.
* @param resource The `URI` of the resource to delete.
* @param opts Options to define if files should be deleted recursivly and if the trash should be used.
* @param opts Options to define if files should be deleted recursively and if the trash should be used.
*/
delete(resource: URI, opts: FileDeleteOptions): Promise<void>;

Expand Down Expand Up @@ -700,7 +700,7 @@ export interface FileSystemProvider {
export interface FileSystemProviderWithAccessCapability extends FileSystemProvider {
/**
* Test if the user has the permission to access the given file in the specified mode.
* @param resource The `URI` of the file that should be testet.
* @param resource The `URI` of the file that should be tested.
* @param mode The access mode that should be tested.
*
* @returns A promise that resolves if the user has the required permissions, should be rejected otherwise.
Expand Down

0 comments on commit ff5fb65

Please sign in to comment.