capacitor-advanced-file-manager
Version:
Advanced file manager plugin for Capacitor with comprehensive file system operations including browse, create, edit, delete, move, copy, and search files and directories.
1,615 lines • 38.8 kB
JSON
{
"api": {
"name": "AdvancedFileManagerPlugin",
"slug": "advancedfilemanagerplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "requestPermissions",
"signature": "() => Promise<PermissionResult>",
"parameters": [],
"returns": "Promise<PermissionResult>",
"tags": [],
"docs": "",
"complexTypes": [
"PermissionResult"
],
"slug": "requestpermissions"
},
{
"name": "checkPermissions",
"signature": "() => Promise<PermissionResult>",
"parameters": [],
"returns": "Promise<PermissionResult>",
"tags": [],
"docs": "",
"complexTypes": [
"PermissionResult"
],
"slug": "checkpermissions"
},
{
"name": "openSystemFilePicker",
"signature": "(options: SystemFilePickerOptions) => Promise<SystemFilePickerResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SystemFilePickerOptions"
}
],
"returns": "Promise<SystemFilePickerResult>",
"tags": [],
"docs": "",
"complexTypes": [
"SystemFilePickerResult",
"SystemFilePickerOptions"
],
"slug": "opensystemfilepicker"
},
{
"name": "openSystemFileManager",
"signature": "(path?: string | undefined) => Promise<void>",
"parameters": [
{
"name": "path",
"docs": "",
"type": "string | undefined"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "opensystemfilemanager"
},
{
"name": "openFileWithSystemApp",
"signature": "(filePath: string, mimeType?: string | undefined) => Promise<void>",
"parameters": [
{
"name": "filePath",
"docs": "",
"type": "string"
},
{
"name": "mimeType",
"docs": "",
"type": "string | undefined"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "openfilewithsystemapp"
},
{
"name": "listDirectory",
"signature": "(options: ListDirectoryOptions) => Promise<ListDirectoryResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ListDirectoryOptions"
}
],
"returns": "Promise<ListDirectoryResult>",
"tags": [],
"docs": "",
"complexTypes": [
"ListDirectoryResult",
"ListDirectoryOptions"
],
"slug": "listdirectory"
},
{
"name": "createDirectory",
"signature": "(options: CreateDirectoryOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "CreateDirectoryOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"CreateDirectoryOptions"
],
"slug": "createdirectory"
},
{
"name": "deleteDirectory",
"signature": "(options: FileOperationOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"FileOperationOptions"
],
"slug": "deletedirectory"
},
{
"name": "createFile",
"signature": "(options: CreateFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "CreateFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"CreateFileOptions"
],
"slug": "createfile"
},
{
"name": "readFile",
"signature": "(options: ReadFileOptions) => Promise<ReadFileResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ReadFileOptions"
}
],
"returns": "Promise<ReadFileResult>",
"tags": [],
"docs": "",
"complexTypes": [
"ReadFileResult",
"ReadFileOptions"
],
"slug": "readfile"
},
{
"name": "writeFile",
"signature": "(options: WriteFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "WriteFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"WriteFileOptions"
],
"slug": "writefile"
},
{
"name": "deleteFile",
"signature": "(options: FileOperationOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"FileOperationOptions"
],
"slug": "deletefile"
},
{
"name": "moveFile",
"signature": "(options: MoveFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "MoveFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"MoveFileOptions"
],
"slug": "movefile"
},
{
"name": "copyFile",
"signature": "(options: CopyFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "CopyFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"CopyFileOptions"
],
"slug": "copyfile"
},
{
"name": "renameFile",
"signature": "(options: RenameFileOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "RenameFileOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"RenameFileOptions"
],
"slug": "renamefile"
},
{
"name": "getFileInfo",
"signature": "(options: FileOperationOptions) => Promise<FileInfo>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<FileInfo>",
"tags": [],
"docs": "",
"complexTypes": [
"FileInfo",
"FileOperationOptions"
],
"slug": "getfileinfo"
},
{
"name": "exists",
"signature": "(options: FileOperationOptions) => Promise<{ exists: boolean; }>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<{ exists: boolean; }>",
"tags": [],
"docs": "",
"complexTypes": [
"FileOperationOptions"
],
"slug": "exists"
},
{
"name": "searchFiles",
"signature": "(options: SearchFilesOptions) => Promise<SearchFilesResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SearchFilesOptions"
}
],
"returns": "Promise<SearchFilesResult>",
"tags": [],
"docs": "",
"complexTypes": [
"SearchFilesResult",
"SearchFilesOptions"
],
"slug": "searchfiles"
},
{
"name": "searchContent",
"signature": "(options: SearchContentOptions) => Promise<SearchContentResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SearchContentOptions"
}
],
"returns": "Promise<SearchContentResult>",
"tags": [],
"docs": "原生层内容搜索(避免 OOM)\n在原生层执行搜索,只返回匹配结果,不返回完整文件内容",
"complexTypes": [
"SearchContentResult",
"SearchContentOptions"
],
"slug": "searchcontent"
},
{
"name": "readFileRange",
"signature": "(options: ReadFileRangeOptions) => Promise<ReadFileRangeResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ReadFileRangeOptions"
}
],
"returns": "Promise<ReadFileRangeResult>",
"tags": [],
"docs": "读取文件指定行范围",
"complexTypes": [
"ReadFileRangeResult",
"ReadFileRangeOptions"
],
"slug": "readfilerange"
},
{
"name": "insertContent",
"signature": "(options: InsertContentOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "InsertContentOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "在指定行插入内容",
"complexTypes": [
"InsertContentOptions"
],
"slug": "insertcontent"
},
{
"name": "replaceInFile",
"signature": "(options: ReplaceInFileOptions) => Promise<ReplaceInFileResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ReplaceInFileOptions"
}
],
"returns": "Promise<ReplaceInFileResult>",
"tags": [],
"docs": "查找并替换文件内容",
"complexTypes": [
"ReplaceInFileResult",
"ReplaceInFileOptions"
],
"slug": "replaceinfile"
},
{
"name": "applyDiff",
"signature": "(options: ApplyDiffOptions) => Promise<ApplyDiffResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ApplyDiffOptions"
}
],
"returns": "Promise<ApplyDiffResult>",
"tags": [],
"docs": "应用 diff 补丁",
"complexTypes": [
"ApplyDiffResult",
"ApplyDiffOptions"
],
"slug": "applydiff"
},
{
"name": "getFileHash",
"signature": "(options: GetFileHashOptions) => Promise<GetFileHashResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "GetFileHashOptions"
}
],
"returns": "Promise<GetFileHashResult>",
"tags": [],
"docs": "获取文件哈希值",
"complexTypes": [
"GetFileHashResult",
"GetFileHashOptions"
],
"slug": "getfilehash"
},
{
"name": "getLineCount",
"signature": "(options: FileOperationOptions) => Promise<GetLineCountResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "FileOperationOptions"
}
],
"returns": "Promise<GetLineCountResult>",
"tags": [],
"docs": "获取文件行数",
"complexTypes": [
"GetLineCountResult",
"FileOperationOptions"
],
"slug": "getlinecount"
},
{
"name": "echo",
"signature": "(options: { value: string; }) => Promise<{ value: string; }>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "{ value: string; }"
}
],
"returns": "Promise<{ value: string; }>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "echo"
}
],
"properties": []
},
"interfaces": [
{
"name": "PermissionResult",
"slug": "permissionresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "granted",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean"
},
{
"name": "message",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "SystemFilePickerResult",
"slug": "systemfilepickerresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "files",
"tags": [],
"docs": "选择的文件信息列表",
"complexTypes": [
"SelectedFileInfo"
],
"type": "SelectedFileInfo[]"
},
{
"name": "directories",
"tags": [],
"docs": "选择的目录信息列表",
"complexTypes": [
"SelectedFileInfo"
],
"type": "SelectedFileInfo[]"
},
{
"name": "cancelled",
"tags": [],
"docs": "是否被用户取消",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "SelectedFileInfo",
"slug": "selectedfileinfo",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "name",
"tags": [],
"docs": "文件名",
"complexTypes": [],
"type": "string"
},
{
"name": "path",
"tags": [],
"docs": "文件路径(可能是真实路径或URI)",
"complexTypes": [],
"type": "string"
},
{
"name": "uri",
"tags": [],
"docs": "原始URI(移动端)",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "size",
"tags": [],
"docs": "文件大小",
"complexTypes": [],
"type": "number"
},
{
"name": "type",
"tags": [],
"docs": "文件类型",
"complexTypes": [],
"type": "'file' | 'directory'"
},
{
"name": "mimeType",
"tags": [],
"docs": "MIME类型",
"complexTypes": [],
"type": "string"
},
{
"name": "mtime",
"tags": [],
"docs": "修改时间",
"complexTypes": [],
"type": "number"
},
{
"name": "ctime",
"tags": [],
"docs": "创建时间",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "SystemFilePickerOptions",
"slug": "systemfilepickeroptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "type",
"tags": [],
"docs": "选择类型",
"complexTypes": [],
"type": "'file' | 'directory' | 'both'"
},
{
"name": "multiple",
"tags": [],
"docs": "是否允许多选",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "accept",
"tags": [],
"docs": "文件类型过滤",
"complexTypes": [],
"type": "string[] | undefined"
},
{
"name": "startDirectory",
"tags": [],
"docs": "起始目录",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "title",
"tags": [],
"docs": "标题",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "ListDirectoryResult",
"slug": "listdirectoryresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "files",
"tags": [],
"docs": "",
"complexTypes": [
"FileInfo"
],
"type": "FileInfo[]"
},
{
"name": "totalCount",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "FileInfo",
"slug": "fileinfo",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "name",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "size",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "type",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'file' | 'directory'"
},
{
"name": "mtime",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "ctime",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "permissions",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "isHidden",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "ListDirectoryOptions",
"slug": "listdirectoryoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "showHidden",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "sortBy",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'name' | 'size' | 'mtime' | 'type' | undefined"
},
{
"name": "sortOrder",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'asc' | 'desc' | undefined"
}
]
},
{
"name": "CreateDirectoryOptions",
"slug": "createdirectoryoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "recursive",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "FileOperationOptions",
"slug": "fileoperationoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "CreateFileOptions",
"slug": "createfileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "content",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'utf8' | 'base64' | undefined"
}
]
},
{
"name": "ReadFileResult",
"slug": "readfileresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "content",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "ReadFileOptions",
"slug": "readfileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'utf8' | 'base64' | undefined"
}
]
},
{
"name": "WriteFileOptions",
"slug": "writefileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "content",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "encoding",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'utf8' | 'base64' | undefined"
},
{
"name": "append",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "MoveFileOptions",
"slug": "movefileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "sourcePath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "destinationPath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "CopyFileOptions",
"slug": "copyfileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "sourcePath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "destinationPath",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "overwrite",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "RenameFileOptions",
"slug": "renamefileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "newName",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "SearchFilesResult",
"slug": "searchfilesresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "files",
"tags": [],
"docs": "",
"complexTypes": [
"FileInfo"
],
"type": "FileInfo[]"
},
{
"name": "totalFound",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "SearchFilesOptions",
"slug": "searchfilesoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "directory",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "query",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "searchType",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "'name' | 'content' | 'both' | undefined"
},
{
"name": "fileTypes",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string[] | undefined"
},
{
"name": "maxResults",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "recursive",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "SearchContentResult",
"slug": "searchcontentresult",
"docs": "内容搜索结果",
"tags": [],
"methods": [],
"properties": [
{
"name": "results",
"tags": [],
"docs": "搜索结果列表",
"complexTypes": [
"ContentSearchFileResult"
],
"type": "ContentSearchFileResult[]"
},
{
"name": "totalFiles",
"tags": [],
"docs": "总匹配文件数",
"complexTypes": [],
"type": "number"
},
{
"name": "totalMatches",
"tags": [],
"docs": "总匹配数",
"complexTypes": [],
"type": "number"
},
{
"name": "duration",
"tags": [],
"docs": "搜索耗时(毫秒)",
"complexTypes": [],
"type": "number"
},
{
"name": "skippedFiles",
"tags": [],
"docs": "被跳过的文件数(因文件过大等原因)",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "ContentSearchFileResult",
"slug": "contentsearchfileresult",
"docs": "单个文件的内容搜索结果",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "文件路径",
"complexTypes": [],
"type": "string"
},
{
"name": "name",
"tags": [],
"docs": "文件名",
"complexTypes": [],
"type": "string"
},
{
"name": "matchType",
"tags": [],
"docs": "匹配类型",
"complexTypes": [],
"type": "'content' | 'both' | 'filename'"
},
{
"name": "matches",
"tags": [],
"docs": "匹配列表",
"complexTypes": [
"ContentMatch"
],
"type": "ContentMatch[]"
},
{
"name": "score",
"tags": [],
"docs": "相关性评分",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "ContentMatch",
"slug": "contentmatch",
"docs": "内容搜索匹配项",
"tags": [],
"methods": [],
"properties": [
{
"name": "lineNumber",
"tags": [],
"docs": "匹配的行号 (1-based)",
"complexTypes": [],
"type": "number"
},
{
"name": "lineContent",
"tags": [],
"docs": "匹配的行内容",
"complexTypes": [],
"type": "string"
},
{
"name": "context",
"tags": [],
"docs": "匹配的上下文(带高亮标记位置)",
"complexTypes": [],
"type": "string"
},
{
"name": "matchStart",
"tags": [],
"docs": "匹配开始位置(在 context 中)",
"complexTypes": [],
"type": "number"
},
{
"name": "matchEnd",
"tags": [],
"docs": "匹配结束位置(在 context 中)",
"complexTypes": [],
"type": "number"
}
]
},
{
"name": "SearchContentOptions",
"slug": "searchcontentoptions",
"docs": "内容搜索选项",
"tags": [],
"methods": [],
"properties": [
{
"name": "directory",
"tags": [],
"docs": "搜索目录",
"complexTypes": [],
"type": "string"
},
{
"name": "keyword",
"tags": [],
"docs": "搜索关键词",
"complexTypes": [],
"type": "string"
},
{
"name": "caseSensitive",
"tags": [],
"docs": "是否区分大小写",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "fileExtensions",
"tags": [],
"docs": "文件扩展名过滤(如 ['.md', '.txt'])",
"complexTypes": [],
"type": "string[] | undefined"
},
{
"name": "maxFiles",
"tags": [],
"docs": "最大搜索文件数",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "maxFileSize",
"tags": [],
"docs": "最大文件大小(字节),超过的文件将被跳过",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "maxMatchesPerFile",
"tags": [],
"docs": "每个文件最大匹配数",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "contextLength",
"tags": [],
"docs": "上下文长度(匹配前后的字符数)",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "maxDepth",
"tags": [],
"docs": "最大递归深度",
"complexTypes": [],
"type": "number | undefined"
},
{
"name": "recursive",
"tags": [],
"docs": "是否递归搜索子目录",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "ReadFileRangeResult",
"slug": "readfilerangeresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "content",
"tags": [],
"docs": "读取到的内容",
"complexTypes": [],
"type": "string"
},
{
"name": "totalLines",
"tags": [],
"docs": "文件总行数",
"complexTypes": [],
"type": "number"
},
{
"name": "startLine",
"tags": [],
"docs": "实际读取的起始行",
"complexTypes": [],
"type": "number"
},
{
"name": "endLine",
"tags": [],
"docs": "实际读取的结束行",
"complexTypes": [],
"type": "number"
},
{
"name": "rangeHash",
"tags": [],
"docs": "内容哈希(用于冲突检测)",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "ReadFileRangeOptions",
"slug": "readfilerangeoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "startLine",
"tags": [],
"docs": "起始行号 (1-based)",
"complexTypes": [],
"type": "number"
},
{
"name": "endLine",
"tags": [],
"docs": "结束行号 (1-based, 包含)",
"complexTypes": [],
"type": "number"
},
{
"name": "encoding",
"tags": [],
"docs": "编码方式",
"complexTypes": [],
"type": "'utf8' | 'base64' | undefined"
}
]
},
{
"name": "InsertContentOptions",
"slug": "insertcontentoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "line",
"tags": [],
"docs": "插入位置的行号 (1-based),内容将插入到该行之前",
"complexTypes": [],
"type": "number"
},
{
"name": "content",
"tags": [],
"docs": "要插入的内容",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "ReplaceInFileResult",
"slug": "replaceinfileresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "replacements",
"tags": [],
"docs": "替换的次数",
"complexTypes": [],
"type": "number"
},
{
"name": "modified",
"tags": [],
"docs": "是否有修改",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "ReplaceInFileOptions",
"slug": "replaceinfileoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "search",
"tags": [],
"docs": "要查找的字符串或正则表达式",
"complexTypes": [],
"type": "string"
},
{
"name": "replace",
"tags": [],
"docs": "替换为的内容",
"complexTypes": [],
"type": "string"
},
{
"name": "isRegex",
"tags": [],
"docs": "是否使用正则表达式",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "replaceAll",
"tags": [],
"docs": "是否替换所有匹配项",
"complexTypes": [],
"type": "boolean | undefined"
},
{
"name": "caseSensitive",
"tags": [],
"docs": "是否区分大小写",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "ApplyDiffResult",
"slug": "applydiffresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "success",
"tags": [],
"docs": "是否成功应用",
"complexTypes": [],
"type": "boolean"
},
{
"name": "linesChanged",
"tags": [],
"docs": "修改的行数",
"complexTypes": [],
"type": "number"
},
{
"name": "linesAdded",
"tags": [],
"docs": "添加的行数",
"complexTypes": [],
"type": "number"
},
{
"name": "linesDeleted",
"tags": [],
"docs": "删除的行数",
"complexTypes": [],
"type": "number"
},
{
"name": "backupPath",
"tags": [],
"docs": "备份文件路径(如果创建了备份)",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "ApplyDiffOptions",
"slug": "applydiffoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "diff",
"tags": [],
"docs": "Unified diff 格式的补丁内容",
"complexTypes": [],
"type": "string"
},
{
"name": "createBackup",
"tags": [],
"docs": "是否创建备份",
"complexTypes": [],
"type": "boolean | undefined"
}
]
},
{
"name": "GetFileHashResult",
"slug": "getfilehashresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "hash",
"tags": [],
"docs": "文件哈希值",
"complexTypes": [],
"type": "string"
},
{
"name": "algorithm",
"tags": [],
"docs": "使用的算法",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "GetFileHashOptions",
"slug": "getfilehashoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "path",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "algorithm",
"tags": [],
"docs": "哈希算法",
"complexTypes": [],
"type": "'md5' | 'sha256' | undefined"
}
]
},
{
"name": "GetLineCountResult",
"slug": "getlinecountresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "lines",
"tags": [],
"docs": "文件行数",
"complexTypes": [],
"type": "number"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": []
}