Class PassthroughFSInternal

constructor

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

  Parameters

  • nodeFS: __module
  • prefix: string

  Returns PassthroughFS

ReadonlynodeFS

Readonlyprefix

createFile

• createFile(path: string, options: CreationOptions): Promise<InodeLike>

  Create a file.

  Parameters

  • path: string
  • options: CreationOptions

  Returns Promise<InodeLike>

createFileSync

• createFileSync(path: string, options: CreationOptions): InodeLike

  Create a file synchronously.

  Parameters

  • path: string
  • options: CreationOptions

  Returns InodeLike

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, options: CreationOptions): Promise<InodeLike>

  Create a directory.

  Parameters

  • path: string
  • options: CreationOptions

  Returns Promise<InodeLike>

mkdirSync

• mkdirSync(path: string, options: CreationOptions): InodeLike

  Create a directory synchronously.

  Parameters

  • path: string
  • options: CreationOptions

  Returns InodeLike

path

• path(path: string): string

  Parameters

  • path: string

  Returns string

read

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

  Reads into a buffer

  Parameters

  • path: string
  • buffer: Uint8Array

    The buffer to read into. You must set the byteOffset and byteLength appropriately!
  • offset: number
  • 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, offset: number, end: number): void

  Reads into a buffer

  Parameters

  • path: string
  • buffer: Uint8Array

    The buffer to read into. You must set the byteOffset and byteLength appropriately!
  • offset: number
  • 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<InodeLike>

  Get file statistics.

  Parameters

  • path: string

  Returns Promise<InodeLike>

statSync

• statSync(path: string): InodeLike

  Get file statistics synchronously.

  Parameters

  • path: string

  Returns InodeLike

sync

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

  Synchronize data to the file system.

  Parameters

  • path: string

  Returns Promise<void>

syncSync

• syncSync(path: string): void

  Synchronize data to the file system synchronously.

  Parameters

  • path: string

  Returns void

touch

• touch(path: string, metadata: InodeLike): Promise<void>

  Modify metadata.

  Parameters

  • path: string
  • metadata: InodeLike

  Returns Promise<void>

touchSync

• touchSync(path: string, metadata: InodeLike): void

  Modify metadata.

  Parameters

  • path: string
  • metadata: 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

usage

• usage(): UsageInfo
  Experimental

  Default implementation.

  Returns UsageInfo

  Todo

  Implement

write

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

  Writes a buffer to a file

  Parameters

  • path: string
  • buffer: Uint8Array

    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, offset: number): void

  Writes a buffer to a file

  Parameters

  • path: string
  • buffer: Uint8Array

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

    The offset in the file to start writing

  Returns void