类 FilesystemStorage

实现

StorageProvider
StorageProviderWithResult

构造函数

constructor

new FilesystemStorage(): FilesystemStorage
返回 FilesystemStorage

方法

readJSON

readJSON<T>(filePath: string): Promise<T | null>
类型参数
- T
参数
- filePath: string
返回 Promise<T | null>
实现了 StorageProvider.readJSON
- 定义于 src/storage/index.ts:319

readJSONWithResult

readJSONWithResult<T>(filePath: string): Promise<Result<T>>
类型参数
- T
参数
- filePath: string
返回 Promise<Result<T>>
实现了 StorageProviderWithResult.readJSONWithResult
- 定义于 src/storage/index.ts:324

writeJSON

writeJSON(filePath: string, data: any): Promise<void>
参数
- filePath: string
- data: any
返回 Promise<void>
实现了 StorageProvider.writeJSON
- 定义于 src/storage/index.ts:342

readText

readText(filePath: string): Promise<string | null>
参数
- filePath: string
返回 Promise<string | null>
实现了 StorageProvider.readText
- 定义于 src/storage/index.ts:348

readTextWithResult

readTextWithResult(filePath: string): Promise<Result<string>>
参数
- filePath: string
返回 Promise<Result<string>>
实现了 StorageProviderWithResult.readTextWithResult
- 定义于 src/storage/index.ts:353

writeText

writeText(filePath: string, content: string): Promise<void>
参数
- filePath: string
- content: string
返回 Promise<void>
实现了 StorageProvider.writeText
- 定义于 src/storage/index.ts:364

appendText

appendText(filePath: string, content: string): Promise<void>
参数
- filePath: string
- content: string
返回 Promise<void>
实现了 StorageProvider.appendText
- 定义于 src/storage/index.ts:370

readBuffer

readBuffer(filePath: string): Promise<Buffer<ArrayBufferLike> | null>
参数
- filePath: string
返回 Promise<Buffer<ArrayBufferLike> | null>
实现了 StorageProvider.readBuffer
- 定义于 src/storage/index.ts:376

readBufferWithResult

readBufferWithResult(filePath: string): Promise<Result<Buffer<ArrayBufferLike>>>
参数
- filePath: string
返回 Promise<Result<Buffer<ArrayBufferLike>>>
实现了 StorageProviderWithResult.readBufferWithResult
- 定义于 src/storage/index.ts:381

writeBuffer

writeBuffer(filePath: string, data: Buffer): Promise<void>
参数
- filePath: string
- data: Buffer
返回 Promise<void>
实现了 StorageProvider.writeBuffer
- 定义于 src/storage/index.ts:392

readDir

readDir(dirPath: string): Promise<string[]>
参数
- dirPath: string
返回 Promise<string[]>
实现了 StorageProvider.readDir
- 定义于 src/storage/index.ts:398

readDirWithResult

readDirWithResult(dirPath: string): Promise<Result<string[]>>
参数
- dirPath: string
返回 Promise<Result<string[]>>
实现了 StorageProviderWithResult.readDirWithResult
- 定义于 src/storage/index.ts:403

exists

exists(filePath: string): Promise<boolean>
参数
- filePath: string
返回 Promise<boolean>
实现了 StorageProvider.exists
- 定义于 src/storage/index.ts:414

mkdir

mkdir(dirPath: string): Promise<void>
参数
- dirPath: string
返回 Promise<void>
实现了 StorageProvider.mkdir
- 定义于 src/storage/index.ts:423

remove

remove(filePath: string): Promise<void>
参数
- filePath: string
返回 Promise<void>
实现了 StorageProvider.remove
- 定义于 src/storage/index.ts:435

removeWithResult

removeWithResult(filePath: string): Promise<Result<void>>
参数
- filePath: string
返回 Promise<Result<void>>
实现了 StorageProviderWithResult.removeWithResult
- 定义于 src/storage/index.ts:442

removeDir

removeDir(dirPath: string): Promise<void>
递归删除目录及其所有内容
参数
- dirPath: string
返回 Promise<void>
实现了 StorageProvider.removeDir
- 定义于 src/storage/index.ts:455

stat

stat(filePath: string): Promise<Stats | null>
参数
- filePath: string
返回 Promise<Stats | null>
实现了 StorageProvider.stat
- 定义于 src/storage/index.ts:465

statWithResult

statWithResult(filePath: string): Promise<Result<Stats>>
参数
- filePath: string
返回 Promise<Result<Stats>>
实现了 StorageProviderWithResult.statWithResult
- 定义于 src/storage/index.ts:470

copy

copy(src: string, dest: string): Promise<void>
参数
- src: string
- dest: string
返回 Promise<void>
实现了 StorageProvider.copy
- 定义于 src/storage/index.ts:481

readDirWithTypes

readDirWithTypes(dirPath: string): Promise<Dirent<string>[]>
参数
- dirPath: string
返回 Promise<Dirent<string>[]>
实现了 StorageProvider.readDirWithTypes
- 定义于 src/storage/index.ts:487