FileOpsAPI
Defined in: namespaces.ts:131
Methods
Section titled “Methods”getSelectedFiles()
Section titled “getSelectedFiles()”getSelectedFiles():
Promise<PluginFileDescriptor[]>
Defined in: namespaces.ts:134
Returns file descriptors for the active pane’s selected files.
Returns
Section titled “Returns”Promise<PluginFileDescriptor[]>
getActiveDirectory()
Section titled “getActiveDirectory()”getActiveDirectory():
Promise<string>
Defined in: namespaces.ts:136
Returns the URL string of the active pane’s current directory.
Returns
Section titled “Returns”Promise<string>
getPaneDirectory()
Section titled “getPaneDirectory()”getPaneDirectory(
paneId):Promise<string>
Defined in: namespaces.ts:138
Returns the URL string of the specified pane’s directory.
Parameters
Section titled “Parameters”paneId
Section titled “paneId”string
Returns
Section titled “Returns”Promise<string>
listDirectory()
Section titled “listDirectory()”listDirectory(
url):Promise<PluginFileDescriptor[]>
Defined in: namespaces.ts:140
Lists directory contents.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<PluginFileDescriptor[]>
getFileInfo()
Section titled “getFileInfo()”getFileInfo(
url):Promise<PluginFileDescriptor>
Defined in: namespaces.ts:142
Returns metadata for a single file.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<PluginFileDescriptor>
readFile()
Section titled “readFile()”readFile(
url,encoding?):Promise<string>
Defined in: namespaces.ts:144
Reads a text file.
Parameters
Section titled “Parameters”string
encoding?
Section titled “encoding?”string
Returns
Section titled “Returns”Promise<string>
readFileData()
Section titled “readFileData()”readFileData(
url):Promise<string>
Defined in: namespaces.ts:146
Reads a file as a base64-encoded string.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
copy()
Section titled “copy()”copy(
sources,dest):Promise<void>
Defined in: namespaces.ts:150
Copies files to a destination directory.
Parameters
Section titled “Parameters”sources
Section titled “sources”string[]
string
Returns
Section titled “Returns”Promise<void>
move()
Section titled “move()”move(
sources,dest):Promise<void>
Defined in: namespaces.ts:152
Moves files to a destination directory.
Parameters
Section titled “Parameters”sources
Section titled “sources”string[]
string
Returns
Section titled “Returns”Promise<void>
delete()
Section titled “delete()”delete(
urls,trash?):Promise<void>
Defined in: namespaces.ts:154
Deletes files.
Parameters
Section titled “Parameters”string[]
trash?
Section titled “trash?”boolean
Returns
Section titled “Returns”Promise<void>
rename()
Section titled “rename()”rename(
url,newName):Promise<string>
Defined in: namespaces.ts:156
Renames a file. Returns the new URL string.
Parameters
Section titled “Parameters”string
newName
Section titled “newName”string
Returns
Section titled “Returns”Promise<string>
createDirectory()
Section titled “createDirectory()”createDirectory(
parentUrl,name):Promise<string>
Defined in: namespaces.ts:158
Creates a new directory. Returns the URL string.
Parameters
Section titled “Parameters”parentUrl
Section titled “parentUrl”string
string
Returns
Section titled “Returns”Promise<string>
createFile()
Section titled “createFile()”createFile(
parentUrl,name,contents?):Promise<string>
Defined in: namespaces.ts:160
Creates a new file with optional initial contents. Returns the URL string.
Parameters
Section titled “Parameters”parentUrl
Section titled “parentUrl”string
string
contents?
Section titled “contents?”string
Returns
Section titled “Returns”Promise<string>
writeFile()
Section titled “writeFile()”writeFile(
url,contents,encoding?):Promise<void>
Defined in: namespaces.ts:162
Writes text content to an existing file.
Parameters
Section titled “Parameters”string
contents
Section titled “contents”string
encoding?
Section titled “encoding?”string
Returns
Section titled “Returns”Promise<void>
batch()
Section titled “batch()”batch(
operations):Promise<BatchResult[]>
Defined in: namespaces.ts:164
Executes multiple file operations as a batch.
Parameters
Section titled “Parameters”operations
Section titled “operations”Returns
Section titled “Returns”Promise<BatchResult[]>
watchDirectory()
Section titled “watchDirectory()”watchDirectory(
url,handler):string
Defined in: namespaces.ts:168
Watches a directory for changes. Returns subscription ID.
Parameters
Section titled “Parameters”string
handler
Section titled “handler”(changedPaths) => void
Returns
Section titled “Returns”string
watchDirectoryWithOptions()
Section titled “watchDirectoryWithOptions()”watchDirectoryWithOptions(
url,options,handler):string
Defined in: namespaces.ts:170
Watches a directory for changes with configurable debounce and recursion.
Parameters
Section titled “Parameters”string
options
Section titled “options”handler
Section titled “handler”(changedPaths) => void
Returns
Section titled “Returns”string
unwatchDirectory()
Section titled “unwatchDirectory()”unwatchDirectory(
subscriptionId):void
Defined in: namespaces.ts:176
Cancels a directory watcher subscription.
Parameters
Section titled “Parameters”subscriptionId
Section titled “subscriptionId”string
Returns
Section titled “Returns”void
onBeforeOperation()
Section titled “onBeforeOperation()”onBeforeOperation(
type,handler):string
Defined in: namespaces.ts:180
Registers a before-operation hook.
Parameters
Section titled “Parameters”FileOperationType | FileOperationType[]
handler
Section titled “handler”(event) => void | BeforeHookResult
Returns
Section titled “Returns”string
onAfterOperation()
Section titled “onAfterOperation()”onAfterOperation(
type,handler):string
Defined in: namespaces.ts:185
Registers an after-operation hook.
Parameters
Section titled “Parameters”FileOperationType | FileOperationType[]
handler
Section titled “handler”(event) => void
Returns
Section titled “Returns”string
removeBeforeHook()
Section titled “removeBeforeHook()”removeBeforeHook(
subscriptionId):void
Defined in: namespaces.ts:190
Removes a before-hook subscription.
Parameters
Section titled “Parameters”subscriptionId
Section titled “subscriptionId”string
Returns
Section titled “Returns”void
removeAfterHook()
Section titled “removeAfterHook()”removeAfterHook(
subscriptionId):void
Defined in: namespaces.ts:192
Removes an after-hook subscription.
Parameters
Section titled “Parameters”subscriptionId
Section titled “subscriptionId”string
Returns
Section titled “Returns”void