From 541ee871bfa99652f7bbdd164b7c0d07f53e2408 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" Date: Thu, 2 May 2024 23:56:59 +0000 Subject: [PATCH] deploy: 4f2c6ba498eab88d6c91bb20b3d38e2515b4390d --- classes/crud_to_cas.CrudCas.html | 4 +-- classes/fsa_to_crud.FsaCrud.html | 6 ++-- classes/fsa_to_node.FsaNodeFs.html | 16 +++++------ .../fsa_to_node.FsaNodeSyncAdapterWorker.html | 4 +-- classes/node_to_crud.NodeCrud.html | 6 ++-- ..._to_fsa.NodeFileSystemDirectoryHandle.html | 28 +++++++++---------- .../node_to_fsa.NodeFileSystemFileHandle.html | 18 ++++++------ classes/node_to_fsa.NodeFileSystemHandle.html | 12 ++++---- coverage/clover.xml | 4 +-- coverage/lcov-report/index.html | 2 +- coverage/lcov-report/src/Dirent.ts.html | 2 +- coverage/lcov-report/src/Stats.ts.html | 2 +- .../src/__tests__/hasBigInt.js.html | 2 +- coverage/lcov-report/src/__tests__/index.html | 2 +- .../lcov-report/src/__tests__/util.ts.html | 2 +- coverage/lcov-report/src/constants.ts.html | 2 +- .../src/crud-to-cas/CrudCas.ts.html | 2 +- .../src/crud-to-cas/CrudCasBase.ts.html | 2 +- .../src/crud-to-cas/__tests__/index.html | 2 +- .../crud-to-cas/__tests__/testCasfs.ts.html | 2 +- .../lcov-report/src/crud-to-cas/index.html | 2 +- .../lcov-report/src/crud-to-cas/util.ts.html | 2 +- .../lcov-report/src/crud/__tests__/index.html | 2 +- .../src/crud/__tests__/testCrudfs.ts.html | 2 +- coverage/lcov-report/src/crud/index.html | 2 +- coverage/lcov-report/src/crud/util.ts.html | 2 +- coverage/lcov-report/src/encoding.ts.html | 2 +- .../src/fsa-to-crud/FsaCrud.ts.html | 2 +- .../lcov-report/src/fsa-to-crud/index.html | 2 +- .../lcov-report/src/fsa-to-crud/index.ts.html | 2 +- .../lcov-report/src/fsa-to-crud/util.ts.html | 2 +- .../src/fsa-to-node/FsaNodeCore.ts.html | 2 +- .../src/fsa-to-node/FsaNodeDirent.ts.html | 2 +- .../src/fsa-to-node/FsaNodeFs.ts.html | 2 +- .../src/fsa-to-node/FsaNodeFsOpenFile.ts.html | 2 +- .../src/fsa-to-node/FsaNodeReadStream.ts.html | 2 +- .../src/fsa-to-node/FsaNodeStats.ts.html | 2 +- .../fsa-to-node/FsaNodeWriteStream.ts.html | 2 +- .../lcov-report/src/fsa-to-node/index.html | 2 +- .../lcov-report/src/fsa-to-node/index.ts.html | 2 +- .../lcov-report/src/fsa-to-node/json.ts.html | 2 +- .../lcov-report/src/fsa-to-node/util.ts.html | 2 +- .../worker/FsaNodeSyncAdapterWorker.ts.html | 2 +- .../fsa-to-node/worker/SyncMessenger.ts.html | 2 +- .../src/fsa-to-node/worker/index.html | 2 +- coverage/lcov-report/src/index.html | 2 +- coverage/lcov-report/src/index.ts.html | 2 +- .../lcov-report/src/internal/buffer.ts.html | 2 +- .../lcov-report/src/internal/errors.ts.html | 2 +- coverage/lcov-report/src/internal/index.html | 2 +- .../src/node-to-crud/NodeCrud.ts.html | 2 +- .../lcov-report/src/node-to-crud/index.html | 2 +- .../src/node-to-crud/index.ts.html | 2 +- .../NodeFileSystemDirectoryHandle.ts.html | 2 +- .../NodeFileSystemFileHandle.ts.html | 2 +- .../node-to-fsa/NodeFileSystemHandle.ts.html | 2 +- .../NodeFileSystemSyncAccessHandle.ts.html | 2 +- .../NodeFileSystemWritableFileStream.ts.html | 2 +- .../lcov-report/src/node-to-fsa/index.html | 2 +- .../lcov-report/src/node-to-fsa/index.ts.html | 2 +- .../lcov-report/src/node-to-fsa/util.ts.html | 2 +- coverage/lcov-report/src/node.ts.html | 2 +- .../lcov-report/src/node/FileHandle.ts.html | 2 +- .../lcov-report/src/node/FsPromises.ts.html | 2 +- .../lcov-report/src/node/constants.ts.html | 2 +- coverage/lcov-report/src/node/index.html | 2 +- .../src/node/lists/fsCallbackApiList.ts.html | 2 +- .../node/lists/fsSynchronousApiList.ts.html | 2 +- .../lcov-report/src/node/lists/index.html | 2 +- coverage/lcov-report/src/node/options.ts.html | 2 +- coverage/lcov-report/src/node/util.ts.html | 2 +- coverage/lcov-report/src/print/index.html | 2 +- coverage/lcov-report/src/print/index.ts.html | 2 +- coverage/lcov-report/src/process.ts.html | 2 +- .../lcov-report/src/queueMicrotask.ts.html | 2 +- coverage/lcov-report/src/setImmediate.ts.html | 2 +- .../lcov-report/src/setTimeoutUnref.ts.html | 2 +- .../lcov-report/src/snapshot/async.ts.html | 2 +- .../lcov-report/src/snapshot/binary.ts.html | 2 +- coverage/lcov-report/src/snapshot/index.html | 2 +- .../lcov-report/src/snapshot/json.ts.html | 2 +- .../lcov-report/src/snapshot/shared.ts.html | 2 +- .../lcov-report/src/snapshot/sync.ts.html | 2 +- .../lcov-report/src/thingies/Defer.ts.html | 2 +- .../src/thingies/concurrency.ts.html | 2 +- coverage/lcov-report/src/thingies/go.ts.html | 2 +- coverage/lcov-report/src/thingies/index.html | 2 +- .../lcov-report/src/thingies/index.ts.html | 2 +- coverage/lcov-report/src/thingies/of.ts.html | 2 +- coverage/lcov-report/src/volume.ts.html | 2 +- functions/index.createFsFromVolume.html | 2 +- functions/index.memfs.html | 2 +- functions/node_to_fsa.nodeToFsa.html | 2 +- interfaces/cas_types.CasApi.html | 4 +-- interfaces/cas_types.CasGetOptions.html | 4 +-- interfaces/crud_to_cas.CrudCasOptions.html | 4 +-- interfaces/crud_types.CrudApi.html | 18 ++++++------ .../crud_types.CrudCollectionEntry.html | 6 ++-- interfaces/crud_types.CrudPutOptions.html | 4 +-- interfaces/crud_types.CrudResourceInfo.html | 12 ++++---- .../fsa_types.CreateWritableOptions.html | 4 +-- ....FileSystemHandlePermissionDescriptor.html | 4 +-- .../fsa_types.FileSystemReadWriteOptions.html | 4 +-- ...es.FileSystemWritableFileStreamParams.html | 4 +-- .../fsa_types.GetDirectoryHandleOptions.html | 4 +-- .../fsa_types.GetFileHandleOptions.html | 4 +-- .../fsa_types.IFileSystemDirectoryHandle.html | 4 +-- .../fsa_types.IFileSystemFileHandle.html | 4 +-- interfaces/fsa_types.IFileSystemHandle.html | 4 +-- ...fsa_types.IFileSystemSyncAccessHandle.html | 4 +-- ...a_types.IFileSystemWritableFileStream.html | 4 +-- interfaces/fsa_types.IPermissionStatus.html | 4 +-- interfaces/fsa_types.RemoveEntryOptions.html | 4 +-- interfaces/index.DirectoryJSON.html | 2 +- interfaces/index.IFs.html | 6 ++-- interfaces/index.NestedDirectoryJSON.html | 2 +- interfaces/node_to_crud.NodeCrudOptions.html | 4 +-- .../node_to_fsa.CreateWritableOptions.html | 4 +-- interfaces/node_to_fsa.NodeFsaContext.html | 6 ++-- modules/cas_types.html | 2 +- modules/crud_to_cas.html | 2 +- modules/crud_types.html | 2 +- modules/fsa_to_crud.html | 2 +- modules/fsa_to_node.html | 2 +- modules/fsa_types.html | 2 +- modules/index.html | 2 +- modules/node_to_crud.html | 2 +- modules/node_to_fsa.html | 2 +- types/crud_types.CrudCollection.html | 2 +- types/fsa_types.Data.html | 2 +- types/index.IFsWithVolume.html | 2 +- types/node_to_fsa.NodeFsaFs.html | 2 +- variables/index.Volume.html | 2 +- variables/index.fs.html | 2 +- variables/index.vol.html | 2 +- 135 files changed, 213 insertions(+), 213 deletions(-) diff --git a/classes/crud_to_cas.CrudCas.html b/classes/crud_to_cas.CrudCas.html index 994a64efd..63f318694 100644 --- a/classes/crud_to_cas.CrudCas.html +++ b/classes/crud_to_cas.CrudCas.html @@ -1,4 +1,4 @@ -CrudCas | memfs

Class CrudCas

Hierarchy

  • CrudCasBase<string>
    • CrudCas

Constructors

constructor +CrudCas | memfs

Class CrudCas

Hierarchy

  • CrudCasBase<string>
    • CrudCas

Constructors

constructor

Properties

crud hash hash2Loc @@ -8,4 +8,4 @@ get info put -

Constructors

constructor

Properties

Protected Readonly crud

crud: CrudApi

Protected Readonly hash

hash: ((blob) => Promise<string>)

Type declaration

    • (blob): Promise<string>

    • Parameters

      • blob: Uint8Array

      Returns Promise<string>

Protected Readonly hash2Loc

hash2Loc: ((hash) => FsLocation)

Type declaration

    • (hash): FsLocation

    • Parameters

      • hash: string

      Returns FsLocation

Protected Readonly hashEqual

hashEqual: ((h1, h2) => boolean)

Type declaration

    • (h1, h2): boolean

    • Parameters

      • h1: string
      • h2: string

      Returns boolean

Protected Readonly options

options: CrudCasOptions

Methods

Readonly del

Readonly get

Readonly info

Readonly put

Settings

Member Visibility

Theme

On This Page

constructorcrudhashhash2LochashEqualoptionsdelgetinfoput
\ No newline at end of file +

Constructors

constructor

Properties

Protected Readonly crud

crud: CrudApi

Protected Readonly hash

hash: ((blob) => Promise<string>)

Type declaration

    • (blob): Promise<string>

    • Parameters

      • blob: Uint8Array

      Returns Promise<string>

Protected Readonly hash2Loc

hash2Loc: ((hash) => FsLocation)

Type declaration

    • (hash): FsLocation

    • Parameters

      • hash: string

      Returns FsLocation

Protected Readonly hashEqual

hashEqual: ((h1, h2) => boolean)

Type declaration

    • (h1, h2): boolean

    • Parameters

      • h1: string
      • h2: string

      Returns boolean

Protected Readonly options

options: CrudCasOptions

Methods

Readonly del

Readonly get

Readonly info

Readonly put

Settings

Member Visibility

Theme

On This Page

constructorcrudhashhash2LochashEqualoptionsdelgetinfoput
\ No newline at end of file diff --git a/classes/fsa_to_crud.FsaCrud.html b/classes/fsa_to_crud.FsaCrud.html index 4cd44b209..8ffee1568 100644 --- a/classes/fsa_to_crud.FsaCrud.html +++ b/classes/fsa_to_crud.FsaCrud.html @@ -1,4 +1,4 @@ -FsaCrud | memfs

Class FsaCrud

Implements

Constructors

constructor +FsaCrud | memfs

Class FsaCrud

Implements

Constructors

constructor

Properties

root scan

Methods

del @@ -10,6 +10,6 @@ info list put -

Constructors

constructor

Properties

Protected Readonly root

root: IFileSystemDirectoryHandle | Promise<IFileSystemDirectoryHandle>

Readonly scan

scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>) = ...

Iterates over all resources of a collection.

+

Constructors

constructor

Properties

Protected Readonly root

root: IFileSystemDirectoryHandle | Promise<IFileSystemDirectoryHandle>

Readonly scan

scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>) = ...

Iterates over all resources of a collection.

Type declaration

Returns

Iterator of resources of the given type.

-

Methods

Readonly del

Readonly drop

Readonly from

Readonly get

Protected getDir

Protected getFile

Readonly info

Readonly list

Readonly put

Settings

Member Visibility

Theme

On This Page

constructorrootscandeldropfromgetgetDirgetFileinfolistput
\ No newline at end of file +

Methods

Readonly del

Readonly drop

Readonly from

Readonly get

Protected getDir

Protected getFile

Readonly info

Readonly list

Readonly put

Settings

Member Visibility

Theme

On This Page

constructorrootscandeldropfromgetgetDirgetFileinfolistput
\ No newline at end of file diff --git a/classes/fsa_to_node.FsaNodeFs.html b/classes/fsa_to_node.FsaNodeFs.html index cc5e54447..d015d7800 100644 --- a/classes/fsa_to_node.FsaNodeFs.html +++ b/classes/fsa_to_node.FsaNodeFs.html @@ -1,6 +1,6 @@ FsaNodeFs | memfs

Class FsaNodeFs

Constructs a Node.js fs API from a File System Access API FileSystemDirectoryHandle object.

-

Hierarchy

  • FsaNodeCore
    • FsaNodeFs

Implements

  • FsCallbackApi
  • FsSynchronousApi
  • FsCommonObjects

Constructors

constructor +

Hierarchy

  • FsaNodeCore
    • FsaNodeFs

Implements

  • FsCallbackApi
  • FsSynchronousApi
  • FsCommonObjects

Constructors

constructor

Properties

Dir Dirent FSWatcher @@ -125,16 +125,16 @@ getSyncAdapter newFdNumber rmAll -

Constructors

constructor

Properties

Readonly Dir

Dir: any = ...

Readonly Dirent

Dirent: typeof FsaNodeDirent = FsaNodeDirent

Readonly FSWatcher

FSWatcher: any = ...

Readonly F_OK

F_OK: number = constants.F_OK

Readonly R_OK

R_OK: number = constants.R_OK

Readonly ReadStream

ReadStream: typeof FsaNodeReadStream = FsaNodeReadStream

Readonly StatFs

StatFs: any = ...

Readonly Stats

Stats: {
    prototype: FsaNodeStats<any>;
    new (isBigInt, size, kind): FsaNodeStats<any>;
} = ...

Type declaration

    • new (isBigInt, size, kind): FsaNodeStats<any>

    • Parameters

      • isBigInt: boolean
      • size: any
      • kind: "file" | "directory"

      Returns FsaNodeStats<any>

  • prototype: FsaNodeStats<any>

Readonly StatsWatcher

StatsWatcher: any = ...

Readonly W_OK

W_OK: number = constants.W_OK

Readonly WriteStream

WriteStream: typeof FsaNodeWriteStream = FsaNodeWriteStream

Readonly X_OK

X_OK: number = constants.X_OK

Readonly access

access: {
    (path, callback): any;
    (path, mode, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: number
      • callback: TCallback<void>

      Returns any

Readonly accessSync

accessSync: ((path, mode?) => void) = ...

Type declaration

    • (path, mode?): void

    • Parameters

      • path: PathLike
      • Optional mode: number

      Returns void

Readonly appendFile

appendFile: {
    (id, data, callback): any;
    (id, data, options, callback): any;
} = ...

Type declaration

    • (id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • (id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IAppendFileOptions
      • callback: TCallback<void>

      Returns any

Readonly appendFileSync

appendFileSync: ((id, data, options?) => void) = ...

Type declaration

    • (id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: string | IAppendFileOptions

      Returns void

Readonly chmod

chmod: ((path, mode, callback) => void) = ...

Type declaration

    • (path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

Readonly chmodSync

chmodSync: ((path, mode) => void) = noop

Type declaration

    • (path, mode): void

    • Parameters

      • path: PathLike
      • mode: TMode

      Returns void

Readonly chown

chown: ((path, uid, gid, callback) => void) = ...

Type declaration

    • (path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

Readonly chownSync

chownSync: ((path, uid, gid) => void) = noop

Type declaration

    • (path, uid, gid): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number

      Returns void

Readonly close

close: ((fd, callback) => void) = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns void

Readonly closeSync

closeSync: ((fd) => void) = ...

Type declaration

    • (fd): void

    • Parameters

      • fd: number

      Returns void

Readonly constants

constants: {
    COPYFILE_EXCL: number;
    COPYFILE_FICLONE: number;
    COPYFILE_FICLONE_FORCE: number;
    F_OK: number;
    O_APPEND: number;
    O_CREAT: number;
    O_DIRECT: number;
    O_DIRECTORY: number;
    O_EXCL: number;
    O_NOATIME: number;
    O_NOCTTY: number;
    O_NOFOLLOW: number;
    O_NONBLOCK: number;
    O_RDONLY: number;
    O_RDWR: number;
    O_SYMLINK: number;
    O_SYNC: number;
    O_TRUNC: number;
    O_WRONLY: number;
    R_OK: number;
    S_IFBLK: number;
    S_IFCHR: number;
    S_IFDIR: number;
    S_IFIFO: number;
    S_IFLNK: number;
    S_IFMT: number;
    S_IFREG: number;
    S_IFSOCK: number;
    S_IRGRP: number;
    S_IROTH: number;
    S_IRUSR: number;
    S_IRWXG: number;
    S_IRWXO: number;
    S_IRWXU: number;
    S_IWGRP: number;
    S_IWOTH: number;
    S_IWUSR: number;
    S_IXGRP: number;
    S_IXOTH: number;
    S_IXUSR: number;
    UV_FS_COPYFILE_EXCL: number;
    UV_FS_COPYFILE_FICLONE: number;
    UV_FS_COPYFILE_FICLONE_FORCE: number;
    UV_FS_SYMLINK_DIR: number;
    UV_FS_SYMLINK_JUNCTION: number;
    W_OK: number;
    X_OK: number;
} = constants

Type declaration

  • COPYFILE_EXCL: number
  • COPYFILE_FICLONE: number
  • COPYFILE_FICLONE_FORCE: number
  • F_OK: number
  • O_APPEND: number
  • O_CREAT: number
  • O_DIRECT: number
  • O_DIRECTORY: number
  • O_EXCL: number
  • O_NOATIME: number
  • O_NOCTTY: number
  • O_NOFOLLOW: number
  • O_NONBLOCK: number
  • O_RDONLY: number
  • O_RDWR: number
  • O_SYMLINK: number
  • O_SYNC: number
  • O_TRUNC: number
  • O_WRONLY: number
  • R_OK: number
  • S_IFBLK: number
  • S_IFCHR: number
  • S_IFDIR: number
  • S_IFIFO: number
  • S_IFLNK: number
  • S_IFMT: number
  • S_IFREG: number
  • S_IFSOCK: number
  • S_IRGRP: number
  • S_IROTH: number
  • S_IRUSR: number
  • S_IRWXG: number
  • S_IRWXO: number
  • S_IRWXU: number
  • S_IWGRP: number
  • S_IWOTH: number
  • S_IWUSR: number
  • S_IXGRP: number
  • S_IXOTH: number
  • S_IXUSR: number
  • UV_FS_COPYFILE_EXCL: number
  • UV_FS_COPYFILE_FICLONE: number
  • UV_FS_COPYFILE_FICLONE_FORCE: number
  • UV_FS_SYMLINK_DIR: number
  • UV_FS_SYMLINK_JUNCTION: number
  • W_OK: number
  • X_OK: number

Readonly copyFile

copyFile: {
    (src, dest, callback): any;
    (src, dest, flags, callback): any;
} = ...

Type declaration

    • (src, dest, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • callback: TCallback<void>

      Returns any

    • (src, dest, flags, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • flags: number
      • callback: TCallback<void>

      Returns any

Readonly copyFileSync

copyFileSync: ((src, dest, flags?) => void) = ...

Type declaration

    • (src, dest, flags?): void

    • Parameters

      • src: PathLike
      • dest: PathLike
      • Optional flags: number

      Returns void

Readonly cp

cp: {
    (src, dest, callback): any;
    (src, dest, options, callback): any;
} = notImplemented

Type declaration

    • (src, dest, callback): any

    • Parameters

      • src: string | URL
      • dest: string | URL
      • callback: TCallback<void>

      Returns any

    • (src, dest, options, callback): any

    • Parameters

      • src: string | URL
      • dest: string | URL
      • options: ICpOptions
      • callback: TCallback<void>

      Returns any

Readonly cpSync

cpSync: ((src, dest, options?) => void) = notImplemented

Type declaration

    • (src, dest, options?): void

    • Parameters

      • src: string | URL
      • dest: string | URL
      • Optional options: ICpOptions

      Returns void

Readonly createReadStream

createReadStream: ((path, options?) => IReadStream) = ...

Type declaration

    • (path, options?): IReadStream

    • Parameters

      • path: PathLike
      • Optional options: string | IReadStreamOptions

      Returns IReadStream

Readonly createWriteStream

createWriteStream: ((path, options?) => IWriteStream) = ...

Type declaration

    • (path, options?): IWriteStream

    • Parameters

      • path: PathLike
      • Optional options: string | IWriteStreamOptions

      Returns IWriteStream

Readonly exists

exists: ((path, callback) => void) = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: ((exists) => void)
          • (exists): void

          • Parameters

            • exists: boolean

            Returns void

      Returns void

Readonly existsSync

existsSync: ((path) => boolean) = ...

Type declaration

    • (path): boolean

    • Parameters

      • path: PathLike

      Returns boolean

Readonly fchmod

fchmod: ((fd, mode, callback) => void) = ...

Type declaration

    • (fd, mode, callback): void

    • Parameters

      • fd: number
      • mode: TMode
      • callback: TCallback<void>

      Returns void

Readonly fchmodSync

fchmodSync: ((fd, mode) => void) = noop

Type declaration

    • (fd, mode): void

    • Parameters

      • fd: number
      • mode: TMode

      Returns void

Readonly fchown

fchown: ((fd, uid, gid, callback) => void) = ...

Type declaration

    • (fd, uid, gid, callback): void

    • Parameters

      • fd: number
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

Readonly fchownSync

fchownSync: ((fd, uid, gid) => void) = noop

Type declaration

    • (fd, uid, gid): void

    • Parameters

      • fd: number
      • uid: number
      • gid: number

      Returns void

Readonly fdatasync

fdatasync: ((fd, callback) => void) = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns void

Readonly fdatasyncSync

fdatasyncSync: ((fd) => void) = noop

Type declaration

    • (fd): void

    • Parameters

      • fd: number

      Returns void

Protected Readonly fds

fds: Map<number, FsaNodeFsOpenFile> = ...

Readonly fstat

fstat: {
    (fd, callback): void;
    (fd, options, callback): void;
} = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

    • (fd, options, callback): void

    • Parameters

      • fd: number
      • options: IFStatOptions
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

Readonly fstatSync

fstatSync: {
    (fd, options): IStats<number>;
    (fd, options): IStats<bigint>;
    (fd): IStats<number>;
} = ...

Type declaration

    • (fd, options): IStats<number>

    • Parameters

      • fd: number
      • options: {
            bigint: false;
        }
        • bigint: false

      Returns IStats<number>

    • (fd, options): IStats<bigint>

    • Parameters

      • fd: number
      • options: {
            bigint: true;
        }
        • bigint: true

      Returns IStats<bigint>

    • (fd): IStats<number>

    • Parameters

      • fd: number

      Returns IStats<number>

Readonly fsync

fsync: ((fd, callback) => void) = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns void

Todo

Could this use FileSystemSyncAccessHandle.flush through a Worker thread?

-

Readonly fsyncSync

fsyncSync: ((fd) => void) = noop

Type declaration

    • (fd): void

    • Parameters

      • fd: number

      Returns void

Readonly ftruncate

ftruncate: {
    (fd, callback): any;
    (fd, len, callback): any;
} = ...

Type declaration

    • (fd, callback): any

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns any

    • (fd, len, callback): any

    • Parameters

      • fd: number
      • len: number
      • callback: TCallback<void>

      Returns any

Readonly ftruncateSync

ftruncateSync: ((fd, len?) => void) = ...

Type declaration

    • (fd, len?): void

    • Parameters

      • fd: number
      • Optional len: number

      Returns void

Readonly futimes

futimes: ((fd, atime, mtime, callback) => void) = ...

Type declaration

    • (fd, atime, mtime, callback): void

    • Parameters

      • fd: number
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

Readonly futimesSync

futimesSync: ((fd, atime, mtime) => void) = noop

Type declaration

    • (fd, atime, mtime): void

    • Parameters

      • fd: number
      • atime: TTime
      • mtime: TTime

      Returns void

Readonly lchmod

lchmod: ((path, mode, callback) => void) = ...

Type declaration

    • (path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

Readonly lchmodSync

lchmodSync: ((path, mode) => void) = noop

Type declaration

    • (path, mode): void

    • Parameters

      • path: PathLike
      • mode: TMode

      Returns void

Readonly lchown

lchown: ((path, uid, gid, callback) => void) = ...

Type declaration

    • (path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

Readonly lchownSync

lchownSync: ((path, uid, gid) => void) = noop

Type declaration

    • (path, uid, gid): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number

      Returns void

Readonly link

link: ((existingPath, newPath, callback) => void) = notSupported

Type declaration

    • (existingPath, newPath, callback): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

Readonly linkSync

linkSync: ((existingPath, newPath) => void) = notSupported

Type declaration

    • (existingPath, newPath): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike

      Returns void

Readonly lstat

lstat: {
    (path, callback): void;
    (path, options, callback): void;
} = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

Readonly lstatSync

lstatSync: {
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path, options): undefined | IStats<bigint>;
    (path, options): IStats<bigint>;
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path): IStats<number>;
} = ...

Type declaration

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path, options): undefined | IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | IStats<bigint>

    • (path, options): IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns IStats<bigint>

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path): IStats<number>

    • Parameters

      • path: PathLike

      Returns IStats<number>

Readonly lutimes

lutimes: ((path, atime, mtime, callback) => void) = notImplemented

Type declaration

    • (path, atime, mtime, callback): void

    • Parameters

      • path: PathLike
      • atime: string | number | Date
      • mtime: string | number | Date
      • callback: TCallback<void>

      Returns void

Readonly lutimesSync

lutimesSync: ((path, atime, time) => void) = noop

Type declaration

    • (path, atime, time): void

    • Parameters

      • path: PathLike
      • atime: string | number | Date
      • time: string | number | Date

      Returns void

Readonly mkdir

mkdir: {
    (path, callback): any;
    (path, mode, callback): any;
    (path, mode, callback): any;
    (path, mode, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: TMode | IMkdirOptions & {
            recursive?: false;
        }
      • callback: TCallback<void>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: IMkdirOptions & {
            recursive: true;
        }
      • callback: TCallback<string>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: TMode | IMkdirOptions
      • callback: TCallback<string>

      Returns any

Readonly mkdirSync

mkdirSync: {
    (path, options): undefined | string;
    (path, options?): void;
    (path, options?): undefined | string;
} = ...

Type declaration

    • (path, options): undefined | string

    • Parameters

      • path: PathLike
      • options: IMkdirOptions & {
            recursive: true;
        }

      Returns undefined | string

    • (path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: TMode | IMkdirOptions & {
            recursive?: false;
        }

      Returns void

    • (path, options?): undefined | string

    • Parameters

      • path: PathLike
      • Optional options: TMode | IMkdirOptions

      Returns undefined | string

Readonly mkdtemp

mkdtemp: {
    (prefix, callback): void;
    (prefix, options, callback): any;
} = ...

Type declaration

    • (prefix, callback): void

    • Parameters

      • prefix: string
      • callback: TCallback<string>

      Returns void

    • (prefix, options, callback): any

    • Parameters

      • prefix: string
      • options: IOptions
      • callback: TCallback<string>

      Returns any

Readonly mkdtempSync

mkdtempSync: ((prefix, options?) => TDataOut) = ...

Type declaration

    • (prefix, options?): TDataOut

    • Parameters

      • prefix: string
      • Optional options: IOptions

      Returns TDataOut

Readonly open

open: {
    (path, flags, callback): any;
    (path, flags, mode, callback): any;
} = ...

Type declaration

    • (path, flags, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • callback: TCallback<number>

      Returns any

    • (path, flags, mode, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • mode: TMode
      • callback: TCallback<number>

      Returns any

Readonly openAsBlob

openAsBlob: ((path, options?) => Promise<Blob>) = notImplemented

Type declaration

    • (path, options?): Promise<Blob>

    • Parameters

      • path: PathLike
      • Optional options: IOpenAsBlobOptions

      Returns Promise<Blob>

Readonly openSync

openSync: ((path, flags, mode?) => number) = ...

Type declaration

    • (path, flags, mode?): number

    • Parameters

      • path: PathLike
      • flags: TFlags
      • Optional mode: TMode

      Returns number

Readonly opendir

opendir: ((path, options, callback) => void) = notImplemented

Type declaration

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IOpendirOptions
      • callback: TCallback<IDir>

      Returns void

Readonly opendirSync

opendirSync: ((path, options?) => IDir) = notImplemented

Type declaration

    • (path, options?): IDir

    • Parameters

      • path: PathLike
      • Optional options: IOpendirOptions

      Returns IDir

Readonly promises

promises: FsPromisesApi = ...

Readonly read

read: ((fd, buffer, offset, length, position, callback) => void) = ...

Type declaration

    • (fd, buffer, offset, length, position, callback): void

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number
      • callback: ((err?, bytesRead?, buffer?) => void)
          • (err?, bytesRead?, buffer?): void

          • Parameters

            • Optional err: null | Error
            • Optional bytesRead: number
            • Optional buffer: Buffer | ArrayBufferView | DataView

            Returns void

      Returns void

Readonly readFile

readFile: {
    (id, callback): any;
    (id, options, callback): any;
} = ...

Type declaration

    • (id, callback): any

    • Parameters

      • id: TFileId
      • callback: TCallback<TDataOut>

      Returns any

    • (id, options, callback): any

    • Parameters

      • id: TFileId
      • options: string | IReadFileOptions
      • callback: TCallback<TDataOut>

      Returns any

Readonly readFileSync

readFileSync: ((file, options?) => TDataOut) = ...

Type declaration

    • (file, options?): TDataOut

    • Parameters

      • file: TFileId
      • Optional options: string | IReadFileOptions

      Returns TDataOut

Readonly readSync

readSync: ((fd, buffer, offset, length, position) => number) = ...

Type declaration

    • (fd, buffer, offset, length, position): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number

      Returns number

Readonly readdir

readdir: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut[] | IDirent[]>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IReaddirOptions
      • callback: TCallback<TDataOut[] | IDirent[]>

      Returns any

Readonly readdirSync

readdirSync: ((path, options?) => TDataOut[] | IDirent[]) = ...

Type declaration

    • (path, options?): TDataOut[] | IDirent[]

    • Parameters

      • path: PathLike
      • Optional options: string | IReaddirOptions

      Returns TDataOut[] | IDirent[]

Readonly readlink

readlink: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IOptions
      • callback: TCallback<TDataOut>

      Returns any

Readonly readlinkSync

readlinkSync: ((path, options?) => TDataOut) = ...

Type declaration

    • (path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: IOptions

      Returns TDataOut

Readonly readv

readv: {
    (fd, buffers, callback): void;
    (fd, buffers, position, callback): void;
} = notImplemented

Type declaration

    • (fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

    • (fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

Readonly readvSync

readvSync: ((fd, buffers, position?) => number) = notImplemented

Type declaration

    • (fd, buffers, position?): number

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • Optional position: null | number

      Returns number

Readonly realpath

realpath: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IRealpathOptions
      • callback: TCallback<TDataOut>

      Returns any

Readonly realpathSync

realpathSync: ((path, options?) => TDataOut) = ...

Type declaration

    • (path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: string | IRealpathOptions

      Returns TDataOut

releasedFds

releasedFds: number[] = []

A list of reusable (opened and closed) file descriptors, that should be +

Constructors

constructor

Properties

Readonly Dir

Dir: any = ...

Readonly Dirent

Dirent: typeof FsaNodeDirent = FsaNodeDirent

Readonly FSWatcher

FSWatcher: any = ...

Readonly F_OK

F_OK: number = constants.F_OK

Readonly R_OK

R_OK: number = constants.R_OK

Readonly ReadStream

ReadStream: typeof FsaNodeReadStream = FsaNodeReadStream

Readonly StatFs

StatFs: any = ...

Readonly Stats

Stats: {
    prototype: FsaNodeStats<any>;
    new (isBigInt, size, kind): FsaNodeStats<any>;
} = ...

Type declaration

    • new (isBigInt, size, kind): FsaNodeStats<any>

    • Parameters

      • isBigInt: boolean
      • size: any
      • kind: "file" | "directory"

      Returns FsaNodeStats<any>

  • prototype: FsaNodeStats<any>

Readonly StatsWatcher

StatsWatcher: any = ...

Readonly W_OK

W_OK: number = constants.W_OK

Readonly WriteStream

WriteStream: typeof FsaNodeWriteStream = FsaNodeWriteStream

Readonly X_OK

X_OK: number = constants.X_OK

Readonly access

access: {
    (path, callback): any;
    (path, mode, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: number
      • callback: TCallback<void>

      Returns any

Readonly accessSync

accessSync: ((path, mode?) => void) = ...

Type declaration

    • (path, mode?): void

    • Parameters

      • path: PathLike
      • Optional mode: number

      Returns void

Readonly appendFile

appendFile: {
    (id, data, callback): any;
    (id, data, options, callback): any;
} = ...

Type declaration

    • (id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • (id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IAppendFileOptions
      • callback: TCallback<void>

      Returns any

Readonly appendFileSync

appendFileSync: ((id, data, options?) => void) = ...

Type declaration

    • (id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: string | IAppendFileOptions

      Returns void

Readonly chmod

chmod: ((path, mode, callback) => void) = ...

Type declaration

    • (path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

Readonly chmodSync

chmodSync: ((path, mode) => void) = noop

Type declaration

    • (path, mode): void

    • Parameters

      • path: PathLike
      • mode: TMode

      Returns void

Readonly chown

chown: ((path, uid, gid, callback) => void) = ...

Type declaration

    • (path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

Readonly chownSync

chownSync: ((path, uid, gid) => void) = noop

Type declaration

    • (path, uid, gid): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number

      Returns void

Readonly close

close: ((fd, callback) => void) = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns void

Readonly closeSync

closeSync: ((fd) => void) = ...

Type declaration

    • (fd): void

    • Parameters

      • fd: number

      Returns void

Readonly constants

constants: {
    COPYFILE_EXCL: number;
    COPYFILE_FICLONE: number;
    COPYFILE_FICLONE_FORCE: number;
    F_OK: number;
    O_APPEND: number;
    O_CREAT: number;
    O_DIRECT: number;
    O_DIRECTORY: number;
    O_EXCL: number;
    O_NOATIME: number;
    O_NOCTTY: number;
    O_NOFOLLOW: number;
    O_NONBLOCK: number;
    O_RDONLY: number;
    O_RDWR: number;
    O_SYMLINK: number;
    O_SYNC: number;
    O_TRUNC: number;
    O_WRONLY: number;
    R_OK: number;
    S_IFBLK: number;
    S_IFCHR: number;
    S_IFDIR: number;
    S_IFIFO: number;
    S_IFLNK: number;
    S_IFMT: number;
    S_IFREG: number;
    S_IFSOCK: number;
    S_IRGRP: number;
    S_IROTH: number;
    S_IRUSR: number;
    S_IRWXG: number;
    S_IRWXO: number;
    S_IRWXU: number;
    S_IWGRP: number;
    S_IWOTH: number;
    S_IWUSR: number;
    S_IXGRP: number;
    S_IXOTH: number;
    S_IXUSR: number;
    UV_FS_COPYFILE_EXCL: number;
    UV_FS_COPYFILE_FICLONE: number;
    UV_FS_COPYFILE_FICLONE_FORCE: number;
    UV_FS_SYMLINK_DIR: number;
    UV_FS_SYMLINK_JUNCTION: number;
    W_OK: number;
    X_OK: number;
} = constants

Type declaration

  • COPYFILE_EXCL: number
  • COPYFILE_FICLONE: number
  • COPYFILE_FICLONE_FORCE: number
  • F_OK: number
  • O_APPEND: number
  • O_CREAT: number
  • O_DIRECT: number
  • O_DIRECTORY: number
  • O_EXCL: number
  • O_NOATIME: number
  • O_NOCTTY: number
  • O_NOFOLLOW: number
  • O_NONBLOCK: number
  • O_RDONLY: number
  • O_RDWR: number
  • O_SYMLINK: number
  • O_SYNC: number
  • O_TRUNC: number
  • O_WRONLY: number
  • R_OK: number
  • S_IFBLK: number
  • S_IFCHR: number
  • S_IFDIR: number
  • S_IFIFO: number
  • S_IFLNK: number
  • S_IFMT: number
  • S_IFREG: number
  • S_IFSOCK: number
  • S_IRGRP: number
  • S_IROTH: number
  • S_IRUSR: number
  • S_IRWXG: number
  • S_IRWXO: number
  • S_IRWXU: number
  • S_IWGRP: number
  • S_IWOTH: number
  • S_IWUSR: number
  • S_IXGRP: number
  • S_IXOTH: number
  • S_IXUSR: number
  • UV_FS_COPYFILE_EXCL: number
  • UV_FS_COPYFILE_FICLONE: number
  • UV_FS_COPYFILE_FICLONE_FORCE: number
  • UV_FS_SYMLINK_DIR: number
  • UV_FS_SYMLINK_JUNCTION: number
  • W_OK: number
  • X_OK: number

Readonly copyFile

copyFile: {
    (src, dest, callback): any;
    (src, dest, flags, callback): any;
} = ...

Type declaration

    • (src, dest, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • callback: TCallback<void>

      Returns any

    • (src, dest, flags, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • flags: number
      • callback: TCallback<void>

      Returns any

Readonly copyFileSync

copyFileSync: ((src, dest, flags?) => void) = ...

Type declaration

    • (src, dest, flags?): void

    • Parameters

      • src: PathLike
      • dest: PathLike
      • Optional flags: number

      Returns void

Readonly cp

cp: {
    (src, dest, callback): any;
    (src, dest, options, callback): any;
} = notImplemented

Type declaration

    • (src, dest, callback): any

    • Parameters

      • src: string | URL
      • dest: string | URL
      • callback: TCallback<void>

      Returns any

    • (src, dest, options, callback): any

    • Parameters

      • src: string | URL
      • dest: string | URL
      • options: ICpOptions
      • callback: TCallback<void>

      Returns any

Readonly cpSync

cpSync: ((src, dest, options?) => void) = notImplemented

Type declaration

    • (src, dest, options?): void

    • Parameters

      • src: string | URL
      • dest: string | URL
      • Optional options: ICpOptions

      Returns void

Readonly createReadStream

createReadStream: ((path, options?) => IReadStream) = ...

Type declaration

    • (path, options?): IReadStream

    • Parameters

      • path: PathLike
      • Optional options: string | IReadStreamOptions

      Returns IReadStream

Readonly createWriteStream

createWriteStream: ((path, options?) => IWriteStream) = ...

Type declaration

    • (path, options?): IWriteStream

    • Parameters

      • path: PathLike
      • Optional options: string | IWriteStreamOptions

      Returns IWriteStream

Readonly exists

exists: ((path, callback) => void) = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: ((exists) => void)
          • (exists): void

          • Parameters

            • exists: boolean

            Returns void

      Returns void

Readonly existsSync

existsSync: ((path) => boolean) = ...

Type declaration

    • (path): boolean

    • Parameters

      • path: PathLike

      Returns boolean

Readonly fchmod

fchmod: ((fd, mode, callback) => void) = ...

Type declaration

    • (fd, mode, callback): void

    • Parameters

      • fd: number
      • mode: TMode
      • callback: TCallback<void>

      Returns void

Readonly fchmodSync

fchmodSync: ((fd, mode) => void) = noop

Type declaration

    • (fd, mode): void

    • Parameters

      • fd: number
      • mode: TMode

      Returns void

Readonly fchown

fchown: ((fd, uid, gid, callback) => void) = ...

Type declaration

    • (fd, uid, gid, callback): void

    • Parameters

      • fd: number
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

Readonly fchownSync

fchownSync: ((fd, uid, gid) => void) = noop

Type declaration

    • (fd, uid, gid): void

    • Parameters

      • fd: number
      • uid: number
      • gid: number

      Returns void

Readonly fdatasync

fdatasync: ((fd, callback) => void) = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns void

Readonly fdatasyncSync

fdatasyncSync: ((fd) => void) = noop

Type declaration

    • (fd): void

    • Parameters

      • fd: number

      Returns void

Protected Readonly fds

fds: Map<number, FsaNodeFsOpenFile> = ...

Readonly fstat

fstat: {
    (fd, callback): void;
    (fd, options, callback): void;
} = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

    • (fd, options, callback): void

    • Parameters

      • fd: number
      • options: IFStatOptions
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

Readonly fstatSync

fstatSync: {
    (fd, options): IStats<number>;
    (fd, options): IStats<bigint>;
    (fd): IStats<number>;
} = ...

Type declaration

    • (fd, options): IStats<number>

    • Parameters

      • fd: number
      • options: {
            bigint: false;
        }
        • bigint: false

      Returns IStats<number>

    • (fd, options): IStats<bigint>

    • Parameters

      • fd: number
      • options: {
            bigint: true;
        }
        • bigint: true

      Returns IStats<bigint>

    • (fd): IStats<number>

    • Parameters

      • fd: number

      Returns IStats<number>

Readonly fsync

fsync: ((fd, callback) => void) = ...

Type declaration

    • (fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns void

Todo

Could this use FileSystemSyncAccessHandle.flush through a Worker thread?

+

Readonly fsyncSync

fsyncSync: ((fd) => void) = noop

Type declaration

    • (fd): void

    • Parameters

      • fd: number

      Returns void

Readonly ftruncate

ftruncate: {
    (fd, callback): any;
    (fd, len, callback): any;
} = ...

Type declaration

    • (fd, callback): any

    • Parameters

      • fd: number
      • callback: TCallback<void>

      Returns any

    • (fd, len, callback): any

    • Parameters

      • fd: number
      • len: number
      • callback: TCallback<void>

      Returns any

Readonly ftruncateSync

ftruncateSync: ((fd, len?) => void) = ...

Type declaration

    • (fd, len?): void

    • Parameters

      • fd: number
      • Optional len: number

      Returns void

Readonly futimes

futimes: ((fd, atime, mtime, callback) => void) = ...

Type declaration

    • (fd, atime, mtime, callback): void

    • Parameters

      • fd: number
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

Readonly futimesSync

futimesSync: ((fd, atime, mtime) => void) = noop

Type declaration

    • (fd, atime, mtime): void

    • Parameters

      • fd: number
      • atime: TTime
      • mtime: TTime

      Returns void

Readonly lchmod

lchmod: ((path, mode, callback) => void) = ...

Type declaration

    • (path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

Readonly lchmodSync

lchmodSync: ((path, mode) => void) = noop

Type declaration

    • (path, mode): void

    • Parameters

      • path: PathLike
      • mode: TMode

      Returns void

Readonly lchown

lchown: ((path, uid, gid, callback) => void) = ...

Type declaration

    • (path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

Readonly lchownSync

lchownSync: ((path, uid, gid) => void) = noop

Type declaration

    • (path, uid, gid): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number

      Returns void

Readonly link

link: ((existingPath, newPath, callback) => void) = notSupported

Type declaration

    • (existingPath, newPath, callback): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

Readonly linkSync

linkSync: ((existingPath, newPath) => void) = notSupported

Type declaration

    • (existingPath, newPath): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike

      Returns void

Readonly lstat

lstat: {
    (path, callback): void;
    (path, options, callback): void;
} = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

Readonly lstatSync

lstatSync: {
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path, options): undefined | IStats<bigint>;
    (path, options): IStats<bigint>;
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path): IStats<number>;
} = ...

Type declaration

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path, options): undefined | IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | IStats<bigint>

    • (path, options): IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns IStats<bigint>

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path): IStats<number>

    • Parameters

      • path: PathLike

      Returns IStats<number>

Readonly lutimes

lutimes: ((path, atime, mtime, callback) => void) = notImplemented

Type declaration

    • (path, atime, mtime, callback): void

    • Parameters

      • path: PathLike
      • atime: string | number | Date
      • mtime: string | number | Date
      • callback: TCallback<void>

      Returns void

Readonly lutimesSync

lutimesSync: ((path, atime, time) => void) = noop

Type declaration

    • (path, atime, time): void

    • Parameters

      • path: PathLike
      • atime: string | number | Date
      • time: string | number | Date

      Returns void

Readonly mkdir

mkdir: {
    (path, callback): any;
    (path, mode, callback): any;
    (path, mode, callback): any;
    (path, mode, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: TMode | IMkdirOptions & {
            recursive?: false;
        }
      • callback: TCallback<void>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: IMkdirOptions & {
            recursive: true;
        }
      • callback: TCallback<string>

      Returns any

    • (path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: TMode | IMkdirOptions
      • callback: TCallback<string>

      Returns any

Readonly mkdirSync

mkdirSync: {
    (path, options): undefined | string;
    (path, options?): void;
    (path, options?): undefined | string;
} = ...

Type declaration

    • (path, options): undefined | string

    • Parameters

      • path: PathLike
      • options: IMkdirOptions & {
            recursive: true;
        }

      Returns undefined | string

    • (path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: TMode | IMkdirOptions & {
            recursive?: false;
        }

      Returns void

    • (path, options?): undefined | string

    • Parameters

      • path: PathLike
      • Optional options: TMode | IMkdirOptions

      Returns undefined | string

Readonly mkdtemp

mkdtemp: {
    (prefix, callback): void;
    (prefix, options, callback): any;
} = ...

Type declaration

    • (prefix, callback): void

    • Parameters

      • prefix: string
      • callback: TCallback<string>

      Returns void

    • (prefix, options, callback): any

    • Parameters

      • prefix: string
      • options: IOptions
      • callback: TCallback<string>

      Returns any

Readonly mkdtempSync

mkdtempSync: ((prefix, options?) => TDataOut) = ...

Type declaration

    • (prefix, options?): TDataOut

    • Parameters

      • prefix: string
      • Optional options: IOptions

      Returns TDataOut

Readonly open

open: {
    (path, flags, callback): any;
    (path, flags, mode, callback): any;
} = ...

Type declaration

    • (path, flags, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • callback: TCallback<number>

      Returns any

    • (path, flags, mode, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • mode: TMode
      • callback: TCallback<number>

      Returns any

Readonly openAsBlob

openAsBlob: ((path, options?) => Promise<Blob>) = notImplemented

Type declaration

    • (path, options?): Promise<Blob>

    • Parameters

      • path: PathLike
      • Optional options: IOpenAsBlobOptions

      Returns Promise<Blob>

Readonly openSync

openSync: ((path, flags, mode?) => number) = ...

Type declaration

    • (path, flags, mode?): number

    • Parameters

      • path: PathLike
      • flags: TFlags
      • Optional mode: TMode

      Returns number

Readonly opendir

opendir: ((path, options, callback) => void) = notImplemented

Type declaration

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IOpendirOptions
      • callback: TCallback<IDir>

      Returns void

Readonly opendirSync

opendirSync: ((path, options?) => IDir) = notImplemented

Type declaration

    • (path, options?): IDir

    • Parameters

      • path: PathLike
      • Optional options: IOpendirOptions

      Returns IDir

Readonly promises

promises: FsPromisesApi = ...

Readonly read

read: ((fd, buffer, offset, length, position, callback) => void) = ...

Type declaration

    • (fd, buffer, offset, length, position, callback): void

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number
      • callback: ((err?, bytesRead?, buffer?) => void)
          • (err?, bytesRead?, buffer?): void

          • Parameters

            • Optional err: null | Error
            • Optional bytesRead: number
            • Optional buffer: Buffer | ArrayBufferView | DataView

            Returns void

      Returns void

Readonly readFile

readFile: {
    (id, callback): any;
    (id, options, callback): any;
} = ...

Type declaration

    • (id, callback): any

    • Parameters

      • id: TFileId
      • callback: TCallback<TDataOut>

      Returns any

    • (id, options, callback): any

    • Parameters

      • id: TFileId
      • options: string | IReadFileOptions
      • callback: TCallback<TDataOut>

      Returns any

Readonly readFileSync

readFileSync: ((file, options?) => TDataOut) = ...

Type declaration

    • (file, options?): TDataOut

    • Parameters

      • file: TFileId
      • Optional options: string | IReadFileOptions

      Returns TDataOut

Readonly readSync

readSync: ((fd, buffer, offset, length, position) => number) = ...

Type declaration

    • (fd, buffer, offset, length, position): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number

      Returns number

Readonly readdir

readdir: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut[] | IDirent[]>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IReaddirOptions
      • callback: TCallback<TDataOut[] | IDirent[]>

      Returns any

Readonly readdirSync

readdirSync: ((path, options?) => TDataOut[] | IDirent[]) = ...

Type declaration

    • (path, options?): TDataOut[] | IDirent[]

    • Parameters

      • path: PathLike
      • Optional options: string | IReaddirOptions

      Returns TDataOut[] | IDirent[]

Readonly readlink

readlink: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IOptions
      • callback: TCallback<TDataOut>

      Returns any

Readonly readlinkSync

readlinkSync: ((path, options?) => TDataOut) = ...

Type declaration

    • (path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: IOptions

      Returns TDataOut

Readonly readv

readv: {
    (fd, buffers, callback): void;
    (fd, buffers, position, callback): void;
} = notImplemented

Type declaration

    • (fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

    • (fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

Readonly readvSync

readvSync: ((fd, buffers, position?) => number) = notImplemented

Type declaration

    • (fd, buffers, position?): number

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • Optional position: null | number

      Returns number

Readonly realpath

realpath: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IRealpathOptions
      • callback: TCallback<TDataOut>

      Returns any

Readonly realpathSync

realpathSync: ((path, options?) => TDataOut) = ...

Type declaration

    • (path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: string | IRealpathOptions

      Returns TDataOut

releasedFds

releasedFds: number[] = []

A list of reusable (opened and closed) file descriptors, that should be used first before creating a new file descriptor.

-

Readonly rename

rename: ((oldPath, newPath, callback) => void) = ...

Type declaration

    • (oldPath, newPath, callback): void

    • Parameters

      • oldPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

Todo

There is a proposal for native move support.

+

Readonly rename

rename: ((oldPath, newPath, callback) => void) = ...

Type declaration

    • (oldPath, newPath, callback): void

    • Parameters

      • oldPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

Todo

There is a proposal for native move support.

See

https://github.com/whatwg/fs/blob/main/proposals/MovingNonOpfsFiles.md

-

Readonly renameSync

renameSync: ((oldPath, newPath) => void) = ...

Type declaration

    • (oldPath, newPath): void

    • Parameters

      • oldPath: PathLike
      • newPath: PathLike

      Returns void

Readonly rm

rm: {
    (path, callback): void;
    (path, options, callback): void;
} = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IRmOptions
      • callback: TCallback<void>

      Returns void

Readonly rmSync

rmSync: ((path, options?) => void) = ...

Type declaration

    • (path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: IRmOptions

      Returns void

Readonly rmdir

rmdir: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IRmdirOptions
      • callback: TCallback<void>

      Returns any

Readonly rmdirSync

rmdirSync: ((path, options?) => void) = ...

Type declaration

    • (path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: IRmdirOptions

      Returns void

Protected Readonly root

root: IFileSystemDirectoryHandle | Promise<IFileSystemDirectoryHandle>

Readonly stat

stat: {
    (path, callback): void;
    (path, options, callback): void;
} = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

Readonly statSync

statSync: {
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path, options): undefined | IStats<bigint>;
    (path, options): IStats<bigint>;
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path): IStats<number>;
} = ...

Type declaration

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path, options): undefined | IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | IStats<bigint>

    • (path, options): IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns IStats<bigint>

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path): IStats<number>

    • Parameters

      • path: PathLike

      Returns IStats<number>

Readonly statfs

statfs: {
    (path, callback): void;
    (path, options, callback): void;
} = notImplemented

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<IStatFs<TStatNumber>>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<IStatFs<TStatNumber>>

      Returns void

Readonly statfsSync

statfsSync: ((path, options?) => IStatFs<TStatNumber>) = notImplemented

Type declaration

    • (path, options?): IStatFs<TStatNumber>

    • Parameters

      • path: PathLike
      • Optional options: IStafsOptions

      Returns IStatFs<TStatNumber>

Readonly symlink

symlink: {
    (target, path, callback): any;
    (target, path, type, callback): any;
} = notSupported

Type declaration

    • (target, path, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (target, path, type, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • type: Type
      • callback: TCallback<void>

      Returns any

Readonly symlinkSync

symlinkSync: ((target, path, type?) => void) = notSupported

Type declaration

    • (target, path, type?): void

    • Parameters

      • target: PathLike
      • path: PathLike
      • Optional type: Type

      Returns void

Optional syncAdapter

syncAdapter?: FsaNodeSyncAdapter

Readonly truncate

truncate: {
    (id, callback): any;
    (id, len, callback): any;
} = ...

Type declaration

    • (id, callback): any

    • Parameters

      • id: PathLike
      • callback: TCallback<void>

      Returns any

    • (id, len, callback): any

    • Parameters

      • id: PathLike
      • len: number
      • callback: TCallback<void>

      Returns any

Readonly truncateSync

truncateSync: ((id, len?) => void) = ...

Type declaration

    • (id, len?): void

    • Parameters

      • id: TFileId
      • Optional len: number

      Returns void

Readonly unlink

unlink: ((path, callback) => void) = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns void

Todo

There is a proposal for native "self remove" operation.

+

Readonly renameSync

renameSync: ((oldPath, newPath) => void) = ...

Type declaration

    • (oldPath, newPath): void

    • Parameters

      • oldPath: PathLike
      • newPath: PathLike

      Returns void

Readonly rm

rm: {
    (path, callback): void;
    (path, options, callback): void;
} = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IRmOptions
      • callback: TCallback<void>

      Returns void

Readonly rmSync

rmSync: ((path, options?) => void) = ...

Type declaration

    • (path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: IRmOptions

      Returns void

Readonly rmdir

rmdir: {
    (path, callback): any;
    (path, options, callback): any;
} = ...

Type declaration

    • (path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IRmdirOptions
      • callback: TCallback<void>

      Returns any

Readonly rmdirSync

rmdirSync: ((path, options?) => void) = ...

Type declaration

    • (path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: IRmdirOptions

      Returns void

Protected Readonly root

root: IFileSystemDirectoryHandle | Promise<IFileSystemDirectoryHandle>

Readonly stat

stat: {
    (path, callback): void;
    (path, options, callback): void;
} = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<IStats<TStatNumber>>

      Returns void

Readonly statSync

statSync: {
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path, options): undefined | IStats<bigint>;
    (path, options): IStats<bigint>;
    (path, options): undefined | IStats<number>;
    (path, options): IStats<number>;
    (path): IStats<number>;
} = ...

Type declaration

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path, options): undefined | IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | IStats<bigint>

    • (path, options): IStats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns IStats<bigint>

    • (path, options): undefined | IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | IStats<number>

    • (path, options): IStats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns IStats<number>

    • (path): IStats<number>

    • Parameters

      • path: PathLike

      Returns IStats<number>

Readonly statfs

statfs: {
    (path, callback): void;
    (path, options, callback): void;
} = notImplemented

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<IStatFs<TStatNumber>>

      Returns void

    • (path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<IStatFs<TStatNumber>>

      Returns void

Readonly statfsSync

statfsSync: ((path, options?) => IStatFs<TStatNumber>) = notImplemented

Type declaration

    • (path, options?): IStatFs<TStatNumber>

    • Parameters

      • path: PathLike
      • Optional options: IStafsOptions

      Returns IStatFs<TStatNumber>

Readonly symlink

symlink: {
    (target, path, callback): any;
    (target, path, type, callback): any;
} = notSupported

Type declaration

    • (target, path, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • (target, path, type, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • type: Type
      • callback: TCallback<void>

      Returns any

Readonly symlinkSync

symlinkSync: ((target, path, type?) => void) = notSupported

Type declaration

    • (target, path, type?): void

    • Parameters

      • target: PathLike
      • path: PathLike
      • Optional type: Type

      Returns void

Optional syncAdapter

syncAdapter?: FsaNodeSyncAdapter

Readonly truncate

truncate: {
    (id, callback): any;
    (id, len, callback): any;
} = ...

Type declaration

    • (id, callback): any

    • Parameters

      • id: PathLike
      • callback: TCallback<void>

      Returns any

    • (id, len, callback): any

    • Parameters

      • id: PathLike
      • len: number
      • callback: TCallback<void>

      Returns any

Readonly truncateSync

truncateSync: ((id, len?) => void) = ...

Type declaration

    • (id, len?): void

    • Parameters

      • id: TFileId
      • Optional len: number

      Returns void

Readonly unlink

unlink: ((path, callback) => void) = ...

Type declaration

    • (path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns void

Todo

There is a proposal for native "self remove" operation.

See

https://github.com/whatwg/fs/blob/main/proposals/Remove.md

-

Readonly unlinkSync

unlinkSync: ((path) => void) = ...

Type declaration

    • (path): void

    • Parameters

      • path: PathLike

      Returns void

Readonly unwatchFile

unwatchFile: ((path, listener?) => void) = notSupported

Type declaration

    • (path, listener?): void

    • Parameters

      • path: PathLike
      • Optional listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: IStats<TStatNumber>
            • prev: IStats<TStatNumber>

            Returns void

      Returns void

Readonly utimes

utimes: ((path, atime, mtime, callback) => void) = ...

Type declaration

    • (path, atime, mtime, callback): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

Readonly utimesSync

utimesSync: ((path, atime, mtime) => void) = noop

Type declaration

    • (path, atime, mtime): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime

      Returns void

Readonly watch

watch: ((path, options?, listener?) => IFSWatcher) = notSupported

Type declaration

    • (path, options?, listener?): IFSWatcher

    • Parameters

      • path: PathLike
      • Optional options: string | IWatchOptions
      • Optional listener: ((eventType, filename) => void)
          • (eventType, filename): void

          • Parameters

            • eventType: string
            • filename: string

            Returns void

      Returns IFSWatcher

Readonly watchFile

watchFile: {
    (path, listener): IStatWatcher;
    (path, options, listener): IStatWatcher;
} = notSupported

Type declaration

    • (path, listener): IStatWatcher

    • Parameters

      • path: PathLike
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: IStats<TStatNumber>
            • prev: IStats<TStatNumber>

            Returns void

      Returns IStatWatcher

    • (path, options, listener): IStatWatcher

    • Parameters

      • path: PathLike
      • options: IWatchFileOptions
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: IStats<TStatNumber>
            • prev: IStats<TStatNumber>

            Returns void

      Returns IStatWatcher

Todo

Watchers could be implemented in the future on top of FileSystemObserver, +

Readonly unlinkSync

unlinkSync: ((path) => void) = ...

Type declaration

    • (path): void

    • Parameters

      • path: PathLike

      Returns void

Readonly unwatchFile

unwatchFile: ((path, listener?) => void) = notSupported

Type declaration

    • (path, listener?): void

    • Parameters

      • path: PathLike
      • Optional listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: IStats<TStatNumber>
            • prev: IStats<TStatNumber>

            Returns void

      Returns void

Readonly utimes

utimes: ((path, atime, mtime, callback) => void) = ...

Type declaration

    • (path, atime, mtime, callback): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

Readonly utimesSync

utimesSync: ((path, atime, mtime) => void) = noop

Type declaration

    • (path, atime, mtime): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime

      Returns void

Readonly watch

watch: ((path, options?, listener?) => IFSWatcher) = notSupported

Type declaration

    • (path, options?, listener?): IFSWatcher

    • Parameters

      • path: PathLike
      • Optional options: string | IWatchOptions
      • Optional listener: ((eventType, filename) => void)
          • (eventType, filename): void

          • Parameters

            • eventType: string
            • filename: string

            Returns void

      Returns IFSWatcher

Readonly watchFile

watchFile: {
    (path, listener): IStatWatcher;
    (path, options, listener): IStatWatcher;
} = notSupported

Type declaration

    • (path, listener): IStatWatcher

    • Parameters

      • path: PathLike
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: IStats<TStatNumber>
            • prev: IStats<TStatNumber>

            Returns void

      Returns IStatWatcher

    • (path, options, listener): IStatWatcher

    • Parameters

      • path: PathLike
      • options: IWatchFileOptions
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: IStats<TStatNumber>
            • prev: IStats<TStatNumber>

            Returns void

      Returns IStatWatcher

Todo

Watchers could be implemented in the future on top of FileSystemObserver, which is currently a proposal.

See

https://github.com/whatwg/fs/blob/main/proposals/FileSystemObserver.md

-

Readonly write

write: {
    (fd, buffer, callback): any;
    (fd, buffer, offset, callback): any;
    (fd, buffer, offset, length, callback): any;
    (fd, buffer, offset, length, position, callback): any;
    (fd, str, callback): any;
    (fd, str, position, callback): any;
    (fd, str, position, encoding, callback): any;
} = ...

Type declaration

    • (fd, buffer, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, buffer, offset, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, buffer, offset, length, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, buffer, offset, length, position, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, str, callback): any

    • Parameters

      • fd: number
      • str: string
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, str, position, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, str, position, encoding, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • encoding: BufferEncoding
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

Readonly writeFile

writeFile: {
    (id, data, callback): any;
    (id, data, options, callback): any;
} = ...

Type declaration

    • (id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • (id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IWriteFileOptions
      • callback: TCallback<void>

      Returns any

Readonly writeFileSync

writeFileSync: ((id, data, options?) => void) = ...

Type declaration

    • (id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: IWriteFileOptions

      Returns void

Readonly writeSync

writeSync: {
    (fd, buffer, offset?, length?, position?): number;
    (fd, str, position?, encoding?): number;
} = ...

Type declaration

    • (fd, buffer, offset?, length?, position?): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • Optional offset: number
      • Optional length: number
      • Optional position: null | number

      Returns number

    • (fd, str, position?, encoding?): number

    • Parameters

      • fd: number
      • str: string
      • Optional position: number
      • Optional encoding: BufferEncoding

      Returns number

Readonly writev

writev: {
    (fd, buffers, callback): void;
    (fd, buffers, position, callback): void;
} = ...

Type declaration

    • (fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: WritevCallback

      Returns void

    • (fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: WritevCallback

      Returns void

Readonly writevSync

writevSync: ((fd, buffers, position?) => void) = ...

Type declaration

    • (fd, buffers, position?): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • Optional position: null | number

      Returns void

Static Protected fd

fd: number = 0x7fffffff

Methods

Protected __close

__getFileById

Protected __open

Protected __open2

Protected getDir

Readonly write

write: {
    (fd, buffer, callback): any;
    (fd, buffer, offset, callback): any;
    (fd, buffer, offset, length, callback): any;
    (fd, buffer, offset, length, position, callback): any;
    (fd, str, callback): any;
    (fd, str, position, callback): any;
    (fd, str, position, encoding, callback): any;
} = ...

Type declaration

    • (fd, buffer, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, buffer, offset, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, buffer, offset, length, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, buffer, offset, length, position, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, str, callback): any

    • Parameters

      • fd: number
      • str: string
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, str, position, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • (fd, str, position, encoding, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • encoding: BufferEncoding
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

Readonly writeFile

writeFile: {
    (id, data, callback): any;
    (id, data, options, callback): any;
} = ...

Type declaration

    • (id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • (id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IWriteFileOptions
      • callback: TCallback<void>

      Returns any

Readonly writeFileSync

writeFileSync: ((id, data, options?) => void) = ...

Type declaration

    • (id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: IWriteFileOptions

      Returns void

Readonly writeSync

writeSync: {
    (fd, buffer, offset?, length?, position?): number;
    (fd, str, position?, encoding?): number;
} = ...

Type declaration

    • (fd, buffer, offset?, length?, position?): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • Optional offset: number
      • Optional length: number
      • Optional position: null | number

      Returns number

    • (fd, str, position?, encoding?): number

    • Parameters

      • fd: number
      • str: string
      • Optional position: number
      • Optional encoding: BufferEncoding

      Returns number

Readonly writev

writev: {
    (fd, buffers, callback): void;
    (fd, buffers, position, callback): void;
} = ...

Type declaration

    • (fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: WritevCallback

      Returns void

    • (fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: WritevCallback

      Returns void

Readonly writevSync

writevSync: ((fd, buffers, position?) => void) = ...

Type declaration

    • (fd, buffers, position?): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • Optional position: null | number

      Returns void

Static Protected fd

fd: number = 0x7fffffff

Methods

Protected __close

__getFileById

Protected __open

Protected __open2

Protected getDir

Protected getFile

Protected getFileByFd

Protected getFileByFdAsync

Protected getFileByIdOrCreate

Protected getFileName

Protected getFileOrDir

Private getHandleStats

Protected getSyncAdapter

Protected newFdNumber

Private rmAll

Settings

Member Visibility

Theme

On This Page

constructorDirDirentFSWatcherF_OKR_OKReadStreamStatFsStatsStatsWatcherW_OKWriteStreamX_OKaccessaccessSyncappendFileappendFileSyncchmodchmodSyncchownchownSyncclosecloseSyncconstantscopyFilecopyFileSynccpcpSynccreateReadStreamcreateWriteStreamexistsexistsSyncfchmodfchmodSyncfchownfchownSyncfdatasyncfdatasyncSyncfdsfstatfstatSyncfsyncfsyncSyncftruncateftruncateSyncfutimesfutimesSynclchmodlchmodSynclchownlchownSynclinklinkSynclstatlstatSynclutimeslutimesSyncmkdirmkdirSyncmkdtempmkdtempSyncopenopenAsBlobopenSyncopendiropendirSyncpromisesreadreadFilereadFileSyncreadSyncreaddirreaddirSyncreadlinkreadlinkSyncreadvreadvSyncrealpathrealpathSyncreleasedFdsrenamerenameSyncrmrmSyncrmdirrmdirSyncrootstatstatSyncstatfsstatfsSyncsymlinksymlinkSyncsyncAdaptertruncatetruncateSyncunlinkunlinkSyncunwatchFileutimesutimesSyncwatchwatchFilewritewriteFilewriteFileSyncwriteSyncwritevwritevSyncfd__close__getFileById__open__open2getDirgetFilegetFileByFdgetFileByFdAsyncgetFileByIdOrCreategetFileNamegetFileOrDirgetHandleStatsgetSyncAdapternewFdNumberrmAll
\ No newline at end of file +
  • Optional funcName: string

    • Returns Promise<IFileSystemDirectoryHandle>

    Protected getFile

    Protected getFileByFd

    Protected getFileByFdAsync

    Protected getFileByIdOrCreate

    Protected getFileName

    Protected getFileOrDir

    Private getHandleStats

    Protected getSyncAdapter

    Protected newFdNumber

    Private rmAll

    Settings

    Member Visibility

    Theme

    On This Page

    constructorDirDirentFSWatcherF_OKR_OKReadStreamStatFsStatsStatsWatcherW_OKWriteStreamX_OKaccessaccessSyncappendFileappendFileSyncchmodchmodSyncchownchownSyncclosecloseSyncconstantscopyFilecopyFileSynccpcpSynccreateReadStreamcreateWriteStreamexistsexistsSyncfchmodfchmodSyncfchownfchownSyncfdatasyncfdatasyncSyncfdsfstatfstatSyncfsyncfsyncSyncftruncateftruncateSyncfutimesfutimesSynclchmodlchmodSynclchownlchownSynclinklinkSynclstatlstatSynclutimeslutimesSyncmkdirmkdirSyncmkdtempmkdtempSyncopenopenAsBlobopenSyncopendiropendirSyncpromisesreadreadFilereadFileSyncreadSyncreaddirreaddirSyncreadlinkreadlinkSyncreadvreadvSyncrealpathrealpathSyncreleasedFdsrenamerenameSyncrmrmSyncrmdirrmdirSyncrootstatstatSyncstatfsstatfsSyncsymlinksymlinkSyncsyncAdaptertruncatetruncateSyncunlinkunlinkSyncunwatchFileutimesutimesSyncwatchwatchFilewritewriteFilewriteFileSyncwriteSyncwritevwritevSyncfd__close__getFileById__open__open2getDirgetFilegetFileByFdgetFileByFdAsyncgetFileByIdOrCreategetFileNamegetFileOrDirgetHandleStatsgetSyncAdapternewFdNumberrmAll
    \ No newline at end of file diff --git a/classes/fsa_to_node.FsaNodeSyncAdapterWorker.html b/classes/fsa_to_node.FsaNodeSyncAdapterWorker.html index efc49b503..6d3ec13a4 100644 --- a/classes/fsa_to_node.FsaNodeSyncAdapterWorker.html +++ b/classes/fsa_to_node.FsaNodeSyncAdapterWorker.html @@ -1,6 +1,6 @@ -FsaNodeSyncAdapterWorker | memfs

    Class FsaNodeSyncAdapterWorker

    Implements

    • FsaNodeSyncAdapter

    Constructors

    constructor +FsaNodeSyncAdapterWorker | memfs

    Class FsaNodeSyncAdapterWorker

    Implements

    • FsaNodeSyncAdapter

    Constructors

    constructor

    Properties

    messenger root

    Methods

    call start -

    Constructors

    constructor

    Properties

    Protected Readonly messenger

    messenger: SyncMessenger

    Protected Readonly root

    root: IFileSystemDirectoryHandle

    Methods

    call

    Static start

    Settings

    Member Visibility

    Theme

    On This Page

    constructormessengerrootcallstart
    \ No newline at end of file +

    Constructors

    constructor

    Properties

    Protected Readonly messenger

    messenger: SyncMessenger

    Protected Readonly root

    root: IFileSystemDirectoryHandle

    Methods

    call

    Static start

    Settings

    Member Visibility

    Theme

    On This Page

    constructormessengerrootcallstart
    \ No newline at end of file diff --git a/classes/node_to_crud.NodeCrud.html b/classes/node_to_crud.NodeCrud.html index 1b2844095..941018bc6 100644 --- a/classes/node_to_crud.NodeCrud.html +++ b/classes/node_to_crud.NodeCrud.html @@ -1,4 +1,4 @@ -NodeCrud | memfs

    Class NodeCrud

    Implements

    Constructors

    constructor +NodeCrud | memfs

    Class NodeCrud

    Implements

    Constructors

    constructor

    Properties

    dir fs options @@ -12,6 +12,6 @@ info list put -

    Constructors

    constructor

    Properties

    Protected Readonly dir

    dir: string

    Protected Readonly fs

    fs: FsPromisesApi

    Protected Readonly options

    options: NodeCrudOptions

    Readonly scan

    scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>) = ...

    Iterates over all resources of a collection.

    +

    Constructors

    constructor

    Properties

    Protected Readonly dir

    dir: string

    Protected Readonly fs

    fs: FsPromisesApi

    Protected Readonly options

    options: NodeCrudOptions

    Readonly scan

    scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>) = ...

    Iterates over all resources of a collection.

    Type declaration

    Returns

    Iterator of resources of the given type.

    -

    Protected Readonly separator

    separator: string

    Methods

    Protected checkDir

    Readonly del

    Readonly drop

    Readonly from

    Readonly get

    Readonly info

    Readonly list

    Readonly put

    Settings

    Member Visibility

    Theme

    On This Page

    constructordirfsoptionsscanseparatorcheckDirdeldropfromgetinfolistput
    \ No newline at end of file +

    Protected Readonly separator

    separator: string

    Methods

    Protected checkDir

    Readonly del

    Readonly drop

    Readonly from

    Readonly get

    Readonly info

    Readonly list

    Readonly put

    Settings

    Member Visibility

    Theme

    On This Page

    constructordirfsoptionsscanseparatorcheckDirdeldropfromgetinfolistput
    \ No newline at end of file diff --git a/classes/node_to_fsa.NodeFileSystemDirectoryHandle.html b/classes/node_to_fsa.NodeFileSystemDirectoryHandle.html index e9f0acd4d..fc7519768 100644 --- a/classes/node_to_fsa.NodeFileSystemDirectoryHandle.html +++ b/classes/node_to_fsa.NodeFileSystemDirectoryHandle.html @@ -1,5 +1,5 @@ NodeFileSystemDirectoryHandle | memfs

    Class NodeFileSystemDirectoryHandle

    See

    https://developer.mozilla.org/en-US/docs/Web/API/FileSystemDirectoryHandle

    -

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    __path ctx fs @@ -16,42 +16,42 @@ requestPermission resolve values -

    Constructors

    constructor

    Properties

    Readonly __path

    __path: string

    Directory path with trailing slash.

    -

    Protected Readonly ctx

    ctx: Partial<NodeFsaContext>

    Protected Readonly fs

    fs: NodeFsaFs

    Readonly kind

    kind: "file" | "directory"

    Readonly name

    name: string

    Methods

    entries

    getDirectoryHandle

    Constructors

    constructor

    Properties

    Readonly __path

    __path: string

    Directory path with trailing slash.

    +

    Protected Readonly ctx

    ctx: Partial<NodeFsaContext>

    Protected Readonly fs

    fs: NodeFsaFs

    Readonly kind

    kind: "file" | "directory"

    Readonly name

    name: string

    Methods

    entries

    getDirectoryHandle

    getFileHandle

    getFileHandle

    isSameEntry

    isSameEntry

    keys

    keys

    queryPermission

    remove

    removeEntry

    queryPermission

    remove

    removeEntry

    requestPermission

    resolve

    requestPermission

    resolve

    values

    values

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__pathctxfskindnameentriesgetDirectoryHandlegetFileHandleisSameEntrykeysqueryPermissionremoveremoveEntryrequestPermissionresolvevalues
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__pathctxfskindnameentriesgetDirectoryHandlegetFileHandleisSameEntrykeysqueryPermissionremoveremoveEntryrequestPermissionresolvevalues
    \ No newline at end of file diff --git a/classes/node_to_fsa.NodeFileSystemFileHandle.html b/classes/node_to_fsa.NodeFileSystemFileHandle.html index bb8396169..d753f8695 100644 --- a/classes/node_to_fsa.NodeFileSystemFileHandle.html +++ b/classes/node_to_fsa.NodeFileSystemFileHandle.html @@ -1,7 +1,7 @@ NodeFileSystemFileHandle | memfs

    Class NodeFileSystemFileHandle

    Represents a File System Access API file handle FileSystemHandle object, which was created from a Node.js fs module.

    See

    MDN Documentation

    -

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    __path ctx fs @@ -14,14 +14,14 @@ queryPermission remove requestPermission -

    Constructors

    constructor

    Properties

    Readonly __path

    __path: string

    Protected Readonly ctx

    ctx: NodeFsaContext

    Protected Readonly fs

    fs: NodeFsaFs

    Readonly kind

    kind: "file" | "directory"

    Readonly name

    name: string

    Accessors

    createSyncAccessHandle

    Methods

    createWritable

    getFile

    • getFile(): Promise<File>

    • Returns a Promise which resolves to a File object +

    Constructors

    constructor

    Properties

    Readonly __path

    __path: string

    Protected Readonly ctx

    ctx: NodeFsaContext

    Protected Readonly fs

    fs: NodeFsaFs

    Readonly kind

    kind: "file" | "directory"

    Readonly name

    name: string

    Accessors

    createSyncAccessHandle

    Methods

    createWritable

    getFile

    isSameEntry

    isSameEntry

    queryPermission

    remove

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__pathctxfskindnamecreateSyncAccessHandlecreateWritablegetFileisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file +

    queryPermission

    remove

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    constructor__pathctxfskindnamecreateSyncAccessHandlecreateWritablegetFileisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file diff --git a/classes/node_to_fsa.NodeFileSystemHandle.html b/classes/node_to_fsa.NodeFileSystemHandle.html index bade271de..2dcf98671 100644 --- a/classes/node_to_fsa.NodeFileSystemHandle.html +++ b/classes/node_to_fsa.NodeFileSystemHandle.html @@ -1,16 +1,16 @@ NodeFileSystemHandle | memfs

    Class NodeFileSystemHandleAbstract

    Represents a File System Access API file handle FileSystemHandle object, which was created from a Node.js fs module.

    See

    MDN Documentation

    -

    Hierarchy (view full)

    Implements

    Constructors

    constructor +

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    kind name

    Methods

    isSameEntry queryPermission remove requestPermission -

    Constructors

    constructor

    Properties

    Readonly kind

    kind: "file" | "directory"

    Readonly name

    name: string

    Methods

    isSameEntry

    • isSameEntry(fileSystemHandle): boolean

    • Compares two handles to see if the associated entries (either a file or directory) match.

      +

    Constructors

    constructor

    Properties

    Readonly kind

    kind: "file" | "directory"

    Readonly name

    name: string

    Methods

    isSameEntry

    queryPermission

    remove

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    constructorkindnameisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file +

    queryPermission

    remove

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    constructorkindnameisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file diff --git a/coverage/clover.xml b/coverage/clover.xml index 4aa621a71..b9503c83f 100644 --- a/coverage/clover.xml +++ b/coverage/clover.xml @@ -1,6 +1,6 @@ - - + + diff --git a/coverage/lcov-report/index.html b/coverage/lcov-report/index.html index 88580bf35..3ed9d82be 100644 --- a/coverage/lcov-report/index.html +++ b/coverage/lcov-report/index.html @@ -341,7 +341,7 @@

    All files

    Code coverage generated by istanbul - at 2024-04-30T21:18:34.626Z + at 2024-05-02T23:56:56.702Z

    Function createFsFromVolume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +createFsFromVolume | memfs

    Function createFsFromVolume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.memfs.html b/functions/index.memfs.html index f5670203a..d48a7d65a 100644 --- a/functions/index.memfs.html +++ b/functions/index.memfs.html @@ -5,4 +5,4 @@ relative to this path.

    Returns {
        fs: IFs;
        vol: Volume;
    }

    A memfs file system instance, which is a drop-in replacement for the fs module.

    -
    • fs: IFs
    • vol: Volume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
    • fs: IFs
    • vol: Volume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/node_to_fsa.nodeToFsa.html b/functions/node_to_fsa.nodeToFsa.html index 27227f2dc..8691afb32 100644 --- a/functions/node_to_fsa.nodeToFsa.html +++ b/functions/node_to_fsa.nodeToFsa.html @@ -1 +1 @@ -nodeToFsa | memfs

    Function nodeToFsa

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +nodeToFsa | memfs

    Function nodeToFsa

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/cas_types.CasApi.html b/interfaces/cas_types.CasApi.html index 146813f8d..d289da623 100644 --- a/interfaces/cas_types.CasApi.html +++ b/interfaces/cas_types.CasApi.html @@ -1,5 +1,5 @@ -CasApi | memfs

    Interface CasApi<Hash>

    interface CasApi<Hash> {
        del(hash, silent?): Promise<void>;
        get(hash, options?): Promise<Uint8Array>;
        info(hash): Promise<CrudResourceInfo>;
        put(blob): Promise<Hash>;
    }

    Type Parameters

    • Hash

    Methods

    del +CasApi | memfs

    Interface CasApi<Hash>

    interface CasApi<Hash> {
        del(hash, silent?): Promise<void>;
        get(hash, options?): Promise<Uint8Array>;
        info(hash): Promise<CrudResourceInfo>;
        put(blob): Promise<Hash>;
    }

    Type Parameters

    • Hash

    Methods

    del get info put -

    Methods

    del

    get

    info

    put

    Settings

    Member Visibility

    Theme

    On This Page

    delgetinfoput
    \ No newline at end of file +

    Methods

    del

    get

    info

    put

    Settings

    Member Visibility

    Theme

    On This Page

    delgetinfoput
    \ No newline at end of file diff --git a/interfaces/cas_types.CasGetOptions.html b/interfaces/cas_types.CasGetOptions.html index 30ecb4fd2..550966866 100644 --- a/interfaces/cas_types.CasGetOptions.html +++ b/interfaces/cas_types.CasGetOptions.html @@ -1,2 +1,2 @@ -CasGetOptions | memfs

    Interface CasGetOptions

    interface CasGetOptions {
        skipVerification?: boolean;
    }

    Properties

    skipVerification? -

    Properties

    Optional skipVerification

    skipVerification?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    skipVerification
    \ No newline at end of file +CasGetOptions | memfs

    Interface CasGetOptions

    interface CasGetOptions {
        skipVerification?: boolean;
    }

    Properties

    skipVerification? +

    Properties

    Optional skipVerification

    skipVerification?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    skipVerification
    \ No newline at end of file diff --git a/interfaces/crud_to_cas.CrudCasOptions.html b/interfaces/crud_to_cas.CrudCasOptions.html index c8cdfe278..00512049c 100644 --- a/interfaces/crud_to_cas.CrudCasOptions.html +++ b/interfaces/crud_to_cas.CrudCasOptions.html @@ -1,2 +1,2 @@ -CrudCasOptions | memfs

    Interface CrudCasOptions

    interface CrudCasOptions {
        hash: ((blob) => Promise<string>);
    }

    Properties

    hash -

    Properties

    hash

    hash: ((blob) => Promise<string>)

    Type declaration

      • (blob): Promise<string>

      • Parameters

        • blob: Uint8Array

        Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    hash
    \ No newline at end of file +CrudCasOptions | memfs

    Interface CrudCasOptions

    interface CrudCasOptions {
        hash: ((blob) => Promise<string>);
    }

    Properties

    hash +

    Properties

    hash

    hash: ((blob) => Promise<string>)

    Type declaration

      • (blob): Promise<string>

      • Parameters

        • blob: Uint8Array

        Returns Promise<string>

    Settings

    Member Visibility

    Theme

    On This Page

    hash
    \ No newline at end of file diff --git a/interfaces/crud_types.CrudApi.html b/interfaces/crud_types.CrudApi.html index df72def28..220193d2b 100644 --- a/interfaces/crud_types.CrudApi.html +++ b/interfaces/crud_types.CrudApi.html @@ -1,4 +1,4 @@ -CrudApi | memfs

    Interface CrudApi

    interface CrudApi {
        del: ((collection, id, silent?) => Promise<void>);
        drop: ((collection, silent?) => Promise<void>);
        from: ((collection) => Promise<CrudApi>);
        get: ((collection, id) => Promise<Uint8Array>);
        info: ((collection, id?) => Promise<CrudResourceInfo>);
        list: ((collection) => Promise<CrudCollectionEntry[]>);
        put: ((collection, id, data, options?) => Promise<void>);
        scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>);
    }

    Implemented by

    Properties

    del +CrudApi | memfs

    Interface CrudApi

    interface CrudApi {
        del: ((collection, id, silent?) => Promise<void>);
        drop: ((collection, silent?) => Promise<void>);
        from: ((collection) => Promise<CrudApi>);
        get: ((collection, id) => Promise<Uint8Array>);
        info: ((collection, id?) => Promise<CrudResourceInfo>);
        list: ((collection) => Promise<CrudCollectionEntry[]>);
        put: ((collection, id, data, options?) => Promise<void>);
        scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>);
    }

    Implemented by

    Properties

    del drop from get @@ -11,30 +11,30 @@
  • id: string

    Id of the resource, document name.

  • Optional silent: boolean

    When true, does not throw an error if the collection or resource does not exist. Default is false.

    -

    • Returns Promise<void>

    drop

    drop: ((collection, silent?) => Promise<void>)

    Deletes all resources of a collection, and deletes recursively all sub-collections.

    +

    Returns Promise<void>

    drop

    drop: ((collection, silent?) => Promise<void>)

    Deletes all resources of a collection, and deletes recursively all sub-collections.

    Type declaration

      • (collection, silent?): Promise<void>

      • Parameters

        • collection: CrudCollection

          Type of the resource, collection name.

        • Optional silent: boolean

          When true, does not throw an error if the collection or resource does not exist. Default is false.

          -

        Returns Promise<void>

    from

    from: ((collection) => Promise<CrudApi>)

    Creates a new CrudApi instance, with the given collection as root.

    +

    Returns Promise<void>

    from

    from: ((collection) => Promise<CrudApi>)

    Creates a new CrudApi instance, with the given collection as root.

    Type declaration

    Returns

    A new CrudApi instance, with the given collection as root.

    -

    get

    get: ((collection, id) => Promise<Uint8Array>)

    Retrieves the content of a resource.

    +

    get

    get: ((collection, id) => Promise<Uint8Array>)

    Retrieves the content of a resource.

    Type declaration

      • (collection, id): Promise<Uint8Array>

      • Parameters

        • collection: CrudCollection

          Type of the resource, collection name.

        • id: string

          Id of the resource, document name.

        Returns Promise<Uint8Array>

    Returns

    Blob content of the resource.

    -

    info

    info: ((collection, id?) => Promise<CrudResourceInfo>)

    Fetches information about a resource.

    +

    info

    info: ((collection, id?) => Promise<CrudResourceInfo>)

    Fetches information about a resource.

    Type declaration

    Returns

    Information about the resource.

    -

    list

    list: ((collection) => Promise<CrudCollectionEntry[]>)

    Fetches a list of resources of a collection, and sub-collections.

    +

    list

    list: ((collection) => Promise<CrudCollectionEntry[]>)

    Fetches a list of resources of a collection, and sub-collections.

    Type declaration

    Returns

    List of resources of the given type, and sub-types.

    -

    put

    put: ((collection, id, data, options?) => Promise<void>)

    Creates a new resource, or overwrites an existing one.

    +

    put

    put: ((collection, id, data, options?) => Promise<void>)

    Creates a new resource, or overwrites an existing one.

    Type declaration

      • (collection, id, data, options?): Promise<void>

      • Parameters

        • collection: CrudCollection

          Type of the resource, collection name.

        • id: string

          Id of the resource, document name.

        • data: Uint8Array

          Blob content of the resource.

        • Optional options: CrudPutOptions

          Write behavior options.

          -

        Returns Promise<void>

    scan

    scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>)

    Iterates over all resources of a collection.

    +

    Returns Promise<void>

    scan

    scan: ((collection) => AsyncIterableIterator<CrudCollectionEntry>)

    Iterates over all resources of a collection.

    Type declaration

    Returns

    Iterator of resources of the given type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    deldropfromgetinfolistputscan
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    deldropfromgetinfolistputscan
    \ No newline at end of file diff --git a/interfaces/crud_types.CrudCollectionEntry.html b/interfaces/crud_types.CrudCollectionEntry.html index af6dfbc2e..2e1c91d1e 100644 --- a/interfaces/crud_types.CrudCollectionEntry.html +++ b/interfaces/crud_types.CrudCollectionEntry.html @@ -1,5 +1,5 @@ -CrudCollectionEntry | memfs

    Interface CrudCollectionEntry

    interface CrudCollectionEntry {
        id: string;
        type: "resource" | "collection";
    }

    Hierarchy (view full)

    Properties

    id +CrudCollectionEntry | memfs

    Interface CrudCollectionEntry

    interface CrudCollectionEntry {
        id: string;
        type: "resource" | "collection";
    }

    Hierarchy (view full)

    Properties

    id type

    Properties

    id

    id: string

    Name of the resource.

    -

    type

    type: "resource" | "collection"

    Kind of the resource, type or item.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    idtype
    \ No newline at end of file +

    type

    type: "resource" | "collection"

    Kind of the resource, type or item.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    idtype
    \ No newline at end of file diff --git a/interfaces/crud_types.CrudPutOptions.html b/interfaces/crud_types.CrudPutOptions.html index 94c81f7f6..83eaac902 100644 --- a/interfaces/crud_types.CrudPutOptions.html +++ b/interfaces/crud_types.CrudPutOptions.html @@ -1,2 +1,2 @@ -CrudPutOptions | memfs

    Interface CrudPutOptions

    interface CrudPutOptions {
        throwIf?: "exists" | "missing";
    }

    Properties

    throwIf? -

    Properties

    Optional throwIf

    throwIf?: "exists" | "missing"

    Settings

    Member Visibility

    Theme

    On This Page

    throwIf
    \ No newline at end of file +CrudPutOptions | memfs

    Interface CrudPutOptions

    interface CrudPutOptions {
        throwIf?: "exists" | "missing";
    }

    Properties

    throwIf? +

    Properties

    Optional throwIf

    throwIf?: "exists" | "missing"

    Settings

    Member Visibility

    Theme

    On This Page

    throwIf
    \ No newline at end of file diff --git a/interfaces/crud_types.CrudResourceInfo.html b/interfaces/crud_types.CrudResourceInfo.html index 2c7aae8d3..7c34cd6c7 100644 --- a/interfaces/crud_types.CrudResourceInfo.html +++ b/interfaces/crud_types.CrudResourceInfo.html @@ -1,11 +1,11 @@ -CrudResourceInfo | memfs

    Interface CrudResourceInfo

    interface CrudResourceInfo {
        created?: number;
        id: string;
        modified?: number;
        size?: number;
        type: "resource" | "collection";
    }

    Hierarchy (view full)

    Properties

    created? +CrudResourceInfo | memfs

    Interface CrudResourceInfo

    interface CrudResourceInfo {
        created?: number;
        id: string;
        modified?: number;
        size?: number;
        type: "resource" | "collection";
    }

    Hierarchy (view full)

    Properties

    created? id modified? size? type

    Properties

    Optional created

    created?: number

    Timestamp when the resource was created.

    -

    id

    id: string

    Name of the resource.

    -

    Optional modified

    modified?: number

    Timestamp when the resource last modified.

    -

    Optional size

    size?: number

    Size of the resource in bytes.

    -

    type

    type: "resource" | "collection"

    Kind of the resource, type or item.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    createdidmodifiedsizetype
    \ No newline at end of file +

    id

    id: string

    Name of the resource.

    +

    Optional modified

    modified?: number

    Timestamp when the resource last modified.

    +

    Optional size

    size?: number

    Size of the resource in bytes.

    +

    type

    type: "resource" | "collection"

    Kind of the resource, type or item.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    createdidmodifiedsizetype
    \ No newline at end of file diff --git a/interfaces/fsa_types.CreateWritableOptions.html b/interfaces/fsa_types.CreateWritableOptions.html index da5bbd4f8..930956e30 100644 --- a/interfaces/fsa_types.CreateWritableOptions.html +++ b/interfaces/fsa_types.CreateWritableOptions.html @@ -1,2 +1,2 @@ -CreateWritableOptions | memfs

    Interface CreateWritableOptions

    interface CreateWritableOptions {
        keepExistingData?: boolean;
    }

    Properties

    keepExistingData? -

    Properties

    Optional keepExistingData

    keepExistingData?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    keepExistingData
    \ No newline at end of file +CreateWritableOptions | memfs

    Interface CreateWritableOptions

    interface CreateWritableOptions {
        keepExistingData?: boolean;
    }

    Properties

    keepExistingData? +

    Properties

    Optional keepExistingData

    keepExistingData?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    keepExistingData
    \ No newline at end of file diff --git a/interfaces/fsa_types.FileSystemHandlePermissionDescriptor.html b/interfaces/fsa_types.FileSystemHandlePermissionDescriptor.html index 2bda4f988..f613687cb 100644 --- a/interfaces/fsa_types.FileSystemHandlePermissionDescriptor.html +++ b/interfaces/fsa_types.FileSystemHandlePermissionDescriptor.html @@ -1,2 +1,2 @@ -FileSystemHandlePermissionDescriptor | memfs

    Interface FileSystemHandlePermissionDescriptor

    interface FileSystemHandlePermissionDescriptor {
        mode: "read" | "readwrite";
    }

    Properties

    mode -

    Properties

    mode

    mode: "read" | "readwrite"

    Settings

    Member Visibility

    Theme

    On This Page

    mode
    \ No newline at end of file +FileSystemHandlePermissionDescriptor | memfs

    Interface FileSystemHandlePermissionDescriptor

    interface FileSystemHandlePermissionDescriptor {
        mode: "read" | "readwrite";
    }

    Properties

    mode +

    Properties

    mode

    mode: "read" | "readwrite"

    Settings

    Member Visibility

    Theme

    On This Page

    mode
    \ No newline at end of file diff --git a/interfaces/fsa_types.FileSystemReadWriteOptions.html b/interfaces/fsa_types.FileSystemReadWriteOptions.html index 961a8de2b..89b5bc33f 100644 --- a/interfaces/fsa_types.FileSystemReadWriteOptions.html +++ b/interfaces/fsa_types.FileSystemReadWriteOptions.html @@ -1,3 +1,3 @@ -FileSystemReadWriteOptions | memfs

    Interface FileSystemReadWriteOptions

    interface FileSystemReadWriteOptions {
        at?: number;
    }

    Properties

    at? +FileSystemReadWriteOptions | memfs

    Interface FileSystemReadWriteOptions

    interface FileSystemReadWriteOptions {
        at?: number;
    }

    Properties

    at?

    Properties

    Optional at

    at?: number

    A number representing the offset in bytes that the file should be read from.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    at
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    at
    \ No newline at end of file diff --git a/interfaces/fsa_types.FileSystemWritableFileStreamParams.html b/interfaces/fsa_types.FileSystemWritableFileStreamParams.html index da0714a7a..e9cbc55bb 100644 --- a/interfaces/fsa_types.FileSystemWritableFileStreamParams.html +++ b/interfaces/fsa_types.FileSystemWritableFileStreamParams.html @@ -1,5 +1,5 @@ -FileSystemWritableFileStreamParams | memfs

    Interface FileSystemWritableFileStreamParams

    interface FileSystemWritableFileStreamParams {
        data?: Data;
        position?: number;
        size?: number;
        type: "write" | "truncate" | "seek";
    }

    Properties

    data? +FileSystemWritableFileStreamParams | memfs

    Interface FileSystemWritableFileStreamParams

    interface FileSystemWritableFileStreamParams {
        data?: Data;
        position?: number;
        size?: number;
        type: "write" | "truncate" | "seek";
    }

    Properties

    data? position? size? type -

    Properties

    Optional data

    data?: Data

    Optional position

    position?: number

    Optional size

    size?: number

    type

    type: "write" | "truncate" | "seek"

    Settings

    Member Visibility

    Theme

    On This Page

    datapositionsizetype
    \ No newline at end of file +

    Properties

    Optional data

    data?: Data

    Optional position

    position?: number

    Optional size

    size?: number

    type

    type: "write" | "truncate" | "seek"

    Settings

    Member Visibility

    Theme

    On This Page

    datapositionsizetype
    \ No newline at end of file diff --git a/interfaces/fsa_types.GetDirectoryHandleOptions.html b/interfaces/fsa_types.GetDirectoryHandleOptions.html index 32d3d8789..0789587c4 100644 --- a/interfaces/fsa_types.GetDirectoryHandleOptions.html +++ b/interfaces/fsa_types.GetDirectoryHandleOptions.html @@ -1,4 +1,4 @@ -GetDirectoryHandleOptions | memfs

    Interface GetDirectoryHandleOptions

    interface GetDirectoryHandleOptions {
        create?: boolean;
    }

    Properties

    create? +GetDirectoryHandleOptions | memfs

    Interface GetDirectoryHandleOptions

    interface GetDirectoryHandleOptions {
        create?: boolean;
    }

    Properties

    create?

    Properties

    Optional create

    create?: boolean

    A boolean value, which defaults to false. When set to true if the directory is not found, one with the specified name will be created and returned.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    create
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    create
    \ No newline at end of file diff --git a/interfaces/fsa_types.GetFileHandleOptions.html b/interfaces/fsa_types.GetFileHandleOptions.html index 45f56e94f..70e5b1862 100644 --- a/interfaces/fsa_types.GetFileHandleOptions.html +++ b/interfaces/fsa_types.GetFileHandleOptions.html @@ -1,4 +1,4 @@ -GetFileHandleOptions | memfs

    Interface GetFileHandleOptions

    interface GetFileHandleOptions {
        create?: boolean;
    }

    Properties

    create? +GetFileHandleOptions | memfs

    Interface GetFileHandleOptions

    interface GetFileHandleOptions {
        create?: boolean;
    }

    Properties

    create?

    Properties

    Optional create

    create?: boolean

    A Boolean. Default false. When set to true if the file is not found, one with the specified name will be created and returned.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    create
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    create
    \ No newline at end of file diff --git a/interfaces/fsa_types.IFileSystemDirectoryHandle.html b/interfaces/fsa_types.IFileSystemDirectoryHandle.html index f2bb039d0..3f9d0e8cc 100644 --- a/interfaces/fsa_types.IFileSystemDirectoryHandle.html +++ b/interfaces/fsa_types.IFileSystemDirectoryHandle.html @@ -1,4 +1,4 @@ -IFileSystemDirectoryHandle | memfs

    Interface IFileSystemDirectoryHandle

    interface IFileSystemDirectoryHandle {
        kind: "file" | "directory";
        name: string;
        entries(): AsyncIterableIterator<[string, IFileSystemHandle]>;
        getDirectoryHandle(name, options?): Promise<IFileSystemDirectoryHandle>;
        getFileHandle(name, options?): Promise<IFileSystemFileHandle>;
        isSameEntry(fileSystemHandle): boolean;
        keys(): AsyncIterableIterator<string>;
        queryPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        remove(options?): Promise<void>;
        removeEntry(name, options?): Promise<void>;
        requestPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        resolve(possibleDescendant): Promise<null | string[]>;
        values(): AsyncIterableIterator<IFileSystemHandle>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    kind +IFileSystemDirectoryHandle | memfs

    Interface IFileSystemDirectoryHandle

    interface IFileSystemDirectoryHandle {
        kind: "file" | "directory";
        name: string;
        entries(): AsyncIterableIterator<[string, IFileSystemHandle]>;
        getDirectoryHandle(name, options?): Promise<IFileSystemDirectoryHandle>;
        getFileHandle(name, options?): Promise<IFileSystemFileHandle>;
        isSameEntry(fileSystemHandle): boolean;
        keys(): AsyncIterableIterator<string>;
        queryPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        remove(options?): Promise<void>;
        removeEntry(name, options?): Promise<void>;
        requestPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        resolve(possibleDescendant): Promise<null | string[]>;
        values(): AsyncIterableIterator<IFileSystemHandle>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    kind name

    Methods

    entries getDirectoryHandle @@ -11,4 +11,4 @@ requestPermission resolve values -

    Properties

    kind

    kind: "file" | "directory"

    name

    name: string

    Methods

    entries

    getDirectoryHandle

    getFileHandle

    isSameEntry

    keys

    queryPermission

    remove

    removeEntry

    requestPermission

    resolve

    values

    Settings

    Member Visibility

    Theme

    On This Page

    kindnameentriesgetDirectoryHandlegetFileHandleisSameEntrykeysqueryPermissionremoveremoveEntryrequestPermissionresolvevalues
    \ No newline at end of file +

    Properties

    kind

    kind: "file" | "directory"

    name

    name: string

    Methods

    entries

    getDirectoryHandle

    getFileHandle

    isSameEntry

    keys

    queryPermission

    remove

    removeEntry

    requestPermission

    resolve

    values

    Settings

    Member Visibility

    Theme

    On This Page

    kindnameentriesgetDirectoryHandlegetFileHandleisSameEntrykeysqueryPermissionremoveremoveEntryrequestPermissionresolvevalues
    \ No newline at end of file diff --git a/interfaces/fsa_types.IFileSystemFileHandle.html b/interfaces/fsa_types.IFileSystemFileHandle.html index 9fd66e8fb..f840458e8 100644 --- a/interfaces/fsa_types.IFileSystemFileHandle.html +++ b/interfaces/fsa_types.IFileSystemFileHandle.html @@ -1,4 +1,4 @@ -IFileSystemFileHandle | memfs

    Interface IFileSystemFileHandle

    interface IFileSystemFileHandle {
        createSyncAccessHandle: undefined | (() => Promise<IFileSystemSyncAccessHandle>);
        kind: "file" | "directory";
        name: string;
        createWritable(options?): Promise<IFileSystemWritableFileStream>;
        getFile(): Promise<File>;
        isSameEntry(fileSystemHandle): boolean;
        queryPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        remove(options?): Promise<void>;
        requestPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    createSyncAccessHandle +IFileSystemFileHandle | memfs

    Interface IFileSystemFileHandle

    interface IFileSystemFileHandle {
        createSyncAccessHandle: undefined | (() => Promise<IFileSystemSyncAccessHandle>);
        kind: "file" | "directory";
        name: string;
        createWritable(options?): Promise<IFileSystemWritableFileStream>;
        getFile(): Promise<File>;
        isSameEntry(fileSystemHandle): boolean;
        queryPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        remove(options?): Promise<void>;
        requestPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    createSyncAccessHandle kind name

    Methods

    createWritable @@ -7,4 +7,4 @@ queryPermission remove requestPermission -

    Properties

    createSyncAccessHandle

    createSyncAccessHandle: undefined | (() => Promise<IFileSystemSyncAccessHandle>)

    Type declaration

    kind

    kind: "file" | "directory"

    name

    name: string

    Methods

    createWritable

    getFile

    isSameEntry

    queryPermission

    remove

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    createSyncAccessHandlekindnamecreateWritablegetFileisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file +

    Properties

    createSyncAccessHandle

    createSyncAccessHandle: undefined | (() => Promise<IFileSystemSyncAccessHandle>)

    Type declaration

    kind

    kind: "file" | "directory"

    name

    name: string

    Methods

    createWritable

    getFile

    isSameEntry

    queryPermission

    remove

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    createSyncAccessHandlekindnamecreateWritablegetFileisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file diff --git a/interfaces/fsa_types.IFileSystemHandle.html b/interfaces/fsa_types.IFileSystemHandle.html index b6fbd93da..20faad24a 100644 --- a/interfaces/fsa_types.IFileSystemHandle.html +++ b/interfaces/fsa_types.IFileSystemHandle.html @@ -1,7 +1,7 @@ -IFileSystemHandle | memfs

    Interface IFileSystemHandle

    interface IFileSystemHandle {
        kind: "file" | "directory";
        name: string;
        isSameEntry(fileSystemHandle): boolean;
        queryPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        remove(options?): Promise<void>;
        requestPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    kind +IFileSystemHandle | memfs

    Interface IFileSystemHandle

    interface IFileSystemHandle {
        kind: "file" | "directory";
        name: string;
        isSameEntry(fileSystemHandle): boolean;
        queryPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
        remove(options?): Promise<void>;
        requestPermission(fileSystemHandlePermissionDescriptor): IPermissionStatus;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    kind name

    Methods

    isSameEntry queryPermission remove requestPermission -

    Properties

    kind

    kind: "file" | "directory"

    name

    name: string

    Methods

    isSameEntry

    queryPermission

    remove

    • remove(options?): Promise<void>

    • Parameters

      • Optional options: {
            recursive?: boolean;
        }
        • Optional recursive?: boolean

      Returns Promise<void>

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    kindnameisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file +

    Properties

    kind

    kind: "file" | "directory"

    name

    name: string

    Methods

    isSameEntry

    queryPermission

    remove

    • remove(options?): Promise<void>

    • Parameters

      • Optional options: {
            recursive?: boolean;
        }
        • Optional recursive?: boolean

      Returns Promise<void>

    requestPermission

    Settings

    Member Visibility

    Theme

    On This Page

    kindnameisSameEntryqueryPermissionremoverequestPermission
    \ No newline at end of file diff --git a/interfaces/fsa_types.IFileSystemSyncAccessHandle.html b/interfaces/fsa_types.IFileSystemSyncAccessHandle.html index a42a28166..a5a462df2 100644 --- a/interfaces/fsa_types.IFileSystemSyncAccessHandle.html +++ b/interfaces/fsa_types.IFileSystemSyncAccessHandle.html @@ -1,7 +1,7 @@ -IFileSystemSyncAccessHandle | memfs

    Interface IFileSystemSyncAccessHandle

    interface IFileSystemSyncAccessHandle {
        close(): Promise<void>;
        flush(): Promise<void>;
        getSize(): Promise<number>;
        read(buffer, options?): Promise<number>;
        truncate(newSize): Promise<void>;
        write(buffer, options?): Promise<number>;
    }

    Methods

    close +IFileSystemSyncAccessHandle | memfs

    Interface IFileSystemSyncAccessHandle

    interface IFileSystemSyncAccessHandle {
        close(): Promise<void>;
        flush(): Promise<void>;
        getSize(): Promise<number>;
        read(buffer, options?): Promise<number>;
        truncate(newSize): Promise<void>;
        write(buffer, options?): Promise<number>;
    }

    Methods

    close flush getSize read truncate write -

    Methods

    close

    flush

    getSize

    read

    truncate

    write

    Settings

    Member Visibility

    Theme

    On This Page

    closeflushgetSizereadtruncatewrite
    \ No newline at end of file +

    Methods

    close

    flush

    getSize

    read

    truncate

    write

    Settings

    Member Visibility

    Theme

    On This Page

    closeflushgetSizereadtruncatewrite
    \ No newline at end of file diff --git a/interfaces/fsa_types.IFileSystemWritableFileStream.html b/interfaces/fsa_types.IFileSystemWritableFileStream.html index b4897679b..1f159174f 100644 --- a/interfaces/fsa_types.IFileSystemWritableFileStream.html +++ b/interfaces/fsa_types.IFileSystemWritableFileStream.html @@ -1,4 +1,4 @@ -IFileSystemWritableFileStream | memfs

    Interface IFileSystemWritableFileStream

    interface IFileSystemWritableFileStream {
        locked: boolean;
        abort(reason?): Promise<void>;
        close(): Promise<void>;
        getWriter(): WritableStreamDefaultWriter<any>;
        seek(position): Promise<void>;
        truncate(size): Promise<void>;
        write(chunk): Promise<void>;
        write(params): Promise<void>;
    }

    Hierarchy

    • WritableStream
      • IFileSystemWritableFileStream

    Properties

    locked +IFileSystemWritableFileStream | memfs

    Interface IFileSystemWritableFileStream

    interface IFileSystemWritableFileStream {
        locked: boolean;
        abort(reason?): Promise<void>;
        close(): Promise<void>;
        getWriter(): WritableStreamDefaultWriter<any>;
        seek(position): Promise<void>;
        truncate(size): Promise<void>;
        write(chunk): Promise<void>;
        write(params): Promise<void>;
    }

    Hierarchy

    • WritableStream
      • IFileSystemWritableFileStream

    Properties

    locked

    Methods

    abort close getWriter @@ -9,4 +9,4 @@

    Methods

    abort

    • abort(reason?): Promise<void>

    • MDN Reference

      Parameters

      • Optional reason: any

      Returns Promise<void>

    close

    • close(): Promise<void>

    • MDN Reference

      Returns Promise<void>

    getWriter

    • getWriter(): WritableStreamDefaultWriter<any>

    • MDN Reference

      -

      Returns WritableStreamDefaultWriter<any>

    seek

    truncate

    write

    Settings

    Member Visibility

    Theme

    On This Page

    lockedabortclosegetWriterseektruncatewrite
    \ No newline at end of file +

    Returns WritableStreamDefaultWriter<any>

    seek

    truncate

    write

    Settings

    Member Visibility

    Theme

    On This Page

    lockedabortclosegetWriterseektruncatewrite
    \ No newline at end of file diff --git a/interfaces/fsa_types.IPermissionStatus.html b/interfaces/fsa_types.IPermissionStatus.html index c40bd9a6f..7d22d839e 100644 --- a/interfaces/fsa_types.IPermissionStatus.html +++ b/interfaces/fsa_types.IPermissionStatus.html @@ -1,3 +1,3 @@ -IPermissionStatus | memfs

    Interface IPermissionStatus

    interface IPermissionStatus {
        name: string;
        state: "granted" | "denied" | "prompt";
    }

    Properties

    name +IPermissionStatus | memfs

    Interface IPermissionStatus

    interface IPermissionStatus {
        name: string;
        state: "granted" | "denied" | "prompt";
    }

    Properties

    name state -

    Properties

    name

    name: string

    state

    state: "granted" | "denied" | "prompt"

    Settings

    Member Visibility

    Theme

    On This Page

    namestate
    \ No newline at end of file +

    Properties

    name

    name: string

    state

    state: "granted" | "denied" | "prompt"

    Settings

    Member Visibility

    Theme

    On This Page

    namestate
    \ No newline at end of file diff --git a/interfaces/fsa_types.RemoveEntryOptions.html b/interfaces/fsa_types.RemoveEntryOptions.html index 1eba68a9d..63228cbad 100644 --- a/interfaces/fsa_types.RemoveEntryOptions.html +++ b/interfaces/fsa_types.RemoveEntryOptions.html @@ -1,4 +1,4 @@ -RemoveEntryOptions | memfs

    Interface RemoveEntryOptions

    interface RemoveEntryOptions {
        recursive?: boolean;
    }

    Properties

    recursive? +RemoveEntryOptions | memfs

    Interface RemoveEntryOptions

    interface RemoveEntryOptions {
        recursive?: boolean;
    }

    Properties

    recursive?

    Properties

    Optional recursive

    recursive?: boolean

    A boolean value, which defaults to false. When set to true entries will be removed recursively.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    recursive
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    recursive
    \ No newline at end of file diff --git a/interfaces/index.DirectoryJSON.html b/interfaces/index.DirectoryJSON.html index f51ac2fad..0c28c8a52 100644 --- a/interfaces/index.DirectoryJSON.html +++ b/interfaces/index.DirectoryJSON.html @@ -1 +1 @@ -DirectoryJSON | memfs

    Interface DirectoryJSON<T>

    interface DirectoryJSON<T> {
        [key: string]: T;
    }

    Type Parameters

    • T extends DirectoryContent = DirectoryContent

    Indexable

    [key: string]: T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +DirectoryJSON | memfs

    Interface DirectoryJSON<T>

    interface DirectoryJSON<T> {
        [key: string]: T;
    }

    Type Parameters

    • T extends DirectoryContent = DirectoryContent

    Indexable

    [key: string]: T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/index.IFs.html b/interfaces/index.IFs.html index 24df62fa0..37ce58fe3 100644 --- a/interfaces/index.IFs.html +++ b/interfaces/index.IFs.html @@ -1,4 +1,4 @@ -IFs | memfs

    Interface IFs

    interface IFs {
        Dirent: (new (...args) => Dirent);
        FSWatcher: (new () => FSWatcher);
        ReadStream: (new (...args) => IReadStream);
        StatWatcher: (new () => StatWatcher);
        Stats: (new (...args) => Stats<TStatNumber>);
        WriteStream: (new (...args) => IWriteStream);
        _toUnixTimestamp: any;
        constants: {
            COPYFILE_EXCL: number;
            COPYFILE_FICLONE: number;
            COPYFILE_FICLONE_FORCE: number;
            F_OK: number;
            O_APPEND: number;
            O_CREAT: number;
            O_DIRECT: number;
            O_DIRECTORY: number;
            O_EXCL: number;
            O_NOATIME: number;
            O_NOCTTY: number;
            O_NOFOLLOW: number;
            O_NONBLOCK: number;
            O_RDONLY: number;
            O_RDWR: number;
            O_SYMLINK: number;
            O_SYNC: number;
            O_TRUNC: number;
            O_WRONLY: number;
            R_OK: number;
            S_IFBLK: number;
            S_IFCHR: number;
            S_IFDIR: number;
            S_IFIFO: number;
            S_IFLNK: number;
            S_IFMT: number;
            S_IFREG: number;
            S_IFSOCK: number;
            S_IRGRP: number;
            S_IROTH: number;
            S_IRUSR: number;
            S_IRWXG: number;
            S_IRWXO: number;
            S_IRWXU: number;
            S_IWGRP: number;
            S_IWOTH: number;
            S_IWUSR: number;
            S_IXGRP: number;
            S_IXOTH: number;
            S_IXUSR: number;
            UV_FS_COPYFILE_EXCL: number;
            UV_FS_COPYFILE_FICLONE: number;
            UV_FS_COPYFILE_FICLONE_FORCE: number;
            UV_FS_SYMLINK_DIR: number;
            UV_FS_SYMLINK_JUNCTION: number;
            W_OK: number;
            X_OK: number;
        };
        cp: {
            (src, dest, callback): any;
            (src, dest, options, callback): any;
        };
        cpSync: ((src, dest, options?) => void);
        fds: {
            [fd: number]: File;
        };
        ino: number;
        inodes: {
            [ino: number]: Node;
        };
        lutimes: ((path, atime, mtime, callback) => void);
        lutimesSync: ((path, atime, time) => void);
        maxFiles: number;
        openAsBlob: ((path, options?) => Promise<Blob>);
        openFiles: number;
        opendir: ((path, options, callback) => void);
        opendirSync: ((path, options?) => IDir);
        promises: FsPromisesApi;
        props: {
            File: (new (...args) => File);
            Link: (new (...args) => Link);
            Node: (new (...args) => Node);
        };
        releasedFds: number[];
        releasedInos: number[];
        root: Link;
        statfs: {
            (path, callback): void;
            (path, options, callback): void;
        };
        statfsSync: ((path, options?) => IStatFs<TStatNumber>);
        access(path, callback): any;
        access(path, mode, callback): any;
        accessSync(path, mode?): void;
        appendFile(id, data, callback): any;
        appendFile(id, data, options, callback): any;
        appendFileSync(id, data, options?): void;
        chmod(path, mode, callback): void;
        chmodSync(path, mode): void;
        chown(path, uid, gid, callback): void;
        chownSync(path, uid, gid): void;
        close(fd, callback): void;
        closeSync(fd): void;
        copyFile(src, dest, callback): any;
        copyFile(src, dest, flags, callback): any;
        copyFileSync(src, dest, flags?): void;
        createLink(): Link;
        createLink(parent, name, isDirectory?, perm?): Link;
        createNode(isDirectory?, perm?): Node;
        createReadStream(path, options?): IReadStream;
        createWriteStream(path, options?): IWriteStream;
        deleteLink(link): boolean;
        exists(path, callback): void;
        existsSync(path): boolean;
        fchmod(fd, mode, callback): void;
        fchmodSync(fd, mode): void;
        fchown(fd, uid, gid, callback): void;
        fchownSync(fd, uid, gid): void;
        fdatasync(fd, callback): void;
        fdatasyncSync(fd): void;
        fromJSON(json, cwd?): void;
        fromNestedJSON(json, cwd?): void;
        fstat(fd, callback): void;
        fstat(fd, options, callback): void;
        fstatSync(fd): Stats<number>;
        fstatSync(fd, options): Stats<number>;
        fstatSync(fd, options): Stats<bigint>;
        fsync(fd, callback): void;
        fsyncSync(fd): void;
        ftruncate(fd, callback): any;
        ftruncate(fd, len, callback): any;
        ftruncateSync(fd, len?): void;
        futimes(fd, atime, mtime, callback): void;
        futimesSync(fd, atime, mtime): void;
        getLink(steps): null | Link;
        getLinkOrThrow(filename, funcName?): Link;
        getResolvedLink(filenameOrSteps): null | Link;
        getResolvedLinkOrThrow(filename, funcName?): Link;
        lchmod(path, mode, callback): void;
        lchmodSync(path, mode): void;
        lchown(path, uid, gid, callback): void;
        lchownSync(path, uid, gid): void;
        link(existingPath, newPath, callback): void;
        linkSync(existingPath, newPath): void;
        lstat(path, callback): void;
        lstat(path, options, callback): void;
        lstatSync(path): Stats<number>;
        lstatSync(path, options): Stats<number>;
        lstatSync(path, options): Stats<number>;
        lstatSync(path, options): Stats<bigint>;
        lstatSync(path, options): undefined | Stats<number>;
        lstatSync(path, options): undefined | Stats<number>;
        lstatSync(path, options): undefined | Stats<bigint>;
        mkdir(path, callback): any;
        mkdir(path, mode, callback): any;
        mkdir(path, mode, callback): any;
        mkdir(path, mode, callback): any;
        mkdirSync(path, options): undefined | string;
        mkdirSync(path, options?): void;
        mkdirSync(path, options?): undefined | string;
        mkdtemp(prefix, callback): any;
        mkdtemp(prefix, options, callback): any;
        mkdtempSync(prefix, options?): TDataOut;
        mountSync(mountpoint, json): void;
        open(path, flags, callback): any;
        open(path, flags, mode, callback): any;
        openSync(path, flags, mode?): number;
        read(fd, buffer, offset, length, position, callback): void;
        readFile(id, callback): any;
        readFile(id, options, callback): any;
        readFileSync(file, options?): TDataOut;
        readSync(fd, buffer, offset, length, position): number;
        readdir(path, callback): any;
        readdir(path, options, callback): any;
        readdirSync(path, options?): TDataOut[] | Dirent[];
        readlink(path, callback): any;
        readlink(path, options, callback): any;
        readlinkSync(path, options?): TDataOut;
        readv(fd, buffers, callback): void;
        readv(fd, buffers, position, callback): void;
        readvSync(fd, buffers, position): number;
        realpath(path, callback): any;
        realpath(path, options, callback): any;
        realpathSync(path, options?): TDataOut;
        rename(oldPath, newPath, callback): void;
        renameSync(oldPath, newPath): void;
        reset(): void;
        resolveSymlinks(link): null | Link;
        rm(path, callback): void;
        rm(path, options, callback): void;
        rmSync(path, options?): void;
        rmdir(path, callback): any;
        rmdir(path, options, callback): any;
        rmdirSync(path, options?): void;
        stat(path, callback): void;
        stat(path, options, callback): void;
        statSync(path): Stats<number>;
        statSync(path, options): Stats<number>;
        statSync(path, options): undefined | Stats<number>;
        statSync(path, options): Stats<number>;
        statSync(path, options): Stats<bigint>;
        statSync(path, options): undefined | Stats<number>;
        statSync(path, options): undefined | Stats<bigint>;
        symlink(target, path, callback): any;
        symlink(target, path, type, callback): any;
        symlinkSync(target, path, type?): void;
        toJSON(paths?, json?, isRelative?, asBuffer?): DirectoryJSON<null | string>;
        toTree(opts?): string;
        truncate(id, callback): any;
        truncate(id, len, callback): any;
        truncateSync(id, len?): void;
        unlink(path, callback): void;
        unlinkSync(path): void;
        unwatchFile(path, listener?): void;
        utimes(path, atime, mtime, callback): void;
        utimesSync(path, atime, mtime): void;
        watch(path, options?, listener?): FSWatcher;
        watchFile(path, listener): StatWatcher;
        watchFile(path, options, listener): StatWatcher;
        write(fd, buffer, callback): any;
        write(fd, buffer, offset, callback): any;
        write(fd, buffer, offset, length, callback): any;
        write(fd, buffer, offset, length, position, callback): any;
        write(fd, str, callback): any;
        write(fd, str, position, callback): any;
        write(fd, str, position, encoding, callback): any;
        writeFile(id, data, callback): any;
        writeFile(id, data, options, callback): any;
        writeFileSync(id, data, options?): void;
        writeSync(fd, buffer, offset?, length?, position?): number;
        writeSync(fd, str, position?, encoding?): number;
        writev(fd, buffers, callback): void;
        writev(fd, buffers, position, callback): void;
        writevSync(fd, buffers, position): number;
    }

    Hierarchy

    • Volume
      • IFs

    Properties

    Dirent +IFs | memfs

    Interface IFs

    interface IFs {
        Dirent: (new (...args) => Dirent);
        FSWatcher: (new () => FSWatcher);
        ReadStream: (new (...args) => IReadStream);
        StatWatcher: (new () => StatWatcher);
        Stats: (new (...args) => Stats<TStatNumber>);
        WriteStream: (new (...args) => IWriteStream);
        _toUnixTimestamp: any;
        constants: {
            COPYFILE_EXCL: number;
            COPYFILE_FICLONE: number;
            COPYFILE_FICLONE_FORCE: number;
            F_OK: number;
            O_APPEND: number;
            O_CREAT: number;
            O_DIRECT: number;
            O_DIRECTORY: number;
            O_EXCL: number;
            O_NOATIME: number;
            O_NOCTTY: number;
            O_NOFOLLOW: number;
            O_NONBLOCK: number;
            O_RDONLY: number;
            O_RDWR: number;
            O_SYMLINK: number;
            O_SYNC: number;
            O_TRUNC: number;
            O_WRONLY: number;
            R_OK: number;
            S_IFBLK: number;
            S_IFCHR: number;
            S_IFDIR: number;
            S_IFIFO: number;
            S_IFLNK: number;
            S_IFMT: number;
            S_IFREG: number;
            S_IFSOCK: number;
            S_IRGRP: number;
            S_IROTH: number;
            S_IRUSR: number;
            S_IRWXG: number;
            S_IRWXO: number;
            S_IRWXU: number;
            S_IWGRP: number;
            S_IWOTH: number;
            S_IWUSR: number;
            S_IXGRP: number;
            S_IXOTH: number;
            S_IXUSR: number;
            UV_FS_COPYFILE_EXCL: number;
            UV_FS_COPYFILE_FICLONE: number;
            UV_FS_COPYFILE_FICLONE_FORCE: number;
            UV_FS_SYMLINK_DIR: number;
            UV_FS_SYMLINK_JUNCTION: number;
            W_OK: number;
            X_OK: number;
        };
        cp: {
            (src, dest, callback): any;
            (src, dest, options, callback): any;
        };
        cpSync: ((src, dest, options?) => void);
        fds: {
            [fd: number]: File;
        };
        ino: number;
        inodes: {
            [ino: number]: Node;
        };
        lutimes: ((path, atime, mtime, callback) => void);
        lutimesSync: ((path, atime, time) => void);
        maxFiles: number;
        openAsBlob: ((path, options?) => Promise<Blob>);
        openFiles: number;
        opendir: ((path, options, callback) => void);
        opendirSync: ((path, options?) => IDir);
        promises: FsPromisesApi;
        props: {
            File: (new (...args) => File);
            Link: (new (...args) => Link);
            Node: (new (...args) => Node);
        };
        releasedFds: number[];
        releasedInos: number[];
        root: Link;
        statfs: {
            (path, callback): void;
            (path, options, callback): void;
        };
        statfsSync: ((path, options?) => IStatFs<TStatNumber>);
        access(path, callback): any;
        access(path, mode, callback): any;
        accessSync(path, mode?): void;
        appendFile(id, data, callback): any;
        appendFile(id, data, options, callback): any;
        appendFileSync(id, data, options?): void;
        chmod(path, mode, callback): void;
        chmodSync(path, mode): void;
        chown(path, uid, gid, callback): void;
        chownSync(path, uid, gid): void;
        close(fd, callback): void;
        closeSync(fd): void;
        copyFile(src, dest, callback): any;
        copyFile(src, dest, flags, callback): any;
        copyFileSync(src, dest, flags?): void;
        createLink(): Link;
        createLink(parent, name, isDirectory?, perm?): Link;
        createNode(isDirectory?, perm?): Node;
        createReadStream(path, options?): IReadStream;
        createWriteStream(path, options?): IWriteStream;
        deleteLink(link): boolean;
        exists(path, callback): void;
        existsSync(path): boolean;
        fchmod(fd, mode, callback): void;
        fchmodSync(fd, mode): void;
        fchown(fd, uid, gid, callback): void;
        fchownSync(fd, uid, gid): void;
        fdatasync(fd, callback): void;
        fdatasyncSync(fd): void;
        fromJSON(json, cwd?): void;
        fromNestedJSON(json, cwd?): void;
        fstat(fd, callback): void;
        fstat(fd, options, callback): void;
        fstatSync(fd): Stats<number>;
        fstatSync(fd, options): Stats<number>;
        fstatSync(fd, options): Stats<bigint>;
        fsync(fd, callback): void;
        fsyncSync(fd): void;
        ftruncate(fd, callback): any;
        ftruncate(fd, len, callback): any;
        ftruncateSync(fd, len?): void;
        futimes(fd, atime, mtime, callback): void;
        futimesSync(fd, atime, mtime): void;
        getLink(steps): null | Link;
        getLinkOrThrow(filename, funcName?): Link;
        getResolvedLink(filenameOrSteps): null | Link;
        getResolvedLinkOrThrow(filename, funcName?): Link;
        lchmod(path, mode, callback): void;
        lchmodSync(path, mode): void;
        lchown(path, uid, gid, callback): void;
        lchownSync(path, uid, gid): void;
        link(existingPath, newPath, callback): void;
        linkSync(existingPath, newPath): void;
        lstat(path, callback): void;
        lstat(path, options, callback): void;
        lstatSync(path): Stats<number>;
        lstatSync(path, options): Stats<number>;
        lstatSync(path, options): Stats<number>;
        lstatSync(path, options): Stats<bigint>;
        lstatSync(path, options): undefined | Stats<number>;
        lstatSync(path, options): undefined | Stats<number>;
        lstatSync(path, options): undefined | Stats<bigint>;
        mkdir(path, callback): any;
        mkdir(path, mode, callback): any;
        mkdir(path, mode, callback): any;
        mkdir(path, mode, callback): any;
        mkdirSync(path, options): undefined | string;
        mkdirSync(path, options?): void;
        mkdirSync(path, options?): undefined | string;
        mkdtemp(prefix, callback): any;
        mkdtemp(prefix, options, callback): any;
        mkdtempSync(prefix, options?): TDataOut;
        mountSync(mountpoint, json): void;
        open(path, flags, callback): any;
        open(path, flags, mode, callback): any;
        openSync(path, flags, mode?): number;
        read(fd, buffer, offset, length, position, callback): void;
        readFile(id, callback): any;
        readFile(id, options, callback): any;
        readFileSync(file, options?): TDataOut;
        readSync(fd, buffer, offset, length, position): number;
        readdir(path, callback): any;
        readdir(path, options, callback): any;
        readdirSync(path, options?): TDataOut[] | Dirent[];
        readlink(path, callback): any;
        readlink(path, options, callback): any;
        readlinkSync(path, options?): TDataOut;
        readv(fd, buffers, callback): void;
        readv(fd, buffers, position, callback): void;
        readvSync(fd, buffers, position): number;
        realpath(path, callback): any;
        realpath(path, options, callback): any;
        realpathSync(path, options?): TDataOut;
        rename(oldPath, newPath, callback): void;
        renameSync(oldPath, newPath): void;
        reset(): void;
        resolveSymlinks(link): null | Link;
        rm(path, callback): void;
        rm(path, options, callback): void;
        rmSync(path, options?): void;
        rmdir(path, callback): any;
        rmdir(path, options, callback): any;
        rmdirSync(path, options?): void;
        stat(path, callback): void;
        stat(path, options, callback): void;
        statSync(path): Stats<number>;
        statSync(path, options): Stats<number>;
        statSync(path, options): undefined | Stats<number>;
        statSync(path, options): Stats<number>;
        statSync(path, options): Stats<bigint>;
        statSync(path, options): undefined | Stats<number>;
        statSync(path, options): undefined | Stats<bigint>;
        symlink(target, path, callback): any;
        symlink(target, path, type, callback): any;
        symlinkSync(target, path, type?): void;
        toJSON(paths?, json?, isRelative?, asBuffer?): DirectoryJSON<null | string>;
        toTree(opts?): string;
        truncate(id, callback): any;
        truncate(id, len, callback): any;
        truncateSync(id, len?): void;
        unlink(path, callback): void;
        unlinkSync(path): void;
        unwatchFile(path, listener?): void;
        utimes(path, atime, mtime, callback): void;
        utimesSync(path, atime, mtime): void;
        watch(path, options?, listener?): FSWatcher;
        watchFile(path, listener): StatWatcher;
        watchFile(path, options, listener): StatWatcher;
        write(fd, buffer, callback): any;
        write(fd, buffer, offset, callback): any;
        write(fd, buffer, offset, length, callback): any;
        write(fd, buffer, offset, length, position, callback): any;
        write(fd, str, callback): any;
        write(fd, str, position, callback): any;
        write(fd, str, position, encoding, callback): any;
        writeFile(id, data, callback): any;
        writeFile(id, data, options, callback): any;
        writeFileSync(id, data, options?): void;
        writeSync(fd, buffer, offset?, length?, position?): number;
        writeSync(fd, str, position?, encoding?): number;
        writev(fd, buffers, callback): void;
        writev(fd, buffers, position, callback): void;
        writevSync(fd, buffers, position): number;
    }

    Hierarchy

    • Volume
      • IFs

    Properties

    Dirent FSWatcher ReadStream StatWatcher @@ -120,6 +120,6 @@ writeSync writev writevSync -

    Properties

    Dirent

    Dirent: (new (...args) => Dirent)

    Type declaration

      • new (...args): Dirent

      • Parameters

        • Rest ...args: any[]

        Returns Dirent

    FSWatcher

    FSWatcher: (new () => FSWatcher)

    Type declaration

      • new (): FSWatcher

      • Returns FSWatcher

    ReadStream

    ReadStream: (new (...args) => IReadStream)

    Type declaration

      • new (...args): IReadStream

      • Parameters

        • Rest ...args: any[]

        Returns IReadStream

    StatWatcher

    StatWatcher: (new () => StatWatcher)

    Type declaration

      • new (): StatWatcher

      • Returns StatWatcher

    Stats

    Stats: (new (...args) => Stats<TStatNumber>)

    Type declaration

      • new (...args): Stats<TStatNumber>

      • Parameters

        • Rest ...args: any[]

        Returns Stats<TStatNumber>

    WriteStream

    WriteStream: (new (...args) => IWriteStream)

    Type declaration

      • new (...args): IWriteStream

      • Parameters

        • Rest ...args: any[]

        Returns IWriteStream

    _toUnixTimestamp

    _toUnixTimestamp: any

    constants

    constants: {
        COPYFILE_EXCL: number;
        COPYFILE_FICLONE: number;
        COPYFILE_FICLONE_FORCE: number;
        F_OK: number;
        O_APPEND: number;
        O_CREAT: number;
        O_DIRECT: number;
        O_DIRECTORY: number;
        O_EXCL: number;
        O_NOATIME: number;
        O_NOCTTY: number;
        O_NOFOLLOW: number;
        O_NONBLOCK: number;
        O_RDONLY: number;
        O_RDWR: number;
        O_SYMLINK: number;
        O_SYNC: number;
        O_TRUNC: number;
        O_WRONLY: number;
        R_OK: number;
        S_IFBLK: number;
        S_IFCHR: number;
        S_IFDIR: number;
        S_IFIFO: number;
        S_IFLNK: number;
        S_IFMT: number;
        S_IFREG: number;
        S_IFSOCK: number;
        S_IRGRP: number;
        S_IROTH: number;
        S_IRUSR: number;
        S_IRWXG: number;
        S_IRWXO: number;
        S_IRWXU: number;
        S_IWGRP: number;
        S_IWOTH: number;
        S_IWUSR: number;
        S_IXGRP: number;
        S_IXOTH: number;
        S_IXUSR: number;
        UV_FS_COPYFILE_EXCL: number;
        UV_FS_COPYFILE_FICLONE: number;
        UV_FS_COPYFILE_FICLONE_FORCE: number;
        UV_FS_SYMLINK_DIR: number;
        UV_FS_SYMLINK_JUNCTION: number;
        W_OK: number;
        X_OK: number;
    }

    Type declaration

    • COPYFILE_EXCL: number
    • COPYFILE_FICLONE: number
    • COPYFILE_FICLONE_FORCE: number
    • F_OK: number
    • O_APPEND: number
    • O_CREAT: number
    • O_DIRECT: number
    • O_DIRECTORY: number
    • O_EXCL: number
    • O_NOATIME: number
    • O_NOCTTY: number
    • O_NOFOLLOW: number
    • O_NONBLOCK: number
    • O_RDONLY: number
    • O_RDWR: number
    • O_SYMLINK: number
    • O_SYNC: number
    • O_TRUNC: number
    • O_WRONLY: number
    • R_OK: number
    • S_IFBLK: number
    • S_IFCHR: number
    • S_IFDIR: number
    • S_IFIFO: number
    • S_IFLNK: number
    • S_IFMT: number
    • S_IFREG: number
    • S_IFSOCK: number
    • S_IRGRP: number
    • S_IROTH: number
    • S_IRUSR: number
    • S_IRWXG: number
    • S_IRWXO: number
    • S_IRWXU: number
    • S_IWGRP: number
    • S_IWOTH: number
    • S_IWUSR: number
    • S_IXGRP: number
    • S_IXOTH: number
    • S_IXUSR: number
    • UV_FS_COPYFILE_EXCL: number
    • UV_FS_COPYFILE_FICLONE: number
    • UV_FS_COPYFILE_FICLONE_FORCE: number
    • UV_FS_SYMLINK_DIR: number
    • UV_FS_SYMLINK_JUNCTION: number
    • W_OK: number
    • X_OK: number

    cp

    cp: {
        (src, dest, callback): any;
        (src, dest, options, callback): any;
    } = notImplemented

    Type declaration

      • (src, dest, callback): any

      • Parameters

        • src: string | URL
        • dest: string | URL
        • callback: TCallback<void>

        Returns any

      • (src, dest, options, callback): any

      • Parameters

        • src: string | URL
        • dest: string | URL
        • options: ICpOptions
        • callback: TCallback<void>

        Returns any

    cpSync

    cpSync: ((src, dest, options?) => void) = notImplemented

    Type declaration

      • (src, dest, options?): void

      • Parameters

        • src: string | URL
        • dest: string | URL
        • Optional options: ICpOptions

        Returns void

    fds

    fds: {
        [fd: number]: File;
    } = {}

    Type declaration

    • [fd: number]: File

    ino

    ino: number = 0

    inodes

    inodes: {
        [ino: number]: Node;
    } = {}

    Type declaration

    • [ino: number]: Node

    lutimes

    lutimes: ((path, atime, mtime, callback) => void) = notImplemented

    Type declaration

      • (path, atime, mtime, callback): void

      • Parameters

        • path: PathLike
        • atime: string | number | Date
        • mtime: string | number | Date
        • callback: TCallback<void>

        Returns void

    lutimesSync

    lutimesSync: ((path, atime, time) => void) = notImplemented

    Type declaration

      • (path, atime, time): void

      • Parameters

        • path: PathLike
        • atime: string | number | Date
        • time: string | number | Date

        Returns void

    maxFiles

    maxFiles: number = 10000

    openAsBlob

    openAsBlob: ((path, options?) => Promise<Blob>) = notImplemented

    Type declaration

      • (path, options?): Promise<Blob>

      • Parameters

        • path: PathLike
        • Optional options: IOpenAsBlobOptions

        Returns Promise<Blob>

    openFiles

    openFiles: number = 0

    opendir

    opendir: ((path, options, callback) => void) = notImplemented

    Type declaration

      • (path, options, callback): void

      • Parameters

        • path: PathLike
        • options: IOpendirOptions
        • callback: TCallback<IDir>

        Returns void

    opendirSync

    opendirSync: ((path, options?) => IDir) = notImplemented

    Type declaration

      • (path, options?): IDir

      • Parameters

        • path: PathLike
        • Optional options: IOpendirOptions

        Returns IDir

    promises

    promises: FsPromisesApi

    props

    props: {
        File: (new (...args) => File);
        Link: (new (...args) => Link);
        Node: (new (...args) => Node);
    }

    Type declaration

    • File: (new (...args) => File)
        • new (...args): File

        • Parameters

          • Rest ...args: any[]

          Returns File

    • Link: (new (...args) => Link)
        • new (...args): Link

        • Parameters

          • Rest ...args: any[]

          Returns Link

    • Node: (new (...args) => Node)
        • new (...args): Node

        • Parameters

          • Rest ...args: any[]

          Returns Node

    releasedFds

    releasedFds: number[] = []

    releasedInos

    releasedInos: number[] = []

    root

    root: Link

    statfs

    statfs: {
        (path, callback): void;
        (path, options, callback): void;
    } = notImplemented

    Type declaration

      • (path, callback): void

      • Parameters

        • path: PathLike
        • callback: TCallback<IStatFs<TStatNumber>>

        Returns void

      • (path, options, callback): void

      • Parameters

        • path: PathLike
        • options: IStatOptions
        • callback: TCallback<IStatFs<TStatNumber>>

        Returns void

    statfsSync

    statfsSync: ((path, options?) => IStatFs<TStatNumber>) = notImplemented

    Type declaration

      • (path, options?): IStatFs<TStatNumber>

      • Parameters

        • path: PathLike
        • Optional options: IStafsOptions

        Returns IStatFs<TStatNumber>

    Methods

    access

    accessSync

    appendFile

    • appendFile(id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • appendFile(id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IAppendFileOptions
      • callback: TCallback<void>

      Returns any

    appendFileSync

    • appendFileSync(id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: string | IAppendFileOptions

      Returns void

    chmod

    • chmod(path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

    chmodSync

    chown

    • chown(path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

    chownSync

    close

    closeSync

    copyFile

    • copyFile(src, dest, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • callback: TCallback<void>

      Returns any

    • copyFile(src, dest, flags, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • flags: number
      • callback: TCallback<void>

      Returns any

    copyFileSync

    • copyFileSync(src, dest, flags?): void

    • Parameters

      • src: PathLike
      • dest: PathLike
      • Optional flags: number

      Returns void

    createLink

    createNode

    • createNode(isDirectory?, perm?): Node

    • Parameters

      • isDirectory: boolean = false
      • Optional perm: number

      Returns Node

    createReadStream

    • createReadStream(path, options?): IReadStream

    • Parameters

      • path: PathLike
      • Optional options: string | IReadStreamOptions

      Returns IReadStream

    createWriteStream

    • createWriteStream(path, options?): IWriteStream

    • Parameters

      • path: PathLike
      • Optional options: string | IWriteStreamOptions

      Returns IWriteStream

    deleteLink

    exists

    • exists(path, callback): void

    • Parameters

      • path: PathLike
      • callback: ((exists) => void)
          • (exists): void

          • Parameters

            • exists: boolean

            Returns void

      Returns void

    existsSync

    fchmod

    • fchmod(fd, mode, callback): void

    • Parameters

      • fd: number
      • mode: TMode
      • callback: TCallback<void>

      Returns void

    fchmodSync

    fchown

    • fchown(fd, uid, gid, callback): void

    • Parameters

      • fd: number
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

    fchownSync

    fdatasync

    fdatasyncSync

    fromJSON

    fromNestedJSON

    fstat

    • fstat(fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    • fstat(fd, options, callback): void

    • Parameters

      • fd: number
      • options: IFStatOptions
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    fstatSync

    • fstatSync(fd): Stats<number>

    • Parameters

      • fd: number

      Returns Stats<number>

    • fstatSync(fd, options): Stats<number>

    • Parameters

      • fd: number
      • options: {
            bigint: false;
        }
        • bigint: false

      Returns Stats<number>

    • fstatSync(fd, options): Stats<bigint>

    • Parameters

      • fd: number
      • options: {
            bigint: true;
        }
        • bigint: true

      Returns Stats<bigint>

    fsync

    fsyncSync

    ftruncate

    ftruncateSync

    futimes

    • futimes(fd, atime, mtime, callback): void

    • Parameters

      • fd: number
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

    futimesSync

    getLink

    getLinkOrThrow

    • getLinkOrThrow(filename, funcName?): Link

    • Parameters

      • filename: string
      • Optional funcName: string

      Returns Link

    getResolvedLink

    • getResolvedLink(filenameOrSteps): null | Link

    • Parameters

      • filenameOrSteps: string | string[]

      Returns null | Link

    getResolvedLinkOrThrow

    • getResolvedLinkOrThrow(filename, funcName?): Link

    • Parameters

      • filename: string
      • Optional funcName: string

      Returns Link

    lchmod

    • lchmod(path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

    lchmodSync

    lchown

    • lchown(path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

    lchownSync

    link

    • link(existingPath, newPath, callback): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

    linkSync

    • linkSync(existingPath, newPath): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike

      Returns void

    lstat

    • lstat(path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    • lstat(path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    lstatSync

    • lstatSync(path): Stats<number>

    • Parameters

      • path: PathLike

      Returns Stats<number>

    • lstatSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • lstatSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • lstatSync(path, options): Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns Stats<bigint>

    • lstatSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • lstatSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • lstatSync(path, options): undefined | Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | Stats<bigint>

    mkdir

    • mkdir(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • mkdir(path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: TMode | IMkdirOptions & {
            recursive?: false;
        }
      • callback: TCallback<void>

      Returns any

    • mkdir(path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: IMkdirOptions & {
            recursive: true;
        }
      • callback: TCallback<string>

      Returns any

    • mkdir(path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: IMkdirOptions | TMode
      • callback: TCallback<string>

      Returns any

    mkdirSync

    • mkdirSync(path, options): undefined | string

    • Parameters

      • path: PathLike
      • options: IMkdirOptions & {
            recursive: true;
        }

      Returns undefined | string

    • mkdirSync(path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: TMode | IMkdirOptions & {
            recursive?: false;
        }

      Returns void

    • mkdirSync(path, options?): undefined | string

    • Parameters

      • path: PathLike
      • Optional options: IMkdirOptions | TMode

      Returns undefined | string

    mkdtemp

    • mkdtemp(prefix, callback): any

    • Parameters

      • prefix: string
      • callback: TCallback<string>

      Returns any

    • mkdtemp(prefix, options, callback): any

    • Parameters

      • prefix: string
      • options: IOptions
      • callback: TCallback<string>

      Returns any

    mkdtempSync

    • mkdtempSync(prefix, options?): TDataOut

    • Parameters

      • prefix: string
      • Optional options: IOptions

      Returns TDataOut

    mountSync

    open

    • open(path, flags, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • callback: TCallback<number>

      Returns any

    • open(path, flags, mode, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • mode: TMode
      • callback: TCallback<number>

      Returns any

    openSync

    • openSync(path, flags, mode?): number

    • Parameters

      • path: PathLike
      • flags: TFlags
      • mode: TMode = MODE.DEFAULT

      Returns number

    read

    • read(fd, buffer, offset, length, position, callback): void

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: null | number
      • callback: ((err?, bytesRead?, buffer?) => void)
          • (err?, bytesRead?, buffer?): void

          • Parameters

            • Optional err: null | Error
            • Optional bytesRead: number
            • Optional buffer: Buffer | ArrayBufferView | DataView

            Returns void

      Returns void

    readFile

    • readFile(id, callback): any

    • Parameters

      • id: TFileId
      • callback: TCallback<TDataOut>

      Returns any

    • readFile(id, options, callback): any

    • Parameters

      • id: TFileId
      • options: string | IReadFileOptions
      • callback: TCallback<TDataOut>

      Returns any

    readFileSync

    • readFileSync(file, options?): TDataOut

    • Parameters

      • file: TFileId
      • Optional options: string | IReadFileOptions

      Returns TDataOut

    readSync

    • readSync(fd, buffer, offset, length, position): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: null | number

      Returns number

    readdir

    • readdir(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut[] | Dirent[]>

      Returns any

    • readdir(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IReaddirOptions
      • callback: TCallback<TDataOut[] | Dirent[]>

      Returns any

    readdirSync

    • readdirSync(path, options?): TDataOut[] | Dirent[]

    • Parameters

      • path: PathLike
      • Optional options: string | IReaddirOptions

      Returns TDataOut[] | Dirent[]

    readlink

    • readlink(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • readlink(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IOptions
      • callback: TCallback<TDataOut>

      Returns any

    readlinkSync

    • readlinkSync(path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: IOptions

      Returns TDataOut

    readv

    • readv(fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

    • readv(fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

    readvSync

    • readvSync(fd, buffers, position): number

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number

      Returns number

    realpath

    • realpath(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • realpath(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IRealpathOptions
      • callback: TCallback<TDataOut>

      Returns any

    realpathSync

    • realpathSync(path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: string | IRealpathOptions

      Returns TDataOut

    rename

    • rename(oldPath, newPath, callback): void

    • Parameters

      • oldPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

    renameSync

    reset

    resolveSymlinks

    rm

    rmSync

    rmdir

    • rmdir(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • rmdir(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IRmdirOptions
      • callback: TCallback<void>

      Returns any

    rmdirSync

    • rmdirSync(path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: IRmdirOptions

      Returns void

    stat

    • stat(path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    • stat(path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    statSync

    • statSync(path): Stats<number>

    • Parameters

      • path: PathLike

      Returns Stats<number>

    • statSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • statSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • statSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • statSync(path, options): Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns Stats<bigint>

    • statSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • statSync(path, options): undefined | Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | Stats<bigint>

    symlink

    • symlink(target, path, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • symlink(target, path, type, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • type: Type
      • callback: TCallback<void>

      Returns any

    symlinkSync

    • symlinkSync(target, path, type?): void

    • Parameters

      • target: PathLike
      • path: PathLike
      • Optional type: Type

      Returns void

    toJSON

    toTree

    truncate

    truncateSync

    • truncateSync(id, len?): void

    • id should be a file descriptor or a path. id as file descriptor will +

    Properties

    Dirent

    Dirent: (new (...args) => Dirent)

    Type declaration

      • new (...args): Dirent

      • Parameters

        • Rest ...args: any[]

        Returns Dirent

    FSWatcher

    FSWatcher: (new () => FSWatcher)

    Type declaration

      • new (): FSWatcher

      • Returns FSWatcher

    ReadStream

    ReadStream: (new (...args) => IReadStream)

    Type declaration

      • new (...args): IReadStream

      • Parameters

        • Rest ...args: any[]

        Returns IReadStream

    StatWatcher

    StatWatcher: (new () => StatWatcher)

    Type declaration

      • new (): StatWatcher

      • Returns StatWatcher

    Stats

    Stats: (new (...args) => Stats<TStatNumber>)

    Type declaration

      • new (...args): Stats<TStatNumber>

      • Parameters

        • Rest ...args: any[]

        Returns Stats<TStatNumber>

    WriteStream

    WriteStream: (new (...args) => IWriteStream)

    Type declaration

      • new (...args): IWriteStream

      • Parameters

        • Rest ...args: any[]

        Returns IWriteStream

    _toUnixTimestamp

    _toUnixTimestamp: any

    constants

    constants: {
        COPYFILE_EXCL: number;
        COPYFILE_FICLONE: number;
        COPYFILE_FICLONE_FORCE: number;
        F_OK: number;
        O_APPEND: number;
        O_CREAT: number;
        O_DIRECT: number;
        O_DIRECTORY: number;
        O_EXCL: number;
        O_NOATIME: number;
        O_NOCTTY: number;
        O_NOFOLLOW: number;
        O_NONBLOCK: number;
        O_RDONLY: number;
        O_RDWR: number;
        O_SYMLINK: number;
        O_SYNC: number;
        O_TRUNC: number;
        O_WRONLY: number;
        R_OK: number;
        S_IFBLK: number;
        S_IFCHR: number;
        S_IFDIR: number;
        S_IFIFO: number;
        S_IFLNK: number;
        S_IFMT: number;
        S_IFREG: number;
        S_IFSOCK: number;
        S_IRGRP: number;
        S_IROTH: number;
        S_IRUSR: number;
        S_IRWXG: number;
        S_IRWXO: number;
        S_IRWXU: number;
        S_IWGRP: number;
        S_IWOTH: number;
        S_IWUSR: number;
        S_IXGRP: number;
        S_IXOTH: number;
        S_IXUSR: number;
        UV_FS_COPYFILE_EXCL: number;
        UV_FS_COPYFILE_FICLONE: number;
        UV_FS_COPYFILE_FICLONE_FORCE: number;
        UV_FS_SYMLINK_DIR: number;
        UV_FS_SYMLINK_JUNCTION: number;
        W_OK: number;
        X_OK: number;
    }

    Type declaration

    • COPYFILE_EXCL: number
    • COPYFILE_FICLONE: number
    • COPYFILE_FICLONE_FORCE: number
    • F_OK: number
    • O_APPEND: number
    • O_CREAT: number
    • O_DIRECT: number
    • O_DIRECTORY: number
    • O_EXCL: number
    • O_NOATIME: number
    • O_NOCTTY: number
    • O_NOFOLLOW: number
    • O_NONBLOCK: number
    • O_RDONLY: number
    • O_RDWR: number
    • O_SYMLINK: number
    • O_SYNC: number
    • O_TRUNC: number
    • O_WRONLY: number
    • R_OK: number
    • S_IFBLK: number
    • S_IFCHR: number
    • S_IFDIR: number
    • S_IFIFO: number
    • S_IFLNK: number
    • S_IFMT: number
    • S_IFREG: number
    • S_IFSOCK: number
    • S_IRGRP: number
    • S_IROTH: number
    • S_IRUSR: number
    • S_IRWXG: number
    • S_IRWXO: number
    • S_IRWXU: number
    • S_IWGRP: number
    • S_IWOTH: number
    • S_IWUSR: number
    • S_IXGRP: number
    • S_IXOTH: number
    • S_IXUSR: number
    • UV_FS_COPYFILE_EXCL: number
    • UV_FS_COPYFILE_FICLONE: number
    • UV_FS_COPYFILE_FICLONE_FORCE: number
    • UV_FS_SYMLINK_DIR: number
    • UV_FS_SYMLINK_JUNCTION: number
    • W_OK: number
    • X_OK: number

    cp

    cp: {
        (src, dest, callback): any;
        (src, dest, options, callback): any;
    } = notImplemented

    Type declaration

      • (src, dest, callback): any

      • Parameters

        • src: string | URL
        • dest: string | URL
        • callback: TCallback<void>

        Returns any

      • (src, dest, options, callback): any

      • Parameters

        • src: string | URL
        • dest: string | URL
        • options: ICpOptions
        • callback: TCallback<void>

        Returns any

    cpSync

    cpSync: ((src, dest, options?) => void) = notImplemented

    Type declaration

      • (src, dest, options?): void

      • Parameters

        • src: string | URL
        • dest: string | URL
        • Optional options: ICpOptions

        Returns void

    fds

    fds: {
        [fd: number]: File;
    } = {}

    Type declaration

    • [fd: number]: File

    ino

    ino: number = 0

    inodes

    inodes: {
        [ino: number]: Node;
    } = {}

    Type declaration

    • [ino: number]: Node

    lutimes

    lutimes: ((path, atime, mtime, callback) => void) = notImplemented

    Type declaration

      • (path, atime, mtime, callback): void

      • Parameters

        • path: PathLike
        • atime: string | number | Date
        • mtime: string | number | Date
        • callback: TCallback<void>

        Returns void

    lutimesSync

    lutimesSync: ((path, atime, time) => void) = notImplemented

    Type declaration

      • (path, atime, time): void

      • Parameters

        • path: PathLike
        • atime: string | number | Date
        • time: string | number | Date

        Returns void

    maxFiles

    maxFiles: number = 10000

    openAsBlob

    openAsBlob: ((path, options?) => Promise<Blob>) = notImplemented

    Type declaration

      • (path, options?): Promise<Blob>

      • Parameters

        • path: PathLike
        • Optional options: IOpenAsBlobOptions

        Returns Promise<Blob>

    openFiles

    openFiles: number = 0

    opendir

    opendir: ((path, options, callback) => void) = notImplemented

    Type declaration

      • (path, options, callback): void

      • Parameters

        • path: PathLike
        • options: IOpendirOptions
        • callback: TCallback<IDir>

        Returns void

    opendirSync

    opendirSync: ((path, options?) => IDir) = notImplemented

    Type declaration

      • (path, options?): IDir

      • Parameters

        • path: PathLike
        • Optional options: IOpendirOptions

        Returns IDir

    promises

    promises: FsPromisesApi

    props

    props: {
        File: (new (...args) => File);
        Link: (new (...args) => Link);
        Node: (new (...args) => Node);
    }

    Type declaration

    • File: (new (...args) => File)
        • new (...args): File

        • Parameters

          • Rest ...args: any[]

          Returns File

    • Link: (new (...args) => Link)
        • new (...args): Link

        • Parameters

          • Rest ...args: any[]

          Returns Link

    • Node: (new (...args) => Node)
        • new (...args): Node

        • Parameters

          • Rest ...args: any[]

          Returns Node

    releasedFds

    releasedFds: number[] = []

    releasedInos

    releasedInos: number[] = []

    root

    root: Link

    statfs

    statfs: {
        (path, callback): void;
        (path, options, callback): void;
    } = notImplemented

    Type declaration

      • (path, callback): void

      • Parameters

        • path: PathLike
        • callback: TCallback<IStatFs<TStatNumber>>

        Returns void

      • (path, options, callback): void

      • Parameters

        • path: PathLike
        • options: IStatOptions
        • callback: TCallback<IStatFs<TStatNumber>>

        Returns void

    statfsSync

    statfsSync: ((path, options?) => IStatFs<TStatNumber>) = notImplemented

    Type declaration

      • (path, options?): IStatFs<TStatNumber>

      • Parameters

        • path: PathLike
        • Optional options: IStafsOptions

        Returns IStatFs<TStatNumber>

    Methods

    access

    accessSync

    appendFile

    • appendFile(id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • appendFile(id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IAppendFileOptions
      • callback: TCallback<void>

      Returns any

    appendFileSync

    • appendFileSync(id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: string | IAppendFileOptions

      Returns void

    chmod

    • chmod(path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

    chmodSync

    chown

    • chown(path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

    chownSync

    close

    closeSync

    copyFile

    • copyFile(src, dest, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • callback: TCallback<void>

      Returns any

    • copyFile(src, dest, flags, callback): any

    • Parameters

      • src: PathLike
      • dest: PathLike
      • flags: number
      • callback: TCallback<void>

      Returns any

    copyFileSync

    • copyFileSync(src, dest, flags?): void

    • Parameters

      • src: PathLike
      • dest: PathLike
      • Optional flags: number

      Returns void

    createLink

    createNode

    • createNode(isDirectory?, perm?): Node

    • Parameters

      • isDirectory: boolean = false
      • Optional perm: number

      Returns Node

    createReadStream

    • createReadStream(path, options?): IReadStream

    • Parameters

      • path: PathLike
      • Optional options: string | IReadStreamOptions

      Returns IReadStream

    createWriteStream

    • createWriteStream(path, options?): IWriteStream

    • Parameters

      • path: PathLike
      • Optional options: string | IWriteStreamOptions

      Returns IWriteStream

    deleteLink

    exists

    • exists(path, callback): void

    • Parameters

      • path: PathLike
      • callback: ((exists) => void)
          • (exists): void

          • Parameters

            • exists: boolean

            Returns void

      Returns void

    existsSync

    fchmod

    • fchmod(fd, mode, callback): void

    • Parameters

      • fd: number
      • mode: TMode
      • callback: TCallback<void>

      Returns void

    fchmodSync

    fchown

    • fchown(fd, uid, gid, callback): void

    • Parameters

      • fd: number
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

    fchownSync

    fdatasync

    fdatasyncSync

    fromJSON

    fromNestedJSON

    fstat

    • fstat(fd, callback): void

    • Parameters

      • fd: number
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    • fstat(fd, options, callback): void

    • Parameters

      • fd: number
      • options: IFStatOptions
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    fstatSync

    • fstatSync(fd): Stats<number>

    • Parameters

      • fd: number

      Returns Stats<number>

    • fstatSync(fd, options): Stats<number>

    • Parameters

      • fd: number
      • options: {
            bigint: false;
        }
        • bigint: false

      Returns Stats<number>

    • fstatSync(fd, options): Stats<bigint>

    • Parameters

      • fd: number
      • options: {
            bigint: true;
        }
        • bigint: true

      Returns Stats<bigint>

    fsync

    fsyncSync

    ftruncate

    ftruncateSync

    futimes

    • futimes(fd, atime, mtime, callback): void

    • Parameters

      • fd: number
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

    futimesSync

    getLink

    getLinkOrThrow

    • getLinkOrThrow(filename, funcName?): Link

    • Parameters

      • filename: string
      • Optional funcName: string

      Returns Link

    getResolvedLink

    • getResolvedLink(filenameOrSteps): null | Link

    • Parameters

      • filenameOrSteps: string | string[]

      Returns null | Link

    getResolvedLinkOrThrow

    • getResolvedLinkOrThrow(filename, funcName?): Link

    • Parameters

      • filename: string
      • Optional funcName: string

      Returns Link

    lchmod

    • lchmod(path, mode, callback): void

    • Parameters

      • path: PathLike
      • mode: TMode
      • callback: TCallback<void>

      Returns void

    lchmodSync

    lchown

    • lchown(path, uid, gid, callback): void

    • Parameters

      • path: PathLike
      • uid: number
      • gid: number
      • callback: TCallback<void>

      Returns void

    lchownSync

    link

    • link(existingPath, newPath, callback): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

    linkSync

    • linkSync(existingPath, newPath): void

    • Parameters

      • existingPath: PathLike
      • newPath: PathLike

      Returns void

    lstat

    • lstat(path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    • lstat(path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    lstatSync

    • lstatSync(path): Stats<number>

    • Parameters

      • path: PathLike

      Returns Stats<number>

    • lstatSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • lstatSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • lstatSync(path, options): Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns Stats<bigint>

    • lstatSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • lstatSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • lstatSync(path, options): undefined | Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | Stats<bigint>

    mkdir

    • mkdir(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • mkdir(path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: TMode | IMkdirOptions & {
            recursive?: false;
        }
      • callback: TCallback<void>

      Returns any

    • mkdir(path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: IMkdirOptions & {
            recursive: true;
        }
      • callback: TCallback<string>

      Returns any

    • mkdir(path, mode, callback): any

    • Parameters

      • path: PathLike
      • mode: IMkdirOptions | TMode
      • callback: TCallback<string>

      Returns any

    mkdirSync

    • mkdirSync(path, options): undefined | string

    • Parameters

      • path: PathLike
      • options: IMkdirOptions & {
            recursive: true;
        }

      Returns undefined | string

    • mkdirSync(path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: TMode | IMkdirOptions & {
            recursive?: false;
        }

      Returns void

    • mkdirSync(path, options?): undefined | string

    • Parameters

      • path: PathLike
      • Optional options: IMkdirOptions | TMode

      Returns undefined | string

    mkdtemp

    • mkdtemp(prefix, callback): any

    • Parameters

      • prefix: string
      • callback: TCallback<string>

      Returns any

    • mkdtemp(prefix, options, callback): any

    • Parameters

      • prefix: string
      • options: IOptions
      • callback: TCallback<string>

      Returns any

    mkdtempSync

    • mkdtempSync(prefix, options?): TDataOut

    • Parameters

      • prefix: string
      • Optional options: IOptions

      Returns TDataOut

    mountSync

    open

    • open(path, flags, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • callback: TCallback<number>

      Returns any

    • open(path, flags, mode, callback): any

    • Parameters

      • path: PathLike
      • flags: TFlags
      • mode: TMode
      • callback: TCallback<number>

      Returns any

    openSync

    • openSync(path, flags, mode?): number

    • Parameters

      • path: PathLike
      • flags: TFlags
      • mode: TMode = MODE.DEFAULT

      Returns number

    read

    • read(fd, buffer, offset, length, position, callback): void

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: null | number
      • callback: ((err?, bytesRead?, buffer?) => void)
          • (err?, bytesRead?, buffer?): void

          • Parameters

            • Optional err: null | Error
            • Optional bytesRead: number
            • Optional buffer: Buffer | ArrayBufferView | DataView

            Returns void

      Returns void

    readFile

    • readFile(id, callback): any

    • Parameters

      • id: TFileId
      • callback: TCallback<TDataOut>

      Returns any

    • readFile(id, options, callback): any

    • Parameters

      • id: TFileId
      • options: string | IReadFileOptions
      • callback: TCallback<TDataOut>

      Returns any

    readFileSync

    • readFileSync(file, options?): TDataOut

    • Parameters

      • file: TFileId
      • Optional options: string | IReadFileOptions

      Returns TDataOut

    readSync

    • readSync(fd, buffer, offset, length, position): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: null | number

      Returns number

    readdir

    • readdir(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut[] | Dirent[]>

      Returns any

    • readdir(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IReaddirOptions
      • callback: TCallback<TDataOut[] | Dirent[]>

      Returns any

    readdirSync

    • readdirSync(path, options?): TDataOut[] | Dirent[]

    • Parameters

      • path: PathLike
      • Optional options: string | IReaddirOptions

      Returns TDataOut[] | Dirent[]

    readlink

    • readlink(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • readlink(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IOptions
      • callback: TCallback<TDataOut>

      Returns any

    readlinkSync

    • readlinkSync(path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: IOptions

      Returns TDataOut

    readv

    • readv(fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

    • readv(fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: TCallback2<number, ArrayBufferView[]>

      Returns void

    readvSync

    • readvSync(fd, buffers, position): number

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number

      Returns number

    realpath

    • realpath(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<TDataOut>

      Returns any

    • realpath(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: string | IRealpathOptions
      • callback: TCallback<TDataOut>

      Returns any

    realpathSync

    • realpathSync(path, options?): TDataOut

    • Parameters

      • path: PathLike
      • Optional options: string | IRealpathOptions

      Returns TDataOut

    rename

    • rename(oldPath, newPath, callback): void

    • Parameters

      • oldPath: PathLike
      • newPath: PathLike
      • callback: TCallback<void>

      Returns void

    renameSync

    reset

    resolveSymlinks

    rm

    rmSync

    rmdir

    • rmdir(path, callback): any

    • Parameters

      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • rmdir(path, options, callback): any

    • Parameters

      • path: PathLike
      • options: IRmdirOptions
      • callback: TCallback<void>

      Returns any

    rmdirSync

    • rmdirSync(path, options?): void

    • Parameters

      • path: PathLike
      • Optional options: IRmdirOptions

      Returns void

    stat

    • stat(path, callback): void

    • Parameters

      • path: PathLike
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    • stat(path, options, callback): void

    • Parameters

      • path: PathLike
      • options: IStatOptions
      • callback: TCallback<Stats<TStatNumber>>

      Returns void

    statSync

    • statSync(path): Stats<number>

    • Parameters

      • path: PathLike

      Returns Stats<number>

    • statSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry?: true;
        }
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • statSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            throwIfNoEntry: false;
        }
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • statSync(path, options): Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry?: true;
        }
        • bigint: false
        • Optional throwIfNoEntry?: true

      Returns Stats<number>

    • statSync(path, options): Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry?: true;
        }
        • bigint: true
        • Optional throwIfNoEntry?: true

      Returns Stats<bigint>

    • statSync(path, options): undefined | Stats<number>

    • Parameters

      • path: PathLike
      • options: {
            bigint: false;
            throwIfNoEntry: false;
        }
        • bigint: false
        • throwIfNoEntry: false

      Returns undefined | Stats<number>

    • statSync(path, options): undefined | Stats<bigint>

    • Parameters

      • path: PathLike
      • options: {
            bigint: true;
            throwIfNoEntry: false;
        }
        • bigint: true
        • throwIfNoEntry: false

      Returns undefined | Stats<bigint>

    symlink

    • symlink(target, path, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • callback: TCallback<void>

      Returns any

    • symlink(target, path, type, callback): any

    • Parameters

      • target: PathLike
      • path: PathLike
      • type: Type
      • callback: TCallback<void>

      Returns any

    symlinkSync

    • symlinkSync(target, path, type?): void

    • Parameters

      • target: PathLike
      • path: PathLike
      • Optional type: Type

      Returns void

    toJSON

    toTree

    truncate

    truncateSync

    • truncateSync(id, len?): void

    • id should be a file descriptor or a path. id as file descriptor will not be supported soon.

      -

      Parameters

      • id: TFileId
      • Optional len: number

      Returns void

    unlink

    unlinkSync

    unwatchFile

    • unwatchFile(path, listener?): void

    • Parameters

      • path: PathLike
      • Optional listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: Stats<TStatNumber>
            • prev: Stats<TStatNumber>

            Returns void

      Returns void

    utimes

    • utimes(path, atime, mtime, callback): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

    utimesSync

    • utimesSync(path, atime, mtime): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime

      Returns void

    watch

    • watch(path, options?, listener?): FSWatcher

    • Parameters

      • path: PathLike
      • Optional options: string | IWatchOptions
      • Optional listener: ((eventType, filename) => void)
          • (eventType, filename): void

          • Parameters

            • eventType: string
            • filename: string

            Returns void

      Returns FSWatcher

    watchFile

    • watchFile(path, listener): StatWatcher

    • Parameters

      • path: PathLike
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: Stats<TStatNumber>
            • prev: Stats<TStatNumber>

            Returns void

      Returns StatWatcher

    • watchFile(path, options, listener): StatWatcher

    • Parameters

      • path: PathLike
      • options: IWatchFileOptions
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: Stats<TStatNumber>
            • prev: Stats<TStatNumber>

            Returns void

      Returns StatWatcher

    write

    • write(fd, buffer, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, buffer, offset, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, buffer, offset, length, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, buffer, offset, length, position, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, str, callback): any

    • Parameters

      • fd: number
      • str: string
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, str, position, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, str, position, encoding, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • encoding: BufferEncoding
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    writeFile

    • writeFile(id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • writeFile(id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IWriteFileOptions
      • callback: TCallback<void>

      Returns any

    writeFileSync

    • writeFileSync(id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: IWriteFileOptions

      Returns void

    writeSync

    • writeSync(fd, buffer, offset?, length?, position?): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • Optional offset: number
      • Optional length: number
      • Optional position: number

      Returns number

    • writeSync(fd, str, position?, encoding?): number

    • Parameters

      • fd: number
      • str: string
      • Optional position: number
      • Optional encoding: BufferEncoding

      Returns number

    writev

    • writev(fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: WritevCallback

      Returns void

    • writev(fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: WritevCallback

      Returns void

    writevSync

    • writevSync(fd, buffers, position): number

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number

      Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    DirentFSWatcherReadStreamStatWatcherStatsWriteStream_toUnixTimestampconstantscpcpSyncfdsinoinodeslutimeslutimesSyncmaxFilesopenAsBlobopenFilesopendiropendirSyncpromisespropsreleasedFdsreleasedInosrootstatfsstatfsSyncaccessaccessSyncappendFileappendFileSyncchmodchmodSyncchownchownSyncclosecloseSynccopyFilecopyFileSynccreateLinkcreateNodecreateReadStreamcreateWriteStreamdeleteLinkexistsexistsSyncfchmodfchmodSyncfchownfchownSyncfdatasyncfdatasyncSyncfromJSONfromNestedJSONfstatfstatSyncfsyncfsyncSyncftruncateftruncateSyncfutimesfutimesSyncgetLinkgetLinkOrThrowgetResolvedLinkgetResolvedLinkOrThrowlchmodlchmodSynclchownlchownSynclinklinkSynclstatlstatSyncmkdirmkdirSyncmkdtempmkdtempSyncmountSyncopenopenSyncreadreadFilereadFileSyncreadSyncreaddirreaddirSyncreadlinkreadlinkSyncreadvreadvSyncrealpathrealpathSyncrenamerenameSyncresetresolveSymlinksrmrmSyncrmdirrmdirSyncstatstatSyncsymlinksymlinkSynctoJSONtoTreetruncatetruncateSyncunlinkunlinkSyncunwatchFileutimesutimesSyncwatchwatchFilewritewriteFilewriteFileSyncwriteSyncwritevwritevSync
    \ No newline at end of file +

    Parameters

    • id: TFileId
    • Optional len: number

    Returns void

    unlink

    unlinkSync

    unwatchFile

    • unwatchFile(path, listener?): void

    • Parameters

      • path: PathLike
      • Optional listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: Stats<TStatNumber>
            • prev: Stats<TStatNumber>

            Returns void

      Returns void

    utimes

    • utimes(path, atime, mtime, callback): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime
      • callback: TCallback<void>

      Returns void

    utimesSync

    • utimesSync(path, atime, mtime): void

    • Parameters

      • path: PathLike
      • atime: TTime
      • mtime: TTime

      Returns void

    watch

    • watch(path, options?, listener?): FSWatcher

    • Parameters

      • path: PathLike
      • Optional options: string | IWatchOptions
      • Optional listener: ((eventType, filename) => void)
          • (eventType, filename): void

          • Parameters

            • eventType: string
            • filename: string

            Returns void

      Returns FSWatcher

    watchFile

    • watchFile(path, listener): StatWatcher

    • Parameters

      • path: PathLike
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: Stats<TStatNumber>
            • prev: Stats<TStatNumber>

            Returns void

      Returns StatWatcher

    • watchFile(path, options, listener): StatWatcher

    • Parameters

      • path: PathLike
      • options: IWatchFileOptions
      • listener: ((curr, prev) => void)
          • (curr, prev): void

          • Parameters

            • curr: Stats<TStatNumber>
            • prev: Stats<TStatNumber>

            Returns void

      Returns StatWatcher

    write

    • write(fd, buffer, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, buffer, offset, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, buffer, offset, length, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, buffer, offset, length, position, callback): any

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • offset: number
      • length: number
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, str, callback): any

    • Parameters

      • fd: number
      • str: string
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, str, position, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    • write(fd, str, position, encoding, callback): any

    • Parameters

      • fd: number
      • str: string
      • position: number
      • encoding: BufferEncoding
      • callback: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns any

    writeFile

    • writeFile(id, data, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • callback: TCallback<void>

      Returns any

    • writeFile(id, data, options, callback): any

    • Parameters

      • id: TFileId
      • data: TData
      • options: string | IWriteFileOptions
      • callback: TCallback<void>

      Returns any

    writeFileSync

    • writeFileSync(id, data, options?): void

    • Parameters

      • id: TFileId
      • data: TData
      • Optional options: IWriteFileOptions

      Returns void

    writeSync

    • writeSync(fd, buffer, offset?, length?, position?): number

    • Parameters

      • fd: number
      • buffer: Buffer | ArrayBufferView | DataView
      • Optional offset: number
      • Optional length: number
      • Optional position: number

      Returns number

    • writeSync(fd, str, position?, encoding?): number

    • Parameters

      • fd: number
      • str: string
      • Optional position: number
      • Optional encoding: BufferEncoding

      Returns number

    writev

    • writev(fd, buffers, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • callback: WritevCallback

      Returns void

    • writev(fd, buffers, position, callback): void

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number
      • callback: WritevCallback

      Returns void

    writevSync

    • writevSync(fd, buffers, position): number

    • Parameters

      • fd: number
      • buffers: ArrayBufferView[]
      • position: null | number

      Returns number

    Settings

    Member Visibility

    Theme

    On This Page

    DirentFSWatcherReadStreamStatWatcherStatsWriteStream_toUnixTimestampconstantscpcpSyncfdsinoinodeslutimeslutimesSyncmaxFilesopenAsBlobopenFilesopendiropendirSyncpromisespropsreleasedFdsreleasedInosrootstatfsstatfsSyncaccessaccessSyncappendFileappendFileSyncchmodchmodSyncchownchownSyncclosecloseSynccopyFilecopyFileSynccreateLinkcreateNodecreateReadStreamcreateWriteStreamdeleteLinkexistsexistsSyncfchmodfchmodSyncfchownfchownSyncfdatasyncfdatasyncSyncfromJSONfromNestedJSONfstatfstatSyncfsyncfsyncSyncftruncateftruncateSyncfutimesfutimesSyncgetLinkgetLinkOrThrowgetResolvedLinkgetResolvedLinkOrThrowlchmodlchmodSynclchownlchownSynclinklinkSynclstatlstatSyncmkdirmkdirSyncmkdtempmkdtempSyncmountSyncopenopenSyncreadreadFilereadFileSyncreadSyncreaddirreaddirSyncreadlinkreadlinkSyncreadvreadvSyncrealpathrealpathSyncrenamerenameSyncresetresolveSymlinksrmrmSyncrmdirrmdirSyncstatstatSyncsymlinksymlinkSynctoJSONtoTreetruncatetruncateSyncunlinkunlinkSyncunwatchFileutimesutimesSyncwatchwatchFilewritewriteFilewriteFileSyncwriteSyncwritevwritevSync
    \ No newline at end of file diff --git a/interfaces/index.NestedDirectoryJSON.html b/interfaces/index.NestedDirectoryJSON.html index d2feb0085..aef549169 100644 --- a/interfaces/index.NestedDirectoryJSON.html +++ b/interfaces/index.NestedDirectoryJSON.html @@ -1 +1 @@ -NestedDirectoryJSON | memfs

    Interface NestedDirectoryJSON<T>

    interface NestedDirectoryJSON<T> {
        [key: string]: T | NestedDirectoryJSON;
    }

    Type Parameters

    • T extends DirectoryContent = DirectoryContent

    Indexable

    [key: string]: T | NestedDirectoryJSON

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NestedDirectoryJSON | memfs

    Interface NestedDirectoryJSON<T>

    interface NestedDirectoryJSON<T> {
        [key: string]: T | NestedDirectoryJSON;
    }

    Type Parameters

    • T extends DirectoryContent = DirectoryContent

    Indexable

    [key: string]: T | NestedDirectoryJSON

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/node_to_crud.NodeCrudOptions.html b/interfaces/node_to_crud.NodeCrudOptions.html index 2d04094e5..059c2b02b 100644 --- a/interfaces/node_to_crud.NodeCrudOptions.html +++ b/interfaces/node_to_crud.NodeCrudOptions.html @@ -1,4 +1,4 @@ -NodeCrudOptions | memfs

    Interface NodeCrudOptions

    interface NodeCrudOptions {
        dir: string;
        fs: FsPromisesApi;
        separator?: string;
    }

    Properties

    dir +NodeCrudOptions | memfs

    Interface NodeCrudOptions

    interface NodeCrudOptions {
        dir: string;
        fs: FsPromisesApi;
        separator?: string;
    }

    Properties

    dir fs separator? -

    Properties

    Readonly dir

    dir: string

    Readonly fs

    fs: FsPromisesApi

    Optional Readonly separator

    separator?: string

    Settings

    Member Visibility

    Theme

    On This Page

    dirfsseparator
    \ No newline at end of file +

    Properties

    Readonly dir

    dir: string

    Readonly fs

    fs: FsPromisesApi

    Optional Readonly separator

    separator?: string

    Settings

    Member Visibility

    Theme

    On This Page

    dirfsseparator
    \ No newline at end of file diff --git a/interfaces/node_to_fsa.CreateWritableOptions.html b/interfaces/node_to_fsa.CreateWritableOptions.html index 7706840ab..3f66b1102 100644 --- a/interfaces/node_to_fsa.CreateWritableOptions.html +++ b/interfaces/node_to_fsa.CreateWritableOptions.html @@ -1,2 +1,2 @@ -CreateWritableOptions | memfs

    Interface CreateWritableOptions

    interface CreateWritableOptions {
        keepExistingData?: boolean;
    }

    Properties

    keepExistingData? -

    Properties

    Optional keepExistingData

    keepExistingData?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    keepExistingData
    \ No newline at end of file +CreateWritableOptions | memfs

    Interface CreateWritableOptions

    interface CreateWritableOptions {
        keepExistingData?: boolean;
    }

    Properties

    keepExistingData? +

    Properties

    Optional keepExistingData

    keepExistingData?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    keepExistingData
    \ No newline at end of file diff --git a/interfaces/node_to_fsa.NodeFsaContext.html b/interfaces/node_to_fsa.NodeFsaContext.html index 38a6030f3..82fe56579 100644 --- a/interfaces/node_to_fsa.NodeFsaContext.html +++ b/interfaces/node_to_fsa.NodeFsaContext.html @@ -1,6 +1,6 @@ -NodeFsaContext | memfs

    Interface NodeFsaContext

    interface NodeFsaContext {
        mode: "read" | "readwrite";
        separator: "/" | "\\";
        syncHandleAllowed: boolean;
    }

    Properties

    mode +NodeFsaContext | memfs

    Interface NodeFsaContext

    interface NodeFsaContext {
        mode: "read" | "readwrite";
        separator: "/" | "\\";
        syncHandleAllowed: boolean;
    }

    Properties

    mode separator syncHandleAllowed

    Properties

    mode

    mode: "read" | "readwrite"

    Whether writes are allowed, defaults to read.

    -

    separator

    separator: "/" | "\\"

    syncHandleAllowed

    syncHandleAllowed: boolean

    Whether synchronous file handles are allowed.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    modeseparatorsyncHandleAllowed
    \ No newline at end of file +

    separator

    separator: "/" | "\\"

    syncHandleAllowed

    syncHandleAllowed: boolean

    Whether synchronous file handles are allowed.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    modeseparatorsyncHandleAllowed
    \ No newline at end of file diff --git a/modules/cas_types.html b/modules/cas_types.html index 2577a55dd..e9746c362 100644 --- a/modules/cas_types.html +++ b/modules/cas_types.html @@ -1,3 +1,3 @@ -cas/types | memfs

    Module cas/types

    Index

    Interfaces

    CasApi +cas/types | memfs

    Module cas/types

    Index

    Interfaces

    CasApi CasGetOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/crud_to_cas.html b/modules/crud_to_cas.html index 0b829983b..f9e3b6702 100644 --- a/modules/crud_to_cas.html +++ b/modules/crud_to_cas.html @@ -1,3 +1,3 @@ -crud-to-cas | memfs

    Module crud-to-cas

    Index

    Classes

    CrudCas +crud-to-cas | memfs

    Module crud-to-cas

    Index

    Classes

    CrudCas

    Interfaces

    CrudCasOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/crud_types.html b/modules/crud_types.html index efa0e3ecf..a31b63dc3 100644 --- a/modules/crud_types.html +++ b/modules/crud_types.html @@ -1,4 +1,4 @@ -crud/types | memfs

    Module crud/types

    Index

    Interfaces

    CrudApi +crud/types | memfs

    Module crud/types

    Index

    Interfaces

    CrudApi CrudCollectionEntry CrudPutOptions CrudResourceInfo diff --git a/modules/fsa_to_crud.html b/modules/fsa_to_crud.html index 5f96de79c..897bc0892 100644 --- a/modules/fsa_to_crud.html +++ b/modules/fsa_to_crud.html @@ -1,2 +1,2 @@ -fsa-to-crud | memfs

    Module fsa-to-crud

    Index

    Classes

    FsaCrud +fsa-to-crud | memfs

    Module fsa-to-crud

    Index

    Classes

    FsaCrud

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/fsa_to_node.html b/modules/fsa_to_node.html index 8d0da0673..a6056a949 100644 --- a/modules/fsa_to_node.html +++ b/modules/fsa_to_node.html @@ -1,3 +1,3 @@ -fsa-to-node | memfs

    Module fsa-to-node

    Index

    Classes

    FsaNodeFs +fsa-to-node | memfs

    Module fsa-to-node

    Index

    Classes

    FsaNodeFs FsaNodeSyncAdapterWorker

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/fsa_types.html b/modules/fsa_types.html index 6000cfa39..02c479905 100644 --- a/modules/fsa_types.html +++ b/modules/fsa_types.html @@ -1,4 +1,4 @@ -fsa/types | memfs

    Module fsa/types

    Index

    Interfaces

    CreateWritableOptions +fsa/types | memfs

    Module fsa/types

    Index

    Interfaces

    CreateWritableOptions FileSystemHandlePermissionDescriptor FileSystemReadWriteOptions FileSystemWritableFileStreamParams diff --git a/modules/index.html b/modules/index.html index 642942af1..839a44d9e 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | memfs

    Module index

    Index

    Interfaces

    DirectoryJSON +index | memfs

    Module index

    Index

    Interfaces

    DirectoryJSON IFs NestedDirectoryJSON

    Type Aliases

    IFsWithVolume diff --git a/modules/node_to_crud.html b/modules/node_to_crud.html index 989636fc9..5188f20e5 100644 --- a/modules/node_to_crud.html +++ b/modules/node_to_crud.html @@ -1,3 +1,3 @@ -node-to-crud | memfs

    Module node-to-crud

    Index

    Classes

    NodeCrud +node-to-crud | memfs

    Module node-to-crud

    Index

    Classes

    NodeCrud

    Interfaces

    NodeCrudOptions

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/node_to_fsa.html b/modules/node_to_fsa.html index ec430a39e..98c64b5fb 100644 --- a/modules/node_to_fsa.html +++ b/modules/node_to_fsa.html @@ -1,4 +1,4 @@ -node-to-fsa | memfs

    Module node-to-fsa

    Index

    Classes

    NodeFileSystemDirectoryHandle +node-to-fsa | memfs

    Module node-to-fsa

    Index

    Classes

    NodeFileSystemDirectoryHandle NodeFileSystemFileHandle NodeFileSystemHandle

    Interfaces

    CreateWritableOptions diff --git a/types/crud_types.CrudCollection.html b/types/crud_types.CrudCollection.html index 8b040a68c..4b1aef439 100644 --- a/types/crud_types.CrudCollection.html +++ b/types/crud_types.CrudCollection.html @@ -1 +1 @@ -CrudCollection | memfs

    Type alias CrudCollection

    CrudCollection: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CrudCollection | memfs

    Type alias CrudCollection

    CrudCollection: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/fsa_types.Data.html b/types/fsa_types.Data.html index 51f8e9be2..af0056ed1 100644 --- a/types/fsa_types.Data.html +++ b/types/fsa_types.Data.html @@ -1 +1 @@ -Data | memfs

    Type alias Data

    Data: ArrayBuffer | ArrayBufferView | Uint8Array | Uint8ClampedArray | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array | BigUint64Array | BigInt64Array | DataView | Blob | string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Data | memfs

    Type alias Data

    Data: ArrayBuffer | ArrayBufferView | Uint8Array | Uint8ClampedArray | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array | BigUint64Array | BigInt64Array | DataView | Blob | string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/index.IFsWithVolume.html b/types/index.IFsWithVolume.html index fe22cba16..28edf8ce8 100644 --- a/types/index.IFsWithVolume.html +++ b/types/index.IFsWithVolume.html @@ -1 +1 @@ -IFsWithVolume | memfs

    Type alias IFsWithVolume

    IFsWithVolume: IFs & {
        __vol: _Volume;
    }

    Type declaration

    • __vol: _Volume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +IFsWithVolume | memfs

    Type alias IFsWithVolume

    IFsWithVolume: IFs & {
        __vol: _Volume;
    }

    Type declaration

    • __vol: _Volume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/node_to_fsa.NodeFsaFs.html b/types/node_to_fsa.NodeFsaFs.html index 375e35c92..9f4c048c1 100644 --- a/types/node_to_fsa.NodeFsaFs.html +++ b/types/node_to_fsa.NodeFsaFs.html @@ -1,2 +1,2 @@ NodeFsaFs | memfs

    Type alias NodeFsaFs

    NodeFsaFs: Pick<FsCommonObjects, "constants"> & {
        promises: FsPromisesApi;
    } & Pick<FsSynchronousApi, "openSync" | "fsyncSync" | "statSync" | "closeSync" | "readSync" | "truncateSync" | "writeSync">

    Required Node.js fs module functions for File System Access API.

    -

    Type declaration

    • promises: FsPromisesApi

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • promises: FsPromisesApi

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/index.Volume.html b/variables/index.Volume.html index 7c39a301c..b1baf6ee2 100644 --- a/variables/index.Volume.html +++ b/variables/index.Volume.html @@ -1 +1 @@ -Volume | memfs

    Variable VolumeConst

    Volume: typeof Volume = _Volume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Volume | memfs

    Variable VolumeConst

    Volume: typeof Volume = _Volume

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/index.fs.html b/variables/index.fs.html index 574272b49..d6a720b9f 100644 --- a/variables/index.fs.html +++ b/variables/index.fs.html @@ -1 +1 @@ -fs | memfs

    Variable fsConst

    fs: IFs = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +fs | memfs

    Variable fsConst

    fs: IFs = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/index.vol.html b/variables/index.vol.html index a0ee77960..b6a2748e9 100644 --- a/variables/index.vol.html +++ b/variables/index.vol.html @@ -1 +1 @@ -vol | memfs

    Variable volConst

    vol: Volume = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +vol | memfs

    Variable volConst

    vol: Volume = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file