Class FileSystemAbstract Internal

constructor

• new FileSystem(id: number, name: string): FileSystem

  Parameters

  • id: number

    A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something
  • name: string

    The name for this file system. For example, tmpfs for an in memory one

  Returns FileSystem

Readonlyattributes

Readonlyid

Optionallabel

Readonlyname

AbstractcreateFile

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

  Create the file at path with the given options. Then, open it with flag.

  Parameters

  • path: string
  • flag: string
  • mode: number
  • options: CreationOptions

  Returns Promise<File<FileSystem>>

AbstractcreateFileSync

• createFileSync(
      path: string,
      flag: string,
      mode: number,
      options: CreationOptions,
  ): File

  Create the file at path with the given options. Then, open it with flag.

  Parameters

  • path: string
  • flag: string
  • mode: number
  • options: CreationOptions

  Returns File

exists

• exists(path: string): Promise<boolean>

  Test whether or not path exists.

  Parameters

  • path: string

  Returns Promise<boolean>

existsSync

• existsSync(path: string): boolean

  Test whether or not path exists.

  Parameters

  • path: string

  Returns boolean

Abstractlink

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

  Parameters

  • target: string
  • link: string

  Returns Promise<void>

AbstractlinkSync

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

  Parameters

  • target: string
  • link: string

  Returns void

metadata

• metadata(): FileSystemMetadata

  Get metadata about the current file system

  Returns FileSystemMetadata

  Deprecated

Abstractmkdir

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

  Parameters

  • path: string
  • mode: number
  • options: CreationOptions

  Returns Promise<void>

AbstractmkdirSync

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

  Parameters

  • path: string
  • mode: number
  • options: CreationOptions

  Returns void

AbstractopenFile

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

  Opens the file at path with flag. The file must exist.

  Parameters

  • path: string

    The path to open.
  • flag: string

    The flag to use when opening the file.

  Returns Promise<File<FileSystem>>

AbstractopenFileSync

• openFileSync(path: string, flag: string): File

  Opens the file at path with flag. The file must exist.

  Parameters

  • path: string

    The path to open.
  • flag: string

    The flag to use when opening the file.

  Returns File

Abstractread

• 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

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

    The position in the file to stop reading

  Returns Promise<void>

Abstractreaddir

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

  Parameters

  • path: string

  Returns Promise<string[]>

AbstractreaddirSync

• readdirSync(path: string): string[]

  Parameters

  • path: string

  Returns string[]

AbstractreadSync

• 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

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

    The position in the file to stop reading

  Returns void

ready

• ready(): Promise<void>

  Returns Promise<void>

Abstractrename

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

  Parameters

  • oldPath: string
  • newPath: string

  Returns Promise<void>

AbstractrenameSync

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

  Parameters

  • oldPath: string
  • newPath: string

  Returns void

Abstractrmdir

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

  Parameters

  • path: string

  Returns Promise<void>

AbstractrmdirSync

• rmdirSync(path: string): void

  Parameters

  • path: string

  Returns void

Abstractstat

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

  Parameters

  • path: string

  Returns Promise<Stats>

AbstractstatSync

• statSync(path: string): Stats

  Parameters

  • path: string

  Returns Stats

streamRead

• streamRead(path: string, options: StreamOptions): ReadableStream

  Read a file using a stream.

  Parameters

  • path: string
  • options: StreamOptions

  Returns ReadableStream

streamWrite

• streamWrite(path: string, options: StreamOptions): WritableStream

  Write a file using stream.

  Parameters

  • path: string
  • options: StreamOptions

  Returns WritableStream

Abstractsync

• sync(
      path: string,
      data?: Uint8Array<ArrayBufferLike>,
      stats?: Readonly<Partial<StatsLike<number | bigint>>>,
  ): Promise<void>

  Parameters

  • path: string
  • Optionaldata: Uint8Array<ArrayBufferLike>
  • Optionalstats: Readonly<Partial<StatsLike<number | bigint>>>

  Returns Promise<void>

AbstractsyncSync

• syncSync(
      path: string,
      data?: Uint8Array<ArrayBufferLike>,
      stats?: Readonly<Partial<StatsLike<number | bigint>>>,
  ): void

  Parameters

  • path: string
  • Optionaldata: Uint8Array<ArrayBufferLike>
  • Optionalstats: Readonly<Partial<StatsLike<number | bigint>>>

  Returns void

toString

• toString(): string

  Returns string

Abstractunlink

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

  Parameters

  • path: string

  Returns Promise<void>

AbstractunlinkSync

• unlinkSync(path: string): void

  Parameters

  • path: string

  Returns void

usage

• usage(): UsageInfo
  Experimental

  Default implementation.

  Returns UsageInfo

  Todo

  Implement

Abstractwrite

• 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>

AbstractwriteSync

• 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