@bridge/fs
Module that allows extensions to interact with the user's file system.
Functions
copyFile
▸ copyFile(originPath, destPath): Promise<FileSystemFileHandle>
Copy a file.
Parameters
| Name | Type |
|---|---|
originPath |
string |
destPath |
string |
Returns
Promise<FileSystemFileHandle>
copyFileHandle
▸ copyFileHandle(originHandle, destHandle): Promise<FileSystemFileHandle>
Copy a file handle.
Parameters
| Name | Type |
|---|---|
originHandle |
FileSystemFileHandle |
destHandle |
FileSystemFileHandle |
Returns
Promise<FileSystemFileHandle>
copyFolder
▸ copyFolder(originPath, destPath): Promise<void>
Copy a folder by their paths.
Parameters
| Name | Type |
|---|---|
originPath |
string |
destPath |
string |
Returns
Promise<void>
copyFolderByHandle
▸ copyFolderByHandle(originHandle, destHandle): Promise<void>
Copy a folder by its FileSystemDirectoryHandle.
Parameters
| Name | Type |
|---|---|
originHandle |
FileSystemDirectoryHandle |
destHandle |
FileSystemDirectoryHandle |
Returns
Promise<void>
directoryExists
▸ directoryExists(path): Promise<boolean>
Return whether a directory exists or not.
Parameters
| Name | Type |
|---|---|
path |
string |
Returns
Promise<boolean>
fileExists
▸ fileExists(path): Promise<boolean>
Return whether a file exists or not.
Parameters
| Name | Type |
|---|---|
path |
string |
Returns
Promise<boolean>
getDirectoryHandle
▸ getDirectoryHandle(path, __namedParameters): Promise<FileSystemDirectoryHandle>
The getDirectoryHandle() method returns a FileSystemDirectoryHandle for a subdirectory with the specified name within the directory handle on which the method is called.
Parameters
| Name | Type | Description |
|---|---|---|
path |
string |
A USVString representing the FileSystemHandle.name of the subdirectory you wish to retrieve. |
__namedParameters |
Partial<IGetHandleConfig> |
- |
Returns
Promise<FileSystemDirectoryHandle>
getFileHandle
▸ getFileHandle(path, create): Promise<FileSystemFileHandle>
Parameters
| Name | Type |
|---|---|
path |
string |
create |
boolean |
Returns
Promise<FileSystemFileHandle>
loadFileHandleAsDataUrl
▸ loadFileHandleAsDataUrl(fileHandle): Promise<string>
Read a file by its FileHandle as a URL.
Parameters
| Name | Type |
|---|---|
fileHandle |
FileSystemFileHandle |
Returns
Promise<string>
mkdir
▸ mkdir(path, __namedParameters): Promise<void>
Parameters
| Name | Type |
|---|---|
path |
string |
__namedParameters |
Partial<IMkdirConfig> |
Returns
Promise<void>
readFile
▸ readFile(path): Promise<File>
Read a file and return it.
Parameters
| Name | Type |
|---|---|
path |
string |
Returns
Promise<File>
readFilesFromDir
▸ readFilesFromDir(path, dirHandle): Promise<{ kind: string ; name: string ; path: string }[]>
Read the contents of a directory and returns the files.
Parameters
| Name | Type |
|---|---|
path |
string |
dirHandle |
FileSystemDirectoryHandle | Promise<FileSystemDirectoryHandle> |
Returns
Promise<{ kind: string ; name: string ; path: string }[]>
readJSON
▸ readJSON(path): Promise<FileSystemFileHandle>
Read a JSON file at a given path and return the file handle.
Parameters
| Name | Type |
|---|---|
path |
string |
Returns
Promise<FileSystemFileHandle>
readdir
▸ readdir(path, config): Promise<FileSystemHandle[]>
Read the contents of a given directory.
Parameters
| Name | Type |
|---|---|
path |
string |
config |
Object |
config.withFileTypes |
true |
Returns
Promise<FileSystemHandle[]>
▸ readdir(path, config?): Promise<string[]>
Parameters
| Name | Type |
|---|---|
path |
string |
config? |
Object |
config.withFileTypes? |
false |
Returns
Promise<string[]>
▸ readdir(path, __namedParameters): Promise<FileSystemHandle[]>
Parameters
| Name | Type |
|---|---|
path |
string |
__namedParameters |
Object |
__namedParameters.withFileTypes? |
boolean |
Returns
Promise<FileSystemHandle[]>
setup
▸ setup(baseDirectory): void
Parameters
| Name | Type |
|---|---|
baseDirectory |
FileSystemDirectoryHandle |
Returns
void
unlink
▸ unlink(path): Promise<void>
Unlink a directory from the fileSystem, deleting it.
Parameters
| Name | Type |
|---|---|
path |
string |
Returns
Promise<void>
write
▸ write(fileHandle, data): Promise<FileSystemFileHandle>
Write to a file from a FileSystemDirectoryHandle.
Parameters
| Name | Type |
|---|---|
fileHandle |
FileSystemFileHandle |
data |
FileSystemWriteChunkType |
Returns
Promise<FileSystemFileHandle>
writeFile
▸ writeFile(path, data): Promise<FileSystemFileHandle>
Write to a file at the specified path.
Parameters
| Name | Type |
|---|---|
path |
string |
data |
FileSystemWriteChunkType |
Returns
Promise<FileSystemFileHandle>
writeJSON
▸ writeJSON(path, data, beautify): Promise<FileSystemFileHandle>
Write a javascript object as JSON to a file.
Parameters
| Name | Type |
|---|---|
path |
string |
data |
any |
beautify |
boolean |
Returns
Promise<FileSystemFileHandle>