Optional stackStatic Optional prepareStatic EACCESStatic EEXISTStatic EISDIRStatic ENOENTStatic ENOTDIRStatic ENOTEMPTYStatic EPERMStatic OnStatic captureGenerated using TypeDoc
Internal Optional Returns AsyncFileProtected_buffer: Uint8Array = ...Protected _dirtyProtected _positionReadonly flagProtected fsProtectedReadonly pathReadonlyReadonly statsReadonlySet the file position.
@@ -206,7 +206,7 @@Protected isProtectedReturns booleanProtected resetGenerated using TypeDoc
Protected Abstract openProtected openProtectedReturns NoSyncFile<AsyncFileIndexFS<TIndex>>Abstract readyAbstractReturns Promise<AsyncFileIndexFS<TIndex>>Protected Abstract statProtected statProtectedReturns StatsGenerated using TypeDoc
AsyncMirrorFS mirrors a synchronous filesystem into an asynchronous filesystem +by:
+The two stores will be kept in sync. The most common use-case is to pair a synchronous +in-memory filesystem with an asynchronous backing store.
+Mirrors the synchronous file system into the asynchronous file system.
+Private _asyncPrivate _isPrivate _queueQueue of pending asynchronous operations.
+Private _queuePrivate _readyPrivate _syncProtected _initializePrivate _nextProtected crossProtected crossProtected crossPrivate enqueueTest whether or not the given path exists by checking with the file system.
+Generated using TypeDoc
Internal An asynchronous file system which uses an async store to store its data.
Private Optional _cacheProtected _readyProtected storeProtected _initializePrivate addPrivate commitPrivate findINodememoize/cache
Private getPrivate getINodePrivate makePrivate
Private removeUpdate mtime.
Make rename compatible with the cache.
Ensure mtime updates properly, and use that to determine if a da
Generated using TypeDoc
Static RootGenerated using TypeDoc
Optional
Optional Abstract positionOptional
Abstract _setAbstract chmodAbstract chmodAbstract chownAbstract chownAbstract closeAbstractReturns Promise<void>
Abstract closeAbstractReturns void
Abstract readAbstract readOptional Returns number
Abstract statAbstractReturns Promise<Stats>
Abstract statAbstractReturns Stats
Abstract syncAbstractReturns Promise<void>
Abstract syncAbstractReturns void
Abstract truncateAbstract truncateAbstract utimesAbstract utimesAbstract writeAbstract writeOptional Returns number
Generated using TypeDoc
Protected _flagStatic Protected cacheStatic Static Protected validStatic Static GetStatic Numberwhen the flag string is invalid
Static Stringwhen the flag number is invalid
Generated using TypeDoc
Protected _indexIf adding fails and implicitly creates directories, we do not cl the new empty directories.
If adding fails and implicitly creates directories, we do not clean up the new empty directories.
Static FromGenerated using TypeDoc
Protected _indexProtected Abstract openProtected Abstract openAbstract readyAbstractReturns Promise<FileIndexFS<TIndex>>Protected Abstract statProtected Abstract statGenerated using TypeDoc
Abstract Optional options: objectAbstract createAbstract linkAbstract linkAbstract mkdirAbstract mkdirAbstract openAbstract openAbstract readdirAbstract readdirAbstract readyAbstract
Abstract renameAbstract renameAbstract rmdirAbstract rmdirAbstract statAbstract statAbstract syncAbstract syncAbstract unlinkAbstract unlinkGenerated using TypeDoc
A simple in-memory store
+The name of the key-value store.
+Private storeBegins a new read-only transaction.
+Generated using TypeDoc
Optional Returns IndexDirInode<T>Internal_listing: Map<string, IndexInode<T>> = ...
Optional dataRemove this at some point. This isn't the responsibility of
Generated using TypeDoc
Optional Returns IndexFileInode<T>Optionaldata?: TGenerated using TypeDoc
Optional data: TOptional dataAbstractReturns this is IndexDirInode<T>
Abstract isAbstractReturns this is IndexFileInode<T>
Abstract toAbstract
Generated using TypeDoc
Optional buffer: ArrayBufferLikeReadonly bufferProtected viewtime of last access, in milliseconds since epoch
@@ -117,7 +117,7 @@time of file creation, in milliseconds since epoch
@@ -143,7 +143,7 @@time of last time file status was changed, in milliseconds since epoch
@@ -169,7 +169,7 @@the id of the group that owns the file
@@ -203,7 +203,7 @@Unix-style file mode (e.g. 0o644) that includes the item type @@ -249,7 +249,7 @@
time of last modification, in milliseconds since epoch
@@ -275,7 +275,7 @@Size of the item in bytes. @@ -321,7 +321,7 @@
the id of the user that owns the file
@@ -347,7 +347,7 @@Generated using TypeDoc
Internal This class serializes access to an underlying async filesystem. +For example, on an OverlayFS instance with an async lower +directory operations like rename and rmdir may involve multiple +requests involving both the upper and lower filesystems -- they +are not executed in a single atomic step. OverlayFS uses this +LockedFS to avoid having to reason about the correctness of +multiple requests interleaving.
+Private _muReadonly fsTest whether or not the given path exists by checking with the file system.
+Test whether or not the given path exists by checking with the file system.
+Asynchronous link.
Synchronous link.
Asynchronous mkdir.
Mode to make the directory using. Can be ignored if + the filesystem doesn't support permissions.
+Synchronous mkdir.
Mode to make the directory using. Can be ignored if + the filesystem doesn't support permissions.
+Asynchronous readdir. Reads the contents of a directory.
The callback gets two arguments (err, files) where files is an array of
+the names of the files in the directory excluding '.' and '..'.
Synchronous readdir. Reads the contents of a directory.
Asynchronous rename. No arguments other than a possible exception +are given to the completion callback.
+Synchronous rename.
+Asynchronous rmdir.
Synchronous rmdir.
Synchronize the data and stats for path asynchronously
+Synchronize the data and stats for path synchronously
+Asynchronous unlink.
Synchronous unlink.
Generated using TypeDoc
Internal We define our own file to interpose on syncSync() for mirroring purposes.
+Protected _bufferProtected _dirtyProtected _positionReadonly flagProtected fsThe file system that created the file.
+Readonly pathPath to the file
+Readonly statsThe stats object for the given file. + PreloadFile will mutate this object. Note that this object must contain + the appropriate mode that the file was opened as.
+Get the underlying buffer for this file. Mutating not recommended and will mess up dirty tracking.
+Get the current file position.
+We emulate the following bug mentioned in the Node documentation:
+++On Linux, positional writes don't work when the file is opened in append + mode. The kernel ignores the position argument and always appends the data + to the end of the file.
+
The current file position.
+ +Set the file position.
+new position
+Internal
+Set the file type
+Internal
+Set the file type
+Protected isRead data from the file.
+The buffer that the data will be + written to.
+The offset within the buffer where writing will + start.
+An integer specifying the number of bytes to read.
+An integer specifying where to begin reading from + in the file. If position is null, data will be read from the current file + position.
+Read data from the file.
+The buffer that the data will be + written to.
+The offset within the buffer where writing will start.
+An integer specifying the number of bytes to read.
+An integer specifying where to begin reading from + in the file. If position is null, data will be read from the current file + position.
+number of bytes written
+ +Protected resetWrite buffer to the file. +Note that it is unsafe to use fs.write multiple times on the same file +without waiting for the callback.
+Uint8Array containing the data to write to + the file.
+Offset in the buffer to start reading data from.
+The amount of bytes to write to the file.
+Offset from the beginning of the file where this + data should be written. If position is null, the data will be written at + the current position.
+Write buffer to the file. +Note that it is unsafe to use fs.writeSync multiple times on the same file +without waiting for the callback.
+Uint8Array containing the data to write to + the file.
+Offset in the buffer to start reading data from.
+The amount of bytes to write to the file.
+Offset from the beginning of the file where this + data should be written. If position is null, the data will be written at + the current position.
+bytes written
+ +Generated using TypeDoc
Generated using TypeDoc
Optional Returns NoSyncFile<T>Protected_buffer: Uint8Array = ...Protected _dirtyProtected _positionReadonly flagProtected fsProtectedReadonly pathReadonlyReadonly statsReadonlySet the file position.
@@ -216,7 +216,7 @@Protected isProtectedReturns booleanProtected resetGenerated using TypeDoc
Internal OverlayFS makes a read-only filesystem writable by storing writes on a second, +writable file system. Deletes are persisted via metadata stored on the writable +file system.
+The options to initialize the OverlayFS with
+Readonly fsTest whether or not the given path exists by checking with the file system.
+Test whether or not the given path exists by checking with the file system.
+Asynchronous link.
Synchronous link.
Asynchronous mkdir.
Mode to make the directory using. Can be ignored if + the filesystem doesn't support permissions.
+Synchronous mkdir.
Mode to make the directory using. Can be ignored if + the filesystem doesn't support permissions.
+Asynchronous readdir. Reads the contents of a directory.
The callback gets two arguments (err, files) where files is an array of
+the names of the files in the directory excluding '.' and '..'.
Synchronous readdir. Reads the contents of a directory.
Asynchronous rename. No arguments other than a possible exception +are given to the completion callback.
+Synchronous rename.
+Asynchronous rmdir.
Synchronous rmdir.
Synchronize the data and stats for path asynchronously
+Synchronize the data and stats for path synchronously
+Asynchronous unlink.
Synchronous unlink.
Generated using TypeDoc
Internal Overlays a RO file to make it writable.
+Protected _bufferProtected _dirtyProtected _positionReadonly flagProtected fsThe file system that created the file.
+Readonly pathPath to the file
+Readonly statsThe stats object for the given file. + PreloadFile will mutate this object. Note that this object must contain + the appropriate mode that the file was opened as.
+Get the underlying buffer for this file. Mutating not recommended and will mess up dirty tracking.
+Get the current file position.
+We emulate the following bug mentioned in the Node documentation:
+++On Linux, positional writes don't work when the file is opened in append + mode. The kernel ignores the position argument and always appends the data + to the end of the file.
+
The current file position.
+ +Set the file position.
+new position
+Internal
+Set the file type
+Internal
+Set the file type
+Protected isRead data from the file.
+The buffer that the data will be + written to.
+The offset within the buffer where writing will + start.
+An integer specifying the number of bytes to read.
+An integer specifying where to begin reading from + in the file. If position is null, data will be read from the current file + position.
+Read data from the file.
+The buffer that the data will be + written to.
+The offset within the buffer where writing will start.
+An integer specifying the number of bytes to read.
+An integer specifying where to begin reading from + in the file. If position is null, data will be read from the current file + position.
+number of bytes written
+ +Protected resetWrite buffer to the file. +Note that it is unsafe to use fs.write multiple times on the same file +without waiting for the callback.
+Uint8Array containing the data to write to + the file.
+Offset in the buffer to start reading data from.
+The amount of bytes to write to the file.
+Offset from the beginning of the file where this + data should be written. If position is null, the data will be written at + the current position.
+Write buffer to the file. +Note that it is unsafe to use fs.writeSync multiple times on the same file +without waiting for the callback.
+Uint8Array containing the data to write to + the file.
+Offset in the buffer to start reading data from.
+The amount of bytes to write to the file.
+Offset from the beginning of the file where this + data should be written. If position is null, the data will be written at + the current position.
+bytes written
+ +Generated using TypeDoc
Protected _bufferProtected _dirtyProtected _positionReadonly flagProtected fsProtected
Readonly pathReadonlyReadonly statsReadonly
Set the file position.
@@ -235,7 +237,7 @@Abstract closeAbstract closeProtected isProtected
Returns boolean
Protected resetProtectedReturns void
Abstract syncAbstract syncGenerated using TypeDoc
Protected
Protected originalProtected
Protected storeProtected markProtected stashGenerated using TypeDoc
Protected Abstract _isOptional fileOptional
Protected
Returns string
Protected _typename_Protected
Returns string
Generated using TypeDoc
Optional Returns SyncFile<FS>Protected_buffer: Uint8Array = ...Protected _dirtyProtected _positionReadonly flagProtected fsProtectedReadonly pathReadonlyReadonly statsReadonlySet the file position.
@@ -216,7 +216,7 @@Protected isProtectedReturns booleanProtected resetGenerated using TypeDoc
Abstract createAbstract linkAbstract mkdirProtected openProtected Abstract openAbstract openAbstract readdirAbstract renameAbstract rmdirProtected statProtected Abstract statAbstract statAbstract syncAbstract unlinkGenerated using TypeDoc
Internal A "Synchronous key-value file system". Stores data to/retrieves data from an -underlying key-value store.
-We use a unique ID for each node in the file system. The root node has a -fixed ID.
+A synchronous key-value file system. Uses a SyncStore to store the data.
+We use a unique ID for each node in the file system. The root node has a fixed ID.
Introduce Node ID caching.
@@ -33,7 +31,7 @@Protected storeProtected addProtected commitProtected findINodeProtected getProtected getINodeOptional Returns Inode
Protected makeProtectedReturns void
Protected removeUpdate mtime.
Generated using TypeDoc
Internal An implementation of the File interface that operates on a file that is -completely in-memory. PreloadFiles are backed by a Uint8Array.
-This is also an abstract class, as it lacks an implementation of 'sync' and -'close'. Each filesystem that wishes to use this file representation must -extend this class and implement those two methods.
-'close' lever that disables functionality once closed.
-File backend by a SyncStoreFS
+Optional Returns SyncStoreFileProtected_buffer: Uint8Array = ...Protected _dirtyProtected _positionReadonly flagProtected fsProtectedReadonly pathReadonlyReadonly statsReadonlySet the file position.
@@ -212,7 +206,7 @@Protected isProtectedReturns booleanProtected resetGenerated using TypeDoc
Internal OverlayFS makes a read-only filesystem writable by storing writes on a second, writable file system. +Deletes are persisted via metadata stored on the writable file system.
+This class contains no locking whatsoever. It is wrapped in a LockedFS to prevent races.
+Private _deletePrivate Optional _deletePrivate _deletePrivate _deletePrivate _deletedPrivate _isPrivate _readablePrivate _readyPrivate _writablePrivate _reparsePrivate checkPrivate checkPrivate copyPrivate copyCopy from readable to writable storage. +PRECONDITION: File does not exist on writable storage.
+Private createPrivate createWith the given path, create the needed parent directories on the writable storage +should they not exist. Use modes from the read-only storage.
+Private deleteTest whether or not the given path exists by checking with the file system.
+Test whether or not the given path exists by checking with the file system.
+Asynchronous link.
Synchronous link.
Asynchronous mkdir.
Mode to make the directory using. Can be ignored if + the filesystem doesn't support permissions.
+Synchronous mkdir.
Mode to make the directory using. Can be ignored if + the filesystem doesn't support permissions.
+Private operateHelper function:
+Private operateAsynchronous readdir. Reads the contents of a directory.
The callback gets two arguments (err, files) where files is an array of
+the names of the files in the directory excluding '.' and '..'.
Synchronous readdir. Reads the contents of a directory.
Asynchronous rename. No arguments other than a possible exception +are given to the completion callback.
+Synchronous rename.
+Asynchronous rmdir.
Synchronous rmdir.
Synchronize the data and stats for path asynchronously
+Synchronize the data and stats for path synchronously
+Asynchronous unlink.
Synchronous unlink.
Private updateGenerated using TypeDoc
Protected_isInherited from StatsCommon.atimeMs
Inherited from StatsCommon.birthtimeMs
Inherited from StatsCommon.ctimeMs
Optional fileOptionalInherited from StatsCommon.gid
Inherited from StatsCommon.mode
Inherited from StatsCommon.mtimeMs
Inherited from StatsCommon.size
Inherited from StatsCommon.uid
ProtectedReturns stringProtected _typename_ProtectedReturns stringInherited from StatsCommon.atime
Inherited from StatsCommon.atime
Inherited from StatsCommon.birthtime
Inherited from StatsCommon.birthtime
Inherited from StatsCommon.ctime
Inherited from StatsCommon.ctime
Inherited from StatsCommon.mtime
Inherited from StatsCommon.mtime
Inherited from StatsCommon.isBlockDevice
Inherited from StatsCommon.isCharacterDevice
Inherited from StatsCommon.isDirectory
Inherited from StatsCommon.isFIFO
Inherited from StatsCommon.isFile
Inherited from StatsCommon.isSocket
Inherited from StatsCommon.isSymbolicLink
Static cloneGenerated using TypeDoc
Protected _entriesProtected closedReadonly pathProtected _readProtected
Returns Promise<Dirent>
Protected checkProtected
Returns void
Generated using TypeDoc
Protected statsGenerated using TypeDoc
Readonly closedGenerated using TypeDoc
Protected_isInherited from StatsCommon.atimeMs
Inherited from StatsCommon.birthtimeMs
Inherited from StatsCommon.ctimeMs
Optional fileOptionalInherited from StatsCommon.gid
Inherited from StatsCommon.mode
Inherited from StatsCommon.mtimeMs
Inherited from StatsCommon.size
Inherited from StatsCommon.uid
ProtectedReturns stringProtected _typename_ProtectedReturns stringInherited from StatsCommon.atime
Inherited from StatsCommon.atime
Inherited from StatsCommon.birthtime
Inherited from StatsCommon.birthtime
Inherited from StatsCommon.ctime
Inherited from StatsCommon.ctime
Inherited from StatsCommon.mtime
Inherited from StatsCommon.mtime
Inherited from StatsCommon.isBlockDevice
Inherited from StatsCommon.isCharacterDevice
Inherited from StatsCommon.isDirectory
Inherited from StatsCommon.isFIFO
Inherited from StatsCommon.isFile
Inherited from StatsCommon.isSocket
Inherited from StatsCommon.isSymbolicLink
Static cloneGenerated using TypeDoc
Readonly closedGenerated using TypeDoc
ReadonlyOptional Returns Promise<Stats>
+Optional Returns Promise<{ Asynchronously writes buffer to the file.
@@ -415,7 +415,7 @@
Asynchronously writes string to the file.
@@ -442,7 +442,7 @@
Generated using TypeDoc
http://www.gnu.org/software/libc/manual/html_node/Error-Codes.html
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
mode Defaults to 0644.
flag Defaults to 'a'.
Optional Optional cb: NoArgCallbackOptional Optional cb: NoArgCallbackGenerated using TypeDoc
options mode Defaults to 0644.
options flag Defaults to 'a'.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Optional mode?: numberGenerated using TypeDoc
Optional Optional mode?: numberGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns Stats
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns void
+Optional Optional cb: NoArgCallbackGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns number
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Implement recursion
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
http://www.manpagez.com/man/2/open/
+Generated using TypeDoc
http://www.manpagez.com/man/2/open/
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
options mode Defaults to 0644.
options flag Defaults to 'a'.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Optional mode?: numberGenerated using TypeDoc
Optional Optional mode?: numberGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns Promise<Stats>
+Generated using TypeDoc
Generated using TypeDoc
Optional Returns Promise<void>
+Generated using TypeDoc
Generated using TypeDoc
http://www.manpagez.com/man/2/open/
+Generated using TypeDoc
Optional Returns Promise<{ Generated using TypeDoc
Generated using TypeDoc
Optional Returns Promise<string[]>Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Optional bigint?: falseGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns Promise<{ Optional Optional encoding: BufferEncodingGenerated using TypeDoc
options mode Defaults to 0644.
options flag Defaults to 'w'.
Generated using TypeDoc
Generated using TypeDoc
options encoding The string encoding for the file contents. De
options flag Defaults to 'r'.
Optional Optional callback: TwoArgCallback<Uint8Array>Generated using TypeDoc
options encoding The string encoding for the file contents. De
options flag Defaults to 'r'.
Generated using TypeDoc
Optional Returns number
+Generated using TypeDoc
Optional cb: TwoArgCallback<string[]>Generated using TypeDoc
Optional Returns string[]
+Generated using TypeDoc
Generated using TypeDoc
Optional Returns Uint8Array
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns void
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns voidOptional Optional cb: NoArgCallbackGenerated using TypeDoc
Generated using TypeDoc
Optional Returns void
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional Returns void
+Generated using TypeDoc
mode Defaults to 0644.
flag Defaults to 'w'.
Optional Optional cb: NoArgCallbackOptional Optional cb: NoArgCallbackGenerated using TypeDoc
options mode Defaults to 0644.
options flag Defaults to 'w'.
Generated using TypeDoc
Optional Returns number
+Optional Optional encoding: BufferEncodingGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The asynchronous file system to mirror.
+The synchronous file system to mirror the asynchronous file system to.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Begins a read-only transaction.
@@ -79,7 +79,7 @@Generated using TypeDoc
Optional
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
The file system that initially populates this file system.
+The file system to write modified files to.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Begins a new read-write transaction.
@@ -79,7 +83,7 @@Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Async preload file for usage with AsyncStore
Hierarchy