Class StoreFS<T>Internal

A file system which uses a key-value store.

We use a unique ID for each node in the file system. The root node has a fixed ID.

Todo

Introduce Node ID caching?

Todo

Check modes?

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

_disableSync? _initialized store

Methods

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

Constructors

constructor

Properties

Protected Optional Internal_disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

Protected_initialized

_initialized: boolean = false

Protected Readonlystore

store: T

Methods

ProtectedallocNew

  • allocNew(tx: Transaction<Store>, path: string, syscall: string): Promise<number>

  • Adds a new node under a random ID. Retries before giving up in the exceedingly unlikely chance that we try to reuse a random id.

    Parameters

    Returns Promise<number>

ProtectedallocNewSync

  • allocNewSync(tx: Transaction<Store>, path: string, syscall: string): number

  • Creates a new node under a random ID. Retries before giving up in the exceedingly unlikely chance that we try to reuse a random id.

    Parameters

    Returns number

    The ino that the data was stored under.

checkRoot

  • checkRoot(): Promise<void>

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

    Returns Promise<void>

checkRootSync

ProtectedcommitNew

  • commitNew(
        path: string,
        type: FileType,
        options: PureCreationOptions,
        data: Uint8Array<ArrayBufferLike>,
        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.

    • type: FileType

      The type of the new file.

    • options: PureCreationOptions
    • data: Uint8Array<ArrayBufferLike>

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

    • syscall: string

    Returns Promise<Inode>

ProtectedcommitNewSync

  • commitNewSync(
        path: string,
        type: FileType,
        options: PureCreationOptions,
        data: Uint8Array<ArrayBufferLike>,
        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.

    • type: FileType

      The type of the new file.

    • options: PureCreationOptions
    • data: Uint8Array<ArrayBufferLike>

      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

  • empty(): Promise<void>

  • Delete all contents stored in the file system.

    Returns Promise<void>

    Deprecated

emptySync

exists

existsSync

ProtectedfindInodeSync

  • findInodeSync(
        tx: Transaction<Store>,
        path: string,
        syscall: string,
        visited?: Set<string>,
    ): Inode

  • Finds the Inode of path.

    Parameters

    • tx: Transaction<Store>
    • path: string

      The path to look up.

    • syscall: string
    • visited: Set<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<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

readdirSync

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

ready

Protectedremove

  • remove(path: string, isDir: boolean, syscall: string): 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?

    • syscall: string

    Returns Promise<void>

    Todo

    Update mtime.

ProtectedremoveSync

  • removeSync(path: string, isDir: boolean, syscall: string): 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?

    • syscall: string

    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

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.

unlink

unlinkSync

write

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

  • Writes a buffer to a file

    Parameters

    • path: string
    • data: Uint8Array<ArrayBufferLike>
    • offset: number

      The offset in the file to start writing

    Returns Promise<void>

writeSync

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

  • Writes a buffer to a file

    Parameters

    • path: string
    • data: Uint8Array<ArrayBufferLike>
    • offset: number

      The offset in the file to start writing

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods