Class FilesystemIOProvider

constructor

• new FilesystemIOProvider(rootPath: string): FilesystemIOProvider

  Parameters

  • rootPath: string

  Returns FilesystemIOProvider

Readonlykind

ReadonlyrootPath

[asyncDispose]

• "[asyncDispose]"(): Promise<void>

  Returns Promise<void>

canDirectTransfer

• canDirectTransfer(other: IOProvider): boolean

  Self-reported direct-transfer eligibility - the provider owns what "same" means for its backend (e.g. same mount for filesystem, same bucket+region+credentials for object storage).

  Parameters

  • other: IOProvider

  Returns boolean

delete

• delete(path: string): Promise<void>

  Parameters

  • path: string

  Returns Promise<void>

directCopy

• directCopy(sourcePath: string, destPath: string): Promise<void>

  Parameters

  • sourcePath: string
  • destPath: string

  Returns Promise<void>

directMove

• directMove(sourcePath: string, destPath: string): Promise<void>

  Parameters

  • sourcePath: string
  • destPath: string

  Returns Promise<void>

getMultipartReader

• getMultipartReader(path: string): AsyncIterable<Part<ChunkKind>>

  Parameters

  • path: string

  Returns AsyncIterable<Part<ChunkKind>>

getMultipartWriter

• getMultipartWriter(
      path: string,
  ): { write(parts: AsyncIterable<Part<ChunkKind>>): Promise<void> }

  Parameters

  • path: string

  Returns { write(parts: AsyncIterable<Part<ChunkKind>>): Promise<void> }

getProperties

• getProperties(path: string): Promise<ItemProperties>

  Parameters

  • path: string

  Returns Promise<ItemProperties>

getReadableStream

• getReadableStream(path: string): Promise<StreamHandle<ChunkKind>>

  Parameters

  • path: string

  Returns Promise<StreamHandle<ChunkKind>>

getWritableStream

• getWritableStream(path: string): Promise<StreamHandle<ChunkKind>>

  Parameters

  • path: string

  Returns Promise<StreamHandle<ChunkKind>>

list

• list(
      path: string,
      options?: { recursive?: boolean; regex?: RegExp },
  ): AsyncIterable<{ path: string; properties: ItemProperties }>

  Parameters

  • path: string
  • Optionaloptions: { recursive?: boolean; regex?: RegExp }

  Returns AsyncIterable<{ path: string; properties: ItemProperties }>

setProperties

• setProperties(
      path: string,
      properties: Partial<Record<string, unknown>>,
  ): Promise<void>

  Parameters

  • path: string
  • properties: Partial<Record<string, unknown>>

  Returns Promise<void>