Interface IStorage

Interface for safe file system operations within a specified directory

interface IStorage {
    createFile(name: string, content: string | Uint8Array): Path;
    path: Path;
    readBytes(path: string | Path): Uint8Array;
    readFile(path: string | Path): string;
    unpackContent(archivePath: string | Path): Path;
}

Implemented by

ScopedStorage

Index

Properties

Methods

createFile readBytes readFile unpackContent

Properties

path

path: Path

Gets the path of the storage directory

Methods

createFile

createFile(name: string, content: string | Uint8Array): Path
Creates a new file in the storage directory
Parameters
- name: string
- content: string | Uint8Array
Returns Path

readBytes

readBytes(path: string | Path): Uint8Array
Reads a file as a byte array
Parameters
- path: string | Path
Returns Uint8Array

readFile

readFile(path: string | Path): string
Reads a file as a string
Parameters
- path: string | Path
Returns string

unpackContent

unpackContent(archivePath: string | Path): Path
Unpacks a ZIP archive into the storage directory
Parameters
- archivePath: string | Path
Returns Path