Class PassthroughFSInternal

constructor

• new PassthroughFS(nodeFS: __module, prefix: string): PassthroughFS

• Parameters

  • nodeFS: __module
  • prefix: string

  Returns PassthroughFS

ReadonlynodeFS

Readonlyprefix

createFile

• createFile(path: string, flag: string, mode: number): Promise<File<FileSystem>>

• Create a file.

  Parameters

  • path: string
  • flag: string
  • mode: number

  Returns Promise<File<FileSystem>>

createFileSync

• createFileSync(path: string, flag: string, mode: number): File<FileSystem>

• Create a file synchronously.

  Parameters

  • path: string
  • flag: string
  • mode: number

  Returns File<FileSystem>

error

• error(err: unknown, path: string): never

• Parameters

  • err: unknown
  • path: string

  Returns never

link

• link(target: string, link: string): Promise<void>

• Create a hard link.

  Parameters

  • target: string
  • link: string

  Returns Promise<void>

linkSync

• linkSync(target: string, link: string): void

• Create a hard link synchronously.

  Parameters

  • target: string
  • link: string

  Returns void

mkdir

• mkdir(path: string, mode: number): Promise<void>

• Create a directory.

  Parameters

  • path: string
  • mode: number

  Returns Promise<void>

mkdirSync

• mkdirSync(path: string, mode: number): void

• Create a directory synchronously.

  Parameters

  • path: string
  • mode: number

  Returns void

openFile

• openFile(path: string, flag: string): Promise<File<FileSystem>>

• Open a file.

  Parameters

  • path: string
  • flag: string

  Returns Promise<File<FileSystem>>

openFileSync

• openFileSync(path: string, flag: string): File<FileSystem>

• Open a file synchronously.

  Parameters

  • path: string
  • flag: string

  Returns File<FileSystem>

path

• path(path: string): string

• Parameters

  • path: string

  Returns string

read

• read(
      path: string,
      buffer: Uint8Array<ArrayBufferLike>,
      offset: number,
      end: number,
  ): Promise<void>

• Reads into a buffer

  Parameters

  • path: string
  • buffer: Uint8Array<ArrayBufferLike>

    The buffer to read into. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset into the file to start reading from
  • end: number

    The position in the file to stop reading

  Returns Promise<void>

readdir

• readdir(path: string): Promise<string[]>

• Read the contents of a directory.

  Parameters

  • path: string

  Returns Promise<string[]>

readdirSync

• readdirSync(path: string): string[]

• Read the contents of a directory synchronously.

  Parameters

  • path: string

  Returns string[]

readSync

• readSync(
      path: string,
      buffer: Uint8Array<ArrayBufferLike>,
      offset: number,
      end: number,
  ): void

• Reads into a buffer

  Parameters

  • path: string
  • buffer: Uint8Array<ArrayBufferLike>

    The buffer to read into. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset into the file to start reading from
  • end: number

    The position in the file to stop reading

  Returns void

rename

• rename(oldPath: string, newPath: string): Promise<void>

• Rename a file or directory.

  Parameters

  • oldPath: string
  • newPath: string

  Returns Promise<void>

renameSync

• renameSync(oldPath: string, newPath: string): void

• Rename a file or directory synchronously.

  Parameters

  • oldPath: string
  • newPath: string

  Returns void

rmdir

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

• Remove a directory.

  Parameters

  • path: string

  Returns Promise<void>

rmdirSync

• rmdirSync(path: string): void

• Remove a directory synchronously.

  Parameters

  • path: string

  Returns void

stat

• stat(path: string): Promise<Stats>

• Get file statistics.

  Parameters

  • path: string

  Returns Promise<Stats>

statSync

• statSync(path: string): Stats

• Get file statistics synchronously.

  Parameters

  • path: string

  Returns Stats

sync

• sync(
      path: string,
      data: Uint8Array<ArrayBufferLike>,
      stats: Readonly<InodeLike>,
  ): Promise<void>

• Synchronize data to the file system.

  Parameters

  • path: string
  • data: Uint8Array<ArrayBufferLike>
  • stats: Readonly<InodeLike>

  Returns Promise<void>

syncSync

• syncSync(
      path: string,
      data: Uint8Array<ArrayBufferLike>,
      stats: Readonly<InodeLike>,
  ): void

• Synchronize data to the file system synchronously.

  Parameters

  • path: string
  • data: Uint8Array<ArrayBufferLike>
  • stats: Readonly<InodeLike>

  Returns void

unlink

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

• Unlink (delete) a file.

  Parameters

  • path: string

  Returns Promise<void>

unlinkSync

• unlinkSync(path: string): void

• Unlink (delete) a file synchronously.

  Parameters

  • path: string

  Returns void

write

• write(
      path: string,
      buffer: Uint8Array<ArrayBufferLike>,
      offset: number,
  ): Promise<void>

• Writes a buffer to a file

  Parameters

  • path: string
  • buffer: Uint8Array<ArrayBufferLike>

    The buffer to write. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset in the file to start writing

  Returns Promise<void>

writeSync

• writeSync(
      path: string,
      buffer: Uint8Array<ArrayBufferLike>,
      offset: number,
  ): void

• Writes a buffer to a file

  Parameters

  • path: string
  • buffer: Uint8Array<ArrayBufferLike>

    The buffer to write. You must set the byteOffset and byteLength appropriately!
  • offset: number

    The offset in the file to start writing

  Returns void