From 77d85f7bbcc1f51ff9f0692c6754621b4aa12e2c Mon Sep 17 00:00:00 2001 From: dr-vortex Date: Sat, 23 Mar 2024 00:12:16 +0000 Subject: [PATCH] deploy: c05ec33543af08833829e6c338f2193383356365 --- assets/navigation.js | 2 +- assets/search.js | 2 +- classes/FileSystemAccessFS.html | 6 +++--- classes/FileSystemAccessFile.html | 8 ++++---- classes/IndexedDBStore.html | 4 ++-- classes/StorageStore.html | 4 ++-- interfaces/FileSystemAccessOptions.html | 2 ++ interfaces/IndexedDBOptions.html | 8 ++++---- interfaces/StorageOptions.html | 4 ++-- modules.html | 3 ++- variables/FileSystemAccess.html | 2 +- variables/IndexedDB.html | 2 +- variables/Storage.html | 2 +- 13 files changed, 26 insertions(+), 23 deletions(-) create mode 100644 interfaces/FileSystemAccessOptions.html diff --git a/assets/navigation.js b/assets/navigation.js index eb6ac1f..3a8871f 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43RMQvCMBAF4P9yc1GsKNJNkYKTQ0dxiMlpD9O0NIdUxP8uQrGNTUPn9/LxkpxewNgwJJCSxuxpGYutlGhtmkEEleAcEpBaWIt2PuzMci40RHAnoyBZxJt3NC6SxgkmaQypB6OwQbXfZVzWHs/NQ9K3IG444vTTSXuOFVNpbCeRYayvQvZHtSUXjFfr4awQ51ZC2P/rdtxD1CQu2vMDrreMfZf1Ob8wALTLfcfbaHD4/AF+P5O+pAIAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5XPMQvCMBAF4P9yc1GsKNJNkYKTQ0dxiOlpD9O0NIdUxP8uQrCmTYPO793HvcMDGFuGBFJSmN0NY7mWEo1JM4igFlxAAlIJY9BMh51JwaWCCK6kc0hm8eoZjYuk8AeTFIbUnc6xxXy7ybhqPJ6bh6R3QVxwxPlO/1m5r5kqbTqQNGNzFtKz1XZdPl4sfXNDbr8UAu2uEOdWQlh/UMfdREPipDyjXW8e+8b6nE8YAOznvnMbDY6PL3oYO9UDAwAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index cd1c44b..6fb6c59 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WaTW/jNhCG/wtz1XrND3/eWhSL7qU9uOhFCBaKxCRCbNmQlGxTI/+9ICVZM/aMQ0XpKZtohu8Mn+GIFPcoyv3PSqzjo3jKi0yspVpGokh2VqzFt3xrN69VbXe/pKmtKve7iMRzuRVrkW6TqrLVV8po8ljvtiLqbMRaiLeoU5hJdVJI90VVl89pvS/DB77BXkAkEoektEXNxd4Hoaamz7N6LdLNa5EOCAG4fI7+QO1P0U23+2oA0JvO/pOUB0459PlQBFdLe/N+JJv/p6w3I4p6A9ObKnOK4MdjUmRbWwXLA4deu66yL3n15VDmL0ltgyNBqEubZK/BYXTWH8gfqe5snWRJnQQLA4ex2mHLefORxXxllv0/wqe5NR+r+7PMaxv2XmilocdY9bS0yUB55DKadJ3U4aQb47Ga+4MtBmUMHMZqPxfbvHgKVj6Zj9UdpPpJmuUuy8O7d2c9um89DVHtrMd3jyQblO3Jfqzyg61/9y+eYG3oQbyp9rVNa5sFR6MVuyc4hfSSlHlytyWCurojgPuN70Vm/7HZb79u6n15mSx+fHVUogGGDHdzMqWRnQU4fF9DagbsaVhhtJ/J7oIEvVlYVYTpVu7hH9SrlZKH1iOjUHMlTR8H+XanQrj6XufV8ObcJoF8W8sxanf2IS/+KpOiStI63xdBwoTT0Bhm88vF+efBDdYv/LyobXmfpDCK1ub6yr9eQu8Ny9QRmVcXMiOeJumj3eT/DhCHLuPE8+zuW+IW/2u4OvIZLA+6+cmKaOOnZ8H925VP8mDp7g0ffsoZ8WLAoE6KYhzWSS4Fr/YRRgmfQKvGKEALmIZ1TS7T97sYMbNXe1iI0rsd7FI0uH+F6D/Yy0PIpWRj9XGVw3OISmP1cZXS7vYvITVzMhymBbp+a3Kl52OLYR0fVv71IW+o6idyudrtNmeSfa9rn1DR30Yid51QrI/ixZaVK8S1UBM9WYlI3Od2m7lPw13LSPe7nYvotn32t3XtyFk0Jl+nIoqnkZ5NpvP57W0Udx7+gf+DN5MiimWkzGS6WCEzicyUiGJFjaaQmRZRrCO1mqxmC2SmkZkRUWyo0Qwym4konlFmM2Q2F1E8p8zmyGzBZbpAZksRxQtqtCUyW4koXlJmKzy9brZXlJ084yC5qZOYhHQzLkmyEsOQbtKlJC0xD+nmXZJ8JUYi3dRLTVpiKtLNviQpSwxGejIkaInZSMdAkqwlxiMdBklylJiQchwkiVJhRMqvFRKmOlstfrmQjBRmpBwIRTJSmJFyIBS9BjEj5UAokpHCjNScWxMKI1KOgyJhKoxIOQ5qRhWywoiU46DmpCVGpB0HtSD7CkakHQe1JC0xIu0RkTD1WU/TbEYaI9KOgyaxa4xIOw6axK4xIu1AaBK7xoy0A6FJ7Boz0ksOu8aINI9IY0TGcdB0T8eIjGRhGozIKBamwYiMf++QHcScvXk8IrKDGIzIeERkBzEYkfGIyA5iMCLjEa3IjDAis+QtG0Z+v/Biy9pm35t9QxyDm6aj+NFuJxbdvuQolmJ9fHvrNw/uNzd0v+fv3bTp/cyUcfRb5xpunfsB+gPbUWjpXCJhFDOQP+dW/pwLQpiCEQzn2RwZgC5IWE9bXcl6+1vU3htmfc2nuSrq/Wa934zzg8fG3lP2nu0sLZofat781By27isiyF33gyk2Du92728hQBgKxMGl7j7pATUwWWrBuDidyn+lTdoPuWAAkLvSgQOcBw6KhCvTiyFQFPN+gDkzgD+vgcIEtA0X94OtH9tv4yBjEK3iFkOe3d13n12AKJgszbHNm48pmJMGaDWX4slz353BQNQrMAAbdTdA1XyXAe5AX3Gl1dwUgXoEWCS3AvqL4t4RxCq5gmjvaoAaaFaK82qOXiAvEKJatYt1xTi7m7+LNQcWkOTA+FM8gAlEDTeZpzshoAXmRXHtsL3x773AtHCJdYd/ECLowIar1O7WG0QI1obkqqy92wNeQExyMTbXvcAJ9EnJRUi9FMEkmrZNG644W39iPWkwrYbj3rpfrCYNYtdc1/VeF/UK2pZatvXKta/zFxxUbVwlV0XO9dwdtgDGrbuhBphAwJJL1f8fhouVBd+qZIq3kTjkB7vNCyvW8e3b238Ey3EHficAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WaS2/kNgzHv4ty9WZHD8/r1qJYdC/tYYpejGDh2EpiZMYzsJ1s0yDfvZCf5JicyHF62k1M6k/qR9GSlVdRHH+WYhu9iscsT8VWhctA5PHBiq34lu3t7qWs7OGXJLFl+eepyo55KQLxVOzFVmR5ZYu7OLHlV8b0+qE67EUgkn1clrYUWyHegk5KLpTptR7iPN3bqUNf9W5AIRCnuLB5dSEDEIRas/m6n/uIWoFROO7ni2mGUvUKyTEvq+IpqY6F/8BX2Msv0zr2IQi1MEOe5Uue7F7yZEIIwOVz9Cdqf4pusj+WE4BedfafpDxxyqHPhyK4WNq79yPZ/T9lvZtR1DuuffxoGkHpLQ8cBu2qTL9k5ZdTkT3HlfWOBKEubJy+eIfRWX8gf6R6sFWcxlXsLQwc5mr7LefdRxbzhVmu/+M/za35XN2fRVZZv/dCKw095qonhY0nyiOX2aSruPIn3RjP1TyebD4pY+AwV/sp32f5o7dybz5Xd5LqJ2kWhzTz796d9ey+9ThFtbOe3z3idFK2vf1c5Xtb/Y53uu9pQw/iTXWsbFLZ1Dsardg9QR/Sc1xk8e2eCOryfh7sN77nqf3Hpr/9uquOxThZ/PjiqEQD9BnuqjelkZ0FOH1fQ2p67GlYYbSfSW+9BGszv6rw0y3dwz+oVyslD61nRqGWSpohDvLtToVw8b3Oq+HNuY09+baWc9Ru7X2W/1XEeRkn7jDqJUw4TY0BnOt7owsH+nMb/5P8uITeG5apIzIv4gQPxZM4ebC77N8J4tBlnniW3n6L3eJ/8VdHPpPlQTfvrYg23j/z7t+ufOJ7S3dv+PBTzoijAb06KYpxWicZC17sI4wSPoGWjZGHFjD165pcpu93MWJmL/YwH6V3O9hY1Lt/+ejf2/EhZCzZWH1c5fTko9JYfVylsIfjs0/N9IbTtEDXb00u9HxsMa3jw8q/POQVVf1ELhe73e5Mcuh17RMq+ptAZK4Tiu2reLZF6QpxK9S1vt6IQNxldp+6T+Fdy0iOh4OL6KZ99rd17chZNCZfFyKIFoEOr024vrkJos6jflD/ojaTIogkZSaRmRJBpCgzhcy0CCIdKHNtVgqZaWRmRBAZajSDzEIRRGGgF9c6RFYhslqKIFpSgy2R2UoE0YoyWyGztQiiNWW2RmYbLtENnl032Rtyes8w1BxIXhKTkG7GJY0Mw5CamT+JaUg365KkKzEQ6WZeatISQ5Fu8iXJWGIu0s2/DElLjEY6BJJELTEd6ShIkrbEgJTDIEngChNSNSGSpTpbK/ViIVkqTEg5EIpkqTAj5UAoegViRsqBUCQjhRkpB0KRjBRmpBwIRTJSmJFacwtDYUTKcVAkTIURacdBrYg61piQdhjUmjLEgHQNaEMZnrWzup8tKEOMRzsGmgSpMR4dstlgOtoh0CRxjeloh0CTxDWmo2s6JHGN8ei6wZHENcZjFhxxg/EYFo/BeIyDoMnSMJiP0RxIc/bCMRxIg/EYB0GTncNgPqbmQ3YOg/mYmg/ZOQzmYxwEQ3YOg/kYB8FIKiGMJ1xwhmGDp953PNuisun3Zv8RReDG6lX8aLclm25/8yrkQmxf396GXYj7yY09HB4GP70cHI1iHOs9eAX34GCAxTCA1s4lEMYwA9UH5rI+MIMRFBhhyXk2Z4/BS4GMtWp1NetdX8cO3iBrXvFY2ubOafBbDX4rzg+eP0GWINwm2k3zj1q3wXPYus+RIPdwGEyxcdRud/V1xuAqDSgULnX3bRCogclSG8bF6ZT15964/SIMBgC5q9BzgPPAQZFwZToaAkWxHgZYew5w7A48wyig2jle9fERgAc1Y7js723V/T0KSBnmzC2psZsEhBmnLL296z4dgUhhjXJllTUfhHCJaFBVmpvd3pOYVg2C1lyq/QBl820JzBTQV1xVN7ddYJ5ARSgO5nDZDRzhDHPF2F44gRhB6SjOqzk/AicQo5Zto+CouuvL0XoHi1dyZOpPEQAGEDXcbPYXWyBYMC+Ka8Xtny2ACMG8SC617hsGCBL0f8MVa3d5D9TAmpJcobVXlMALiCkuxubWGjiBLi25CIlXsgHTaNqXRMjVZ+tPLCkD5tVw5Fv30YLSIHbN9fzaa1SxoN3pRRO95tre+esVqIaNq+TqyLmeu4MuwKHtLtoBJhCw5FKt/xRjtLZAv5RkijeBOGUnu89yK7bRzdvbfyu4EQ81KQAA"; \ No newline at end of file diff --git a/classes/FileSystemAccessFS.html b/classes/FileSystemAccessFS.html index 23c6533..2f6ca4b 100644 --- a/classes/FileSystemAccessFS.html +++ b/classes/FileSystemAccessFS.html @@ -1,4 +1,4 @@ -FileSystemAccessFS | ZenFS DOM

Class FileSystemAccessFS

Hierarchy

  • AsyncFileSystem<this> & FileSystem<this>
    • FileSystemAccessFS

Constructors

constructor +FileSystemAccessFS | ZenFS DOM

Class FileSystemAccessFS

Hierarchy

  • AsyncFileSystem<this> & FileSystem<this>
    • FileSystemAccessFS

Constructors

constructor

Properties

_handles

Methods

createFile createFileSync @@ -26,6 +26,6 @@ unlink unlinkSync writeFile -

Constructors

constructor

Properties

Private _handles

_handles: Map<string, FileSystemHandle> = ...

Methods

createFile

createFileSync

  • createFileSync(path, flag, mode, cred): File

  • Parameters

    • path: string
    • flag: FileFlag
    • mode: number
    • cred: Cred

    Returns File

exists

  • exists(path, cred): Promise<boolean>

  • Test whether or not the given path exists by checking with the file system.

    +

Constructors

constructor

Properties

Private _handles

_handles: Map<string, FileSystemHandle> = ...

Methods

createFile

createFileSync

  • createFileSync(path, flag, mode, cred): File

  • Parameters

    • path: string
    • flag: FileFlag
    • mode: number
    • cred: Cred

    Returns File

exists

  • exists(path, cred): Promise<boolean>

  • Test whether or not the given path exists by checking with the file system.

    Parameters

    • path: string
    • cred: Cred

    Returns Promise<boolean>

existsSync

  • existsSync(path, cred): boolean

  • Test whether or not the given path exists by checking with the file system.

    -

    Parameters

    • path: string
    • cred: Cred

    Returns boolean

Protected getHandle

  • getHandle(path): Promise<FileSystemHandle>

  • Parameters

    • path: string

    Returns Promise<FileSystemHandle>

link

linkSync

  • linkSync(srcpath, dstpath, cred): void

  • Parameters

    • srcpath: string
    • dstpath: string
    • cred: Cred

    Returns void

metadata

mkdir

  • mkdir(path): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

mkdirSync

  • mkdirSync(path, mode, cred): void

  • Parameters

    • path: string
    • mode: number
    • cred: Cred

    Returns void

openFile

openFileSync

  • openFileSync(path, flag, cred): File

  • Parameters

    • path: string
    • flag: FileFlag
    • cred: Cred

    Returns File

readdir

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

  • Parameters

    • path: string

    Returns Promise<string[]>

readdirSync

  • readdirSync(path, cred): string[]

  • Parameters

    • path: string
    • cred: Cred

    Returns string[]

ready

rename

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

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

renameSync

  • renameSync(oldPath, newPath, cred): void

  • Parameters

    • oldPath: string
    • newPath: string
    • cred: Cred

    Returns void

rmdir

  • rmdir(path): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

rmdirSync

  • rmdirSync(path, cred): void

  • Parameters

    • path: string
    • cred: Cred

    Returns void

stat

  • stat(path): Promise<Stats>

  • Parameters

    • path: string

    Returns Promise<Stats>

statSync

  • statSync(path, cred): Stats

  • Parameters

    • path: string
    • cred: Cred

    Returns Stats

sync

  • sync(p, data, stats): Promise<void>

  • Parameters

    • p: string
    • data: Uint8Array
    • stats: Stats

    Returns Promise<void>

syncSync

  • syncSync(path, data, stats): void

  • Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns void

unlink

  • unlink(path): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

unlinkSync

  • unlinkSync(path, cred): void

  • Parameters

    • path: string
    • cred: Cred

    Returns void

writeFile

  • writeFile(fname, data): Promise<void>

  • Parameters

    • fname: string
    • data: Uint8Array

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructor_handlescreateFilecreateFileSyncexistsexistsSyncgetHandlelinklinkSyncmetadatamkdirmkdirSyncopenFileopenFileSyncreaddirreaddirSyncreadyrenamerenameSyncrmdirrmdirSyncstatstatSyncsyncsyncSyncunlinkunlinkSyncwriteFile

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns boolean

Protected getHandle

link

linkSync

metadata

mkdir

mkdirSync

openFile

openFileSync

readdir

readdirSync

ready

rename

renameSync

rmdir

rmdirSync

stat

statSync

sync

syncSync

unlink

unlinkSync

writeFile

Settings

Member Visibility

Theme

On This Page

constructor_handlescreateFilecreateFileSyncexistsexistsSyncgetHandlelinklinkSyncmetadatamkdirmkdirSyncopenFileopenFileSyncreaddirreaddirSyncreadyrenamerenameSyncrmdirrmdirSyncstatstatSyncsyncsyncSyncunlinkunlinkSyncwriteFile

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/FileSystemAccessFile.html b/classes/FileSystemAccessFile.html index 8de7dda..994180a 100644 --- a/classes/FileSystemAccessFile.html +++ b/classes/FileSystemAccessFile.html @@ -1,4 +1,4 @@ -FileSystemAccessFile | ZenFS DOM

Class FileSystemAccessFile

Hierarchy

Constructors

constructor +FileSystemAccessFile | ZenFS DOM

Class FileSystemAccessFile

Hierarchy

Constructors

constructor

Properties

_buffer _dirty _position @@ -32,7 +32,7 @@ utimesSync write writeSync -

Constructors

constructor

Properties

Protected _buffer

_buffer: Uint8Array

Protected _dirty

_dirty: boolean

Protected _position

_position: number

Readonly flag

flag: FileFlag

Protected fs

fs: FileSystemAccessFS

The file system that created the file.

+

Constructors

constructor

Properties

Protected _buffer

_buffer: Uint8Array

Protected _dirty

_dirty: boolean

Protected _position

_position: number

Readonly flag

flag: FileFlag

Protected fs

fs: FileSystemAccessFS

The file system that created the file.

Readonly path

path: string

Path to the file

Readonly stats

stats: Stats

Accessors

buffer

  • get buffer(): Uint8Array

  • Get the underlying buffer for this file. Mutating not recommended and will mess up dirty tracking.

    Returns Uint8Array

position

  • get position(): number

  • Get the current file position.

    @@ -50,7 +50,7 @@

Returns Promise<void>

chmodSync

  • chmodSync(mode): void

  • Synchronous fchmod.

    Parameters

    • mode: number

    Returns void

chown

  • chown(uid, gid): Promise<void>

  • Asynchronous fchown.

    Parameters

    • uid: number
    • gid: number

    Returns Promise<void>

chownSync

  • chownSync(uid, gid): void

  • Synchronous fchown.

    -

    Parameters

    • uid: number
    • gid: number

    Returns void

close

closeSync

datasync

  • datasync(): Promise<void>

  • Asynchronous datasync.

    +

    Parameters

    • uid: number
    • gid: number

    Returns void

close

closeSync

datasync

  • datasync(): Promise<void>

  • Asynchronous datasync.

    Default implementation maps to sync.

    Returns Promise<void>

datasyncSync

  • datasyncSync(): void

  • Synchronous datasync.

    Default implementation maps to syncSync.

    @@ -75,7 +75,7 @@

Protected resetDirty

  • resetDirty(): void

  • Resets the dirty bit. Should only be called after a sync has completed successfully.

    Returns void

stat

  • stat(): Promise<Stats>

  • Asynchronous stat.

    Returns Promise<Stats>

statSync

  • statSync(): Stats

  • Synchronous stat.

    -

    Returns Stats

sync

syncSync

truncate

  • truncate(len): Promise<void>

  • Asynchronous truncate.

    +

    Returns Stats

sync

syncSync

truncate

  • truncate(len): Promise<void>

  • Asynchronous truncate.

    Parameters

    • len: number

    Returns Promise<void>

truncateSync

  • truncateSync(len): void

  • Synchronous truncate.

    Parameters

    • len: number

    Returns void

utimes

  • utimes(atime, mtime): Promise<void>

  • Parameters

    • atime: Date
    • mtime: Date

    Returns Promise<void>

utimesSync

  • utimesSync(atime, mtime): void

  • Parameters

    • atime: Date
    • mtime: Date

    Returns void

write

  • write(buffer, offset?, length?, position?): Promise<number>

  • Write buffer to the file. Note that it is unsafe to use fs.write multiple times on the same file diff --git a/classes/IndexedDBStore.html b/classes/IndexedDBStore.html index fa88c07..e55c012 100644 --- a/classes/IndexedDBStore.html +++ b/classes/IndexedDBStore.html @@ -1,8 +1,8 @@ -IndexedDBStore | ZenFS DOM

    Class IndexedDBStore

    Implements

    • AsyncStore

    Constructors

    constructor +IndexedDBStore | ZenFS DOM

    Class IndexedDBStore

    Implements

    • AsyncStore

    Constructors

    constructor

    Properties

    db storeName

    Accessors

    name

    Methods

    beginTransaction clear create -

    Constructors

    constructor

    Properties

    Protected db

    db: IDBDatabase

    Protected storeName

    storeName: string

    Accessors

    name

    Methods

    beginTransaction

    • beginTransaction(type): AsyncROTransaction

    • Parameters

      • type: "readonly"

      Returns AsyncROTransaction

    • beginTransaction(type): AsyncRWTransaction

    • Parameters

      • type: "readwrite"

      Returns AsyncRWTransaction

    clear

    • clear(): Promise<void>

    • Returns Promise<void>

    Static create

    Settings

    Member Visibility

    Theme

    On This Page

    constructordbstoreNamenamebeginTransactionclearcreate

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected db

    db: IDBDatabase

    Protected storeName

    storeName: string

    Accessors

    name

    Methods

    beginTransaction

    • beginTransaction(type): AsyncROTransaction

    • Parameters

      • type: "readonly"

      Returns AsyncROTransaction

    • beginTransaction(type): AsyncRWTransaction

    • Parameters

      • type: "readwrite"

      Returns AsyncRWTransaction

    clear

    • clear(): Promise<void>

    • Returns Promise<void>

    Static create

    Settings

    Member Visibility

    Theme

    On This Page

    constructordbstoreNamenamebeginTransactionclearcreate

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/StorageStore.html b/classes/StorageStore.html index 53c43da..58ac7be 100644 --- a/classes/StorageStore.html +++ b/classes/StorageStore.html @@ -1,5 +1,5 @@ StorageStore | ZenFS DOM

    Class StorageStore

    A synchronous key-value store backed by Storage.

    -

    Implements

    • SyncStore
    • SimpleSyncStore

    Constructors

    constructor +

    Implements

    • SyncStore
    • SimpleSyncStore

    Constructors

    constructor

    Properties

    _storage

    Accessors

    name

    Methods

    beginTransaction @@ -7,4 +7,4 @@ get put remove -

    Constructors

    constructor

    Properties

    Protected _storage

    _storage: Storage

    Accessors

    name

    • get name(): string

    • Returns string

    Methods

    beginTransaction

    • beginTransaction(): SyncRWTransaction

    • Returns SyncRWTransaction

    clear

    • clear(): void

    • Returns void

    get

    • get(key): Uint8Array

    • Parameters

      • key: bigint

      Returns Uint8Array

    put

    • put(key, data, overwrite): boolean

    • Parameters

      • key: bigint
      • data: Uint8Array
      • overwrite: boolean

      Returns boolean

    remove

    • remove(key): void

    • Parameters

      • key: bigint

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructor_storagenamebeginTransactioncleargetputremove

    Generated using TypeDoc

    \ No newline at end of file +

Constructors

constructor

Properties

Protected _storage

_storage: Storage

Accessors

name

  • get name(): string

  • Returns string

Methods

beginTransaction

  • beginTransaction(): SyncRWTransaction

  • Returns SyncRWTransaction

clear

  • clear(): void

  • Returns void

get

  • get(key): Uint8Array

  • Parameters

    • key: bigint

    Returns Uint8Array

put

  • put(key, data, overwrite): boolean

  • Parameters

    • key: bigint
    • data: Uint8Array
    • overwrite: boolean

    Returns boolean

remove

  • remove(key): void

  • Parameters

    • key: bigint

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor_storagenamebeginTransactioncleargetputremove

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/FileSystemAccessOptions.html b/interfaces/FileSystemAccessOptions.html new file mode 100644 index 0000000..155bad1 --- /dev/null +++ b/interfaces/FileSystemAccessOptions.html @@ -0,0 +1,2 @@ +FileSystemAccessOptions | ZenFS DOM

Interface FileSystemAccessOptions

interface FileSystemAccessOptions {
    handle: FileSystemDirectoryHandle;
}

Properties

handle +

Properties

handle

handle: FileSystemDirectoryHandle

Settings

Member Visibility

Theme

On This Page

handle

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/IndexedDBOptions.html b/interfaces/IndexedDBOptions.html index 1a59b28..4f1255e 100644 --- a/interfaces/IndexedDBOptions.html +++ b/interfaces/IndexedDBOptions.html @@ -1,8 +1,8 @@ IndexedDBOptions | ZenFS DOM

Interface IndexedDBOptions

Configuration options for the IndexedDB file system.

-
interface IndexedDBOptions {
    cacheSize?: number;
    idbFactory?: IDBFactory;
    storeName?: string;
}

Properties

cacheSize? +
interface IndexedDBOptions {
    cacheSize?: number;
    idbFactory?: IDBFactory;
    storeName?: string;
}

Properties

cacheSize? idbFactory? storeName?

Properties

Optional cacheSize

cacheSize?: number

The size of the inode cache. Defaults to 100. A size of 0 or below disables caching.

-

Optional idbFactory

idbFactory?: IDBFactory

The IDBFactory to use. Defaults to globalThis.indexedDB.

-

Optional storeName

storeName?: string

The name of this file system. You can have multiple IndexedDB file systems operating at once, but each must have a different name.

-

Settings

Member Visibility

Theme

On This Page

cacheSizeidbFactorystoreName

Generated using TypeDoc

\ No newline at end of file +

Optional idbFactory

idbFactory?: IDBFactory

The IDBFactory to use. Defaults to globalThis.indexedDB.

+

Optional storeName

storeName?: string

The name of this file system. You can have multiple IndexedDB file systems operating at once, but each must have a different name.

+

Settings

Member Visibility

Theme

On This Page

cacheSizeidbFactorystoreName

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/StorageOptions.html b/interfaces/StorageOptions.html index eee5e2e..f64e2af 100644 --- a/interfaces/StorageOptions.html +++ b/interfaces/StorageOptions.html @@ -1,4 +1,4 @@ StorageOptions | ZenFS DOM

Interface StorageOptions

Options to pass to the StorageFileSystem

-
interface StorageOptions {
    storage: Storage;
}

Properties

storage +
interface StorageOptions {
    storage: Storage;
}

Properties

storage

Properties

storage

storage: Storage

The Storage to use. Defaults to globalThis.localStorage.

-

Settings

Member Visibility

Theme

On This Page

storage

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

storage

Generated using TypeDoc

\ No newline at end of file diff --git a/modules.html b/modules.html index 18ad40a..5767556 100644 --- a/modules.html +++ b/modules.html @@ -2,7 +2,8 @@ FileSystemAccessFile IndexedDBStore StorageStore -

Interfaces

IndexedDBOptions +

Interfaces

FileSystemAccessOptions +IndexedDBOptions StorageOptions

Variables

FileSystemAccess IndexedDB diff --git a/variables/FileSystemAccess.html b/variables/FileSystemAccess.html index e5f21a6..2f1eca6 100644 --- a/variables/FileSystemAccess.html +++ b/variables/FileSystemAccess.html @@ -1 +1 @@ -FileSystemAccess | ZenFS DOM

Variable FileSystemAccessConst

FileSystemAccess: Backend = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +FileSystemAccess | ZenFS DOM

Variable FileSystemAccessConst

FileSystemAccess: Backend = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/IndexedDB.html b/variables/IndexedDB.html index 1d0b73a..b09d3e1 100644 --- a/variables/IndexedDB.html +++ b/variables/IndexedDB.html @@ -1,2 +1,2 @@ IndexedDB | ZenFS DOM

Variable IndexedDBConst

IndexedDB: Backend = ...

A file system that uses the IndexedDB key value file system.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/Storage.html b/variables/Storage.html index 349776f..70be10f 100644 --- a/variables/Storage.html +++ b/variables/Storage.html @@ -1,2 +1,2 @@ Storage | ZenFS DOM

Variable StorageConst

Storage: Backend = ...

A synchronous file system backed by a Storage (e.g. localStorage).

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file