Class FileSystemAbstract Internal

constructor

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

  Parameters

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

Optionallabel

Readonlyname

Readonlytype

uuid

• get uuid(): `${string}-${string}-${string}-${string}-${string}`

  Returns `${string}-${string}-${string}-${string}-${string}`

AbstractcreateFile

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

  Create the file at path with the given options.

  Parameters

  • path: string
  • options: CreationOptions

  Returns Promise<InodeLike<number>>

AbstractcreateFileSync

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

  Create the file at path with the given options.

  Parameters

  • path: string
  • options: CreationOptions

  Returns InodeLike

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

Abstractmkdir

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

  Parameters

  • path: string
  • options: CreationOptions

  Returns Promise<InodeLike<number>>

AbstractmkdirSync

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

  Parameters

  • path: string
  • options: CreationOptions

  Returns InodeLike

Abstractread

• read(
      path: string,
      buffer: Uint8Array,
      start: 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!

  • start: 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, start: 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!

  • start: 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<InodeLike<number>>

  Parameters

  • path: string

  Returns Promise<InodeLike<number>>

AbstractstatSync

• statSync(path: string): InodeLike

  Parameters

  • path: string

  Returns InodeLike

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(): Promise<void>

  Returns Promise<void>

AbstractsyncSync

• syncSync(): void

  Returns void

toString

• toString(): string

  Returns string

Abstracttouch

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

  Modify metadata.

  Parameters

  • path: string
  • metadata: Partial<InodeLike>

  Returns Promise<void>

AbstracttouchSync

• touchSync(path: string, metadata: Partial<InodeLike>): void

  Modify metadata.

  Parameters

  • path: string
  • metadata: Partial<InodeLike>

  Returns void

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