ExtHostFileSystemEventService

Hierarchy

ExtHostFileSystemEventService

Implements

ExtHostFileSystemEventServiceShape

Constructors

constructor

new ExtHostFileSystemEventService(rpc: RPCProtocol, _extHostDocumentsAndEditors: EditorsAndDocumentsExtImpl, _mainThreadTextEditors?: TextEditorsMain): ExtHostFileSystemEventService

- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:153
Parameters
- rpc: RPCProtocol
- _extHostDocumentsAndEditors: EditorsAndDocumentsExtImpl
- _mainThreadTextEditors: TextEditorsMain = ...
Returns ExtHostFileSystemEventService

Properties

Private Readonly _onDidCreateFile

_onDidCreateFile: Emitter<FileCreateEvent> = ...

Private Readonly _onDidDeleteFile

_onDidDeleteFile: Emitter<FileDeleteEvent> = ...

Private Readonly _onDidRenameFile

_onDidRenameFile: Emitter<FileRenameEvent> = ...

Private Readonly _onFileSystemEvent

_onFileSystemEvent: Emitter<FileSystemEvents> = ...

Private Readonly _onWillCreateFile

_onWillCreateFile: AsyncEmitter<FileWillCreateEvent> = ...

Private Readonly _onWillDeleteFile

_onWillDeleteFile: AsyncEmitter<FileWillDeleteEvent> = ...

Private Readonly _onWillRenameFile

_onWillRenameFile: AsyncEmitter<FileWillRenameEvent> = ...

Readonly onDidCreateFile

onDidCreateFile: Event<FileCreateEvent> = ...

Readonly onDidDeleteFile

onDidDeleteFile: Event<FileDeleteEvent> = ...

Readonly onDidRenameFile

onDidRenameFile: Event<FileRenameEvent> = ...

Methods

$onDidRunFileOperation

$onDidRunFileOperation(operation: FileOperation, target: UriComponents, source: undefined | UriComponents): void

Implementation of ExtHostFileSystemEventServiceShape.$onDidRunFileOperation
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:173
Parameters
- operation: FileOperation
- target: UriComponents
- source: undefined | UriComponents
Returns void

$onFileEvent

$onFileEvent(events: FileSystemEvents): void

Implementation of ExtHostFileSystemEventServiceShape.$onFileEvent
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:167
Parameters
- events: FileSystemEvents
Returns void

$onWillRunFileOperation

$onWillRunFileOperation(operation: FileOperation, target: UriComponents, source: undefined | UriComponents, timeout: number, token: CancellationToken): Promise<any>

Implementation of ExtHostFileSystemEventServiceShape.$onWillRunFileOperation
- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:209
Parameters
- operation: FileOperation
- target: UriComponents
- source: undefined | UriComponents
- timeout: number
- token: CancellationToken
Returns Promise<any>

Private _createWillExecuteEvent

_createWillExecuteEvent<E>(extension: Plugin, emitter: AsyncEmitter<E>): Event<E>

- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:201
Type Parameters
- E extends WaitUntilEvent
Parameters
- extension: Plugin
- emitter: AsyncEmitter<E>
Returns Event<E>

Private _fireWillEvent

_fireWillEvent<E>(emitter: AsyncEmitter<E>, data: WaitUntilData<E>, timeout: number, token: CancellationToken): Promise<any>

- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:225
Type Parameters
- E extends WaitUntilEvent
Parameters
- emitter: AsyncEmitter<E>
- data: WaitUntilData<E>
- timeout: number
- token: CancellationToken
Returns Promise<any>

createFileSystemWatcher

createFileSystemWatcher(globPattern: string | IRelativePattern, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher

- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:163
Parameters
- globPattern: string | IRelativePattern
- Optional ignoreCreateEvents: boolean
- Optional ignoreChangeEvents: boolean
- Optional ignoreDeleteEvents: boolean
Returns FileSystemWatcher

getOnWillCreateFileEvent

getOnWillCreateFileEvent(extension: Plugin): Event<FileWillCreateEvent>

- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:193
Parameters
- extension: Plugin
Returns Event<FileWillCreateEvent>

getOnWillDeleteFileEvent

getOnWillDeleteFileEvent(extension: Plugin): Event<FileWillDeleteEvent>

- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:197
Parameters
- extension: Plugin
Returns Event<FileWillDeleteEvent>

getOnWillRenameFileEvent

getOnWillRenameFileEvent(extension: Plugin): Event<FileWillRenameEvent>

- Defined in packages/plugin-ext/src/plugin/file-system-event-service-ext-impl.ts:189
Parameters
- extension: Plugin
Returns Event<FileWillRenameEvent>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPCProtocol

_extHostDocumentsAndEditors: EditorsAndDocumentsExtImpl

_mainThreadTextEditors: TextEditorsMain = ...

Returns ExtHostFileSystemEventService

Properties

Private Readonly _onDidCreateFile

Private Readonly _onDidDeleteFile

Private Readonly _onDidRenameFile

Private Readonly _onFileSystemEvent

Private Readonly _onWillCreateFile

Private Readonly _onWillDeleteFile

Private Readonly _onWillRenameFile

Readonly onDidCreateFile

Readonly onDidDeleteFile

Readonly onDidRenameFile

Methods

$onDidRunFileOperation

Parameters

operation: FileOperation

target: UriComponents

source: undefined | UriComponents

Returns void

$onFileEvent

Parameters

events: FileSystemEvents

Returns void

$onWillRunFileOperation

Parameters

operation: FileOperation

target: UriComponents

source: undefined | UriComponents

timeout: number

token: CancellationToken

Returns Promise<any>

Private _createWillExecuteEvent

Type Parameters

E extends WaitUntilEvent

Parameters

extension: Plugin

emitter: AsyncEmitter<E>

Returns Event<E>

Private _fireWillEvent

Type Parameters

E extends WaitUntilEvent

Parameters

emitter: AsyncEmitter<E>

data: WaitUntilData<E>

timeout: number

token: CancellationToken

Returns Promise<any>

createFileSystemWatcher

Parameters

globPattern: string | IRelativePattern

Optional ignoreCreateEvents: boolean

Optional ignoreChangeEvents: boolean

Optional ignoreDeleteEvents: boolean

Returns FileSystemWatcher

getOnWillCreateFileEvent

Parameters

extension: Plugin

Returns Event<FileWillCreateEvent>

getOnWillDeleteFileEvent

Parameters

extension: Plugin

Returns Event<FileWillDeleteEvent>

getOnWillRenameFileEvent

Parameters

extension: Plugin

Returns Event<FileWillRenameEvent>