Class StoreFS<T>Internal

A file system which uses a Store

Todo

Check modes?

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

_initialized _mountPoint? attributes id label? name store

Methods

_add _move _path _remove allocNew checkRoot checkRootSync commitNew commitNewSync createFile createFileSync createIndex createIndexSync empty emptySync exists existsSync findInode findInodeSync link linkSync loadIndex loadIndexSync metadata mkdir mkdirSync openFile openFileSync read readdir readdirSync readSync ready remove removeSync rename renameSync rmdir rmdirSync stat statSync streamRead streamWrite sync syncSync toString unlink unlinkSync usage write writeSync

Constructors

constructor

Properties

Protected_initialized

_initialized: boolean = false

Protected Optional Internal_mountPoint

_mountPoint?: string

The last place this file system was mounted

Readonlyattributes

attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void> & Map<
    string,
    any,
> = ...

See

FileSystemAttributes

Readonlyid

id: number

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

Optionallabel

label?: string

Readonlyname

name: string

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

Protected Readonlystore

store: T

Methods

_add

  • _add(ino: number, path: string): void

    Add a inode/path pair

    Parameters

    • ino: number
    • path: string

    Returns void

_move

  • _move(from: string, to: string): void

    Move paths in the tables

    Parameters

    • from: string
    • to: string

    Returns void

_path

  • _path(id: number): undefined | string

    Gets the first path associated with an inode

    Parameters

    • id: number

    Returns undefined | string

_remove

ProtectedallocNew

  • allocNew(path: string, syscall: string): number

    Allocates a new ID and adds the ID/path

    Parameters

    • path: string
    • syscall: string

    Returns number

checkRoot

  • checkRoot(): Promise<void>

    Checks if the root directory exists. Creates it if it doesn't.

    Returns Promise<void>

checkRootSync

ProtectedcommitNew

  • commitNew(
        path: string,
        options: PureCreationOptions,
        data: Uint8Array,
        syscall: string,
    ): Promise<Inode>

    Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.

    Parameters

    • path: string

      The path to the new file.

    • options: PureCreationOptions

      The options to create the new file with.

    • data: Uint8Array

      The data to store at the file's data node.

    • syscall: string

    Returns Promise<Inode>

ProtectedcommitNewSync

  • commitNewSync(
        path: string,
        options: PureCreationOptions,
        data: Uint8Array,
        syscall: string,
    ): Inode

    Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.

    Parameters

    • path: string

      The path to the new file.

    • options: PureCreationOptions

      The options to create the new file with.

    • data: Uint8Array

      The data to store at the file's data node.

    • syscall: string

    Returns Inode

    The Inode for the new file.

createFile

createFileSync

createIndex

createIndexSync

empty

emptySync

exists

existsSync

ProtectedfindInode

  • findInode(tx: WrappedTransaction, path: string, syscall: string): Promise<Inode>

    Finds the Inode of path.

    Parameters

    • tx: WrappedTransaction
    • path: string

      The path to look up.

    • syscall: string

    Returns Promise<Inode>

    Todo

    memoize/cache

ProtectedfindInodeSync

  • findInodeSync(tx: WrappedTransaction, path: string, syscall: string): Inode

    Finds the Inode of path.

    Parameters

    • tx: WrappedTransaction
    • path: string

      The path to look up.

    • syscall: string

    Returns Inode

    The Inode of the path p.

    Todo

    memoize/cache

link

linkSync

loadIndex

  • loadIndex(index: Index): Promise<void>

    Load an index into the StoreFS. You must manually add non-directory files

    Parameters

    Returns Promise<void>

loadIndexSync

metadata

mkdir

mkdirSync

openFile

openFileSync

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

      The offset into the file to start reading from

    • end: number

      The position in the file to stop reading

    Returns Promise<void>

readdir

readdirSync

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

      The offset into the file to start reading from

    • end: number

      The position in the file to stop reading

    Returns void

ready

Protectedremove

  • remove(path: string, isDir: boolean): Promise<void>

    Remove all traces of path from the file system.

    Parameters

    • path: string

      The path to remove from the file system.

    • isDir: boolean

      Does the path belong to a directory, or a file?

    Returns Promise<void>

    Todo

    Update mtime.

ProtectedremoveSync

  • removeSync(path: string, isDir: boolean): void

    Remove all traces of path from the file system.

    Parameters

    • path: string

      The path to remove from the file system.

    • isDir: boolean

      Does the path belong to a directory, or a file?

    Returns void

    Todo

    Update mtime.

rename

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

    Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

    Todo

    Make rename compatible with the cache.

renameSync

rmdir

rmdirSync

stat

statSync

streamRead

streamWrite

sync

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

    Updated the inode and data node at path

    Parameters

    • path: string
    • Optionaldata: Uint8Array<ArrayBufferLike>
    • Optionalmetadata: Readonly<InodeLike>

    Returns Promise<void>

    Todo

    Ensure mtime updates properly, and use that to determine if a data update is required.

syncSync

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

    Updated the inode and data node at path

    Parameters

    • path: string
    • Optionaldata: Uint8Array<ArrayBufferLike>
    • Optionalmetadata: Readonly<InodeLike>

    Returns void

    Todo

    Ensure mtime updates properly, and use that to determine if a data update is required.

toString

unlink

unlinkSync

usage

write

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

    Writes a buffer to a file

    Parameters

    • path: string
    • data: Uint8Array
    • offset: number

      The offset in the file to start writing

    Returns Promise<void>

writeSync

  • writeSync(path: string, data: Uint8Array, offset: number): void

    Writes a buffer to a file

    Parameters

    • path: string
    • data: Uint8Array
    • offset: number

      The offset in the file to start writing

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods