FsBridge
Nodepod API / src / FsBridge
Interface: FsBridge
Section titled “Interface: FsBridge”Defined in: src/polyfills/fs.ts:382
Properties
Section titled “Properties”constants
Section titled “constants”constants:
FsConstantsShape
Defined in: src/polyfills/fs.ts:573
promises
Section titled “promises”promises:
FsPromisesShape
Defined in: src/polyfills/fs.ts:572
ReadStream
Section titled “ReadStream”ReadStream: (
path,opts?) =>Readable
Defined in: src/polyfills/fs.ts:551
Parameters
Section titled “Parameters”unknown
Record<string, unknown>
Returns
Section titled “Returns”realpathSync
Section titled “realpathSync”realpathSync: (
target) =>string&object
Defined in: src/polyfills/fs.ts:415
Type Declaration
Section titled “Type Declaration”native
Section titled “native”native: (
target) =>string
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”string
StatFs
Section titled “StatFs”StatFs: typeof
StatFs
Defined in: src/polyfills/fs.ts:570
StatWatcher
Section titled “StatWatcher”StatWatcher: typeof
StatWatcher
Defined in: src/polyfills/fs.ts:571
WriteStream
Section titled “WriteStream”WriteStream: (
path,opts?) =>Writable
Defined in: src/polyfills/fs.ts:552
Parameters
Section titled “Parameters”unknown
Record<string, unknown>
Returns
Section titled “Returns”Methods
Section titled “Methods”__openFileHandleSync()
Section titled “__openFileHandleSync()”__openFileHandleSync(
target):VolumeFileHandle
Defined in: src/polyfills/fs.ts:383
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”VolumeFileHandle
access()
Section titled “access()”Call Signature
Section titled “Call Signature”access(
target,cb):void
Defined in: src/polyfills/fs.ts:509
Parameters
Section titled “Parameters”target
Section titled “target”string
(err) => void
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”access(
target,mode,cb):void
Defined in: src/polyfills/fs.ts:510
Parameters
Section titled “Parameters”target
Section titled “target”string
number
(err) => void
Returns
Section titled “Returns”void
accessSync()
Section titled “accessSync()”accessSync(
target,mode?):void
Defined in: src/polyfills/fs.ts:418
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
number
Returns
Section titled “Returns”void
appendFile()
Section titled “appendFile()”appendFile(
target,data,cb):void
Defined in: src/polyfills/fs.ts:478
Parameters
Section titled “Parameters”target
Section titled “target”string
string | Uint8Array<ArrayBufferLike>
(err) => void
Returns
Section titled “Returns”void
appendFileSync()
Section titled “appendFileSync()”appendFileSync(
target,data):void
Defined in: src/polyfills/fs.ts:397
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
string | Uint8Array<ArrayBufferLike>
Returns
Section titled “Returns”void
chmod()
Section titled “chmod()”chmod(
target,mode,cb):void
Defined in: src/polyfills/fs.ts:527
Parameters
Section titled “Parameters”target
Section titled “target”string
number
(err) => void
Returns
Section titled “Returns”void
chmodSync()
Section titled “chmodSync()”chmodSync(
target,mode):void
Defined in: src/polyfills/fs.ts:423
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
number
Returns
Section titled “Returns”void
chown()
Section titled “chown()”chown(
target,uid,gid,cb):void
Defined in: src/polyfills/fs.ts:528
Parameters
Section titled “Parameters”target
Section titled “target”string
number
number
(err) => void
Returns
Section titled “Returns”void
chownSync()
Section titled “chownSync()”chownSync(
target,uid,gid):void
Defined in: src/polyfills/fs.ts:424
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
number
number
Returns
Section titled “Returns”void
closeSync()
Section titled “closeSync()”closeSync(
fd):void
Defined in: src/polyfills/fs.ts:431
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
copyFileSync()
Section titled “copyFileSync()”copyFileSync(
src,dest,mode?):void
Defined in: src/polyfills/fs.ts:419
Parameters
Section titled “Parameters”PathArg
PathArg
number
Returns
Section titled “Returns”void
cp(
src,dest,optsOrCb?,cb?):void
Defined in: src/polyfills/fs.ts:554
Parameters
Section titled “Parameters”unknown
unknown
optsOrCb?
Section titled “optsOrCb?”unknown
(err) => void
Returns
Section titled “Returns”void
cpSync()
Section titled “cpSync()”cpSync(
src,dest,opts?):void
Defined in: src/polyfills/fs.ts:553
Parameters
Section titled “Parameters”unknown
unknown
CpOptions
Returns
Section titled “Returns”void
createReadStream()
Section titled “createReadStream()”createReadStream(
target,opts?):Readable
Defined in: src/polyfills/fs.ts:534
Parameters
Section titled “Parameters”target
Section titled “target”string
autoClose?
Section titled “autoClose?”boolean
encoding?
Section titled “encoding?”string
number
number
flags?
Section titled “flags?”string
highWaterMark?
Section titled “highWaterMark?”number
number
start?
Section titled “start?”number
Returns
Section titled “Returns”createWriteStream()
Section titled “createWriteStream()”createWriteStream(
target,opts?):Writable
Defined in: src/polyfills/fs.ts:547
Parameters
Section titled “Parameters”target
Section titled “target”string
encoding?
Section titled “encoding?”string
flags?
Section titled “flags?”string
Returns
Section titled “Returns”exists()
Section titled “exists()”exists(
target,cb):void
Defined in: src/polyfills/fs.ts:562
Parameters
Section titled “Parameters”target
Section titled “target”unknown
(exists) => void
Returns
Section titled “Returns”void
existsSync()
Section titled “existsSync()”existsSync(
target):boolean
Defined in: src/polyfills/fs.ts:398
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”boolean
fchmodSync()
Section titled “fchmodSync()”fchmodSync(
fd,mode):void
Defined in: src/polyfills/fs.ts:429
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
fchownSync()
Section titled “fchownSync()”fchownSync(
fd,uid,gid):void
Defined in: src/polyfills/fs.ts:428
Parameters
Section titled “Parameters”number
number
number
Returns
Section titled “Returns”void
fdatasync()
Section titled “fdatasync()”fdatasync(
fd,cb):void
Defined in: src/polyfills/fs.ts:565
Parameters
Section titled “Parameters”number
(err) => void
Returns
Section titled “Returns”void
fdatasyncSync()
Section titled “fdatasyncSync()”fdatasyncSync(
fd):void
Defined in: src/polyfills/fs.ts:448
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
fstatSync()
Section titled “fstatSync()”fstatSync(
fd,opts?):FileStat|undefined
Defined in: src/polyfills/fs.ts:411
Parameters
Section titled “Parameters”number
StatOptions
Returns
Section titled “Returns”FileStat | undefined
fsync()
Section titled “fsync()”fsync(
fd,cb):void
Defined in: src/polyfills/fs.ts:566
Parameters
Section titled “Parameters”number
(err) => void
Returns
Section titled “Returns”void
fsyncSync()
Section titled “fsyncSync()”fsyncSync(
fd):void
Defined in: src/polyfills/fs.ts:447
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
ftruncate()
Section titled “ftruncate()”ftruncate(
fd,lenOrCb?,cb?):void
Defined in: src/polyfills/fs.ts:567
Parameters
Section titled “Parameters”number
lenOrCb?
Section titled “lenOrCb?”unknown
unknown
Returns
Section titled “Returns”void
ftruncateSync()
Section titled “ftruncateSync()”ftruncateSync(
fd,len?):void
Defined in: src/polyfills/fs.ts:446
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
glob()
Section titled “glob()”glob(
pattern,optsOrCb?,cb?):void
Defined in: src/polyfills/fs.ts:558
Parameters
Section titled “Parameters”pattern
Section titled “pattern”string | string[]
optsOrCb?
Section titled “optsOrCb?”unknown
unknown
Returns
Section titled “Returns”void
globSync()
Section titled “globSync()”globSync(
pattern,opts?):string[] |Dirent[]
Defined in: src/polyfills/fs.ts:557
Parameters
Section titled “Parameters”pattern
Section titled “pattern”string | string[]
GlobOptions
Returns
Section titled “Returns”string[] | Dirent[]
lchmod()
Section titled “lchmod()”lchmod(
target,mode,cb):void
Defined in: src/polyfills/fs.ts:564
Parameters
Section titled “Parameters”target
Section titled “target”unknown
number
(err) => void
Returns
Section titled “Returns”void
lchmodSync()
Section titled “lchmodSync()”lchmodSync(
target,mode):void
Defined in: src/polyfills/fs.ts:563
Parameters
Section titled “Parameters”target
Section titled “target”unknown
number
Returns
Section titled “Returns”void
lchownSync()
Section titled “lchownSync()”lchownSync(
target,uid,gid):void
Defined in: src/polyfills/fs.ts:426
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
number
number
Returns
Section titled “Returns”void
link()
Section titled “link()”link(
existingPath,newPath,cb):void
Defined in: src/polyfills/fs.ts:522
Parameters
Section titled “Parameters”existingPath
Section titled “existingPath”string
newPath
Section titled “newPath”string
(err) => void
Returns
Section titled “Returns”void
linkSync()
Section titled “linkSync()”linkSync(
existingPath,newPath):void
Defined in: src/polyfills/fs.ts:422
Parameters
Section titled “Parameters”existingPath
Section titled “existingPath”PathArg
newPath
Section titled “newPath”PathArg
Returns
Section titled “Returns”void
lstat()
Section titled “lstat()”lstat(
target,cb):void
Defined in: src/polyfills/fs.ts:484
Parameters
Section titled “Parameters”target
Section titled “target”string
(err, stats?) => void
Returns
Section titled “Returns”void
lstatSync()
Section titled “lstatSync()”lstatSync(
target,opts?):FileStat|undefined
Defined in: src/polyfills/fs.ts:410
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
StatOptions
Returns
Section titled “Returns”FileStat | undefined
lutimesSync()
Section titled “lutimesSync()”lutimesSync(
target,atime,mtime):void
Defined in: src/polyfills/fs.ts:427
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
unknown
unknown
Returns
Section titled “Returns”void
mkdir()
Section titled “mkdir()”mkdir(
target,opts,cb):void
Defined in: src/polyfills/fs.ts:497
Parameters
Section titled “Parameters”target
Section titled “target”string
recursive?
Section titled “recursive?”boolean
(err) => void
Returns
Section titled “Returns”void
mkdirSync()
Section titled “mkdirSync()”mkdirSync(
target,opts?):string|undefined
Defined in: src/polyfills/fs.ts:399
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
number
recursive?
Section titled “recursive?”boolean
Returns
Section titled “Returns”string | undefined
mkdtemp()
Section titled “mkdtemp()”mkdtemp(
prefix,optsOrCb?,cb?):void
Defined in: src/polyfills/fs.ts:569
Parameters
Section titled “Parameters”prefix
Section titled “prefix”string
optsOrCb?
Section titled “optsOrCb?”unknown
unknown
Returns
Section titled “Returns”void
mkdtempSync()
Section titled “mkdtempSync()”mkdtempSync(
prefix):string
Defined in: src/polyfills/fs.ts:449
Parameters
Section titled “Parameters”prefix
Section titled “prefix”string
Returns
Section titled “Returns”string
openAsBlob()
Section titled “openAsBlob()”openAsBlob(
target,opts?):Promise<Blob>
Defined in: src/polyfills/fs.ts:561
Parameters
Section titled “Parameters”target
Section titled “target”unknown
string
Returns
Section titled “Returns”Promise<Blob>
opendirSync()
Section titled “opendirSync()”opendirSync(
target):Dir
Defined in: src/polyfills/fs.ts:451
Parameters
Section titled “Parameters”target
Section titled “target”unknown
Returns
Section titled “Returns”Dir
openSync()
Section titled “openSync()”openSync(
target,flags,mode?):number
Defined in: src/polyfills/fs.ts:430
Parameters
Section titled “Parameters”target
Section titled “target”string
string | number
number
Returns
Section titled “Returns”number
readdir()
Section titled “readdir()”Call Signature
Section titled “Call Signature”readdir(
target,cb):void
Defined in: src/polyfills/fs.ts:488
Parameters
Section titled “Parameters”target
Section titled “target”string
(err, entries?) => void
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”readdir(
target,opts,cb):void
Defined in: src/polyfills/fs.ts:492
Parameters
Section titled “Parameters”target
Section titled “target”string
string | { encoding?: string; withFileTypes?: boolean; }
(err, entries?) => void
Returns
Section titled “Returns”void
readdirSync()
Section titled “readdirSync()”Call Signature
Section titled “Call Signature”readdirSync(
target):string[]
Defined in: src/polyfills/fs.ts:403
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”string[]
Call Signature
Section titled “Call Signature”readdirSync(
target,opts):Dirent[]
Defined in: src/polyfills/fs.ts:404
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
withFileTypes
Section titled “withFileTypes”true
Returns
Section titled “Returns”Dirent[]
Call Signature
Section titled “Call Signature”readdirSync(
target,opts?):string[] |Dirent[] |Buffer<ArrayBufferLike>[]
Defined in: src/polyfills/fs.ts:405
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
string | { encoding?: string; withFileTypes?: boolean; }
Returns
Section titled “Returns”string[] | Dirent[] | Buffer<ArrayBufferLike>[]
readFile()
Section titled “readFile()”Call Signature
Section titled “Call Signature”readFile(
target,cb):void
Defined in: src/polyfills/fs.ts:464
Parameters
Section titled “Parameters”target
Section titled “target”string
(err, data?) => void
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”readFile(
target,opts,cb):void
Defined in: src/polyfills/fs.ts:468
Parameters
Section titled “Parameters”target
Section titled “target”string
encoding
Section titled “encoding”string
(err, data?) => void
Returns
Section titled “Returns”void
readFileSync()
Section titled “readFileSync()”Call Signature
Section titled “Call Signature”readFileSync(
target):Buffer
Defined in: src/polyfills/fs.ts:384
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”Buffer
Call Signature
Section titled “Call Signature”readFileSync(
target,enc):string
Defined in: src/polyfills/fs.ts:385
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
BufferEncoding
Returns
Section titled “Returns”string
Call Signature
Section titled “Call Signature”readFileSync(
target,opts):string
Defined in: src/polyfills/fs.ts:386
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
encoding
Section titled “encoding”BufferEncoding
Returns
Section titled “Returns”string
Call Signature
Section titled “Call Signature”readFileSync(
target,opts):Buffer
Defined in: src/polyfills/fs.ts:387
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
encoding?
Section titled “encoding?”null
Returns
Section titled “Returns”Buffer
Call Signature
Section titled “Call Signature”readFileSync(
target,encOrOpts?):string|Buffer<ArrayBufferLike>
Defined in: src/polyfills/fs.ts:388
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
encOrOpts?
Section titled “encOrOpts?”string | { encoding?: string | null; }
Returns
Section titled “Returns”string | Buffer<ArrayBufferLike>
readlink()
Section titled “readlink()”readlink(
target,cb):void
Defined in: src/polyfills/fs.ts:518
Parameters
Section titled “Parameters”target
Section titled “target”string
(err, linkTarget?) => void
Returns
Section titled “Returns”void
readlinkSync()
Section titled “readlinkSync()”readlinkSync(
target):string
Defined in: src/polyfills/fs.ts:421
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”string
readSync()
Section titled “readSync()”readSync(
fd,buf,off,len,pos):number
Defined in: src/polyfills/fs.ts:432
Parameters
Section titled “Parameters”number
Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
number
number
number | null
Returns
Section titled “Returns”number
readv()
Section titled “readv()”readv(
fd,buffers,posOrCb?,cb?):void
Defined in: src/polyfills/fs.ts:556
Parameters
Section titled “Parameters”number
buffers
Section titled “buffers”ArrayBufferView<ArrayBufferLike>[]
posOrCb?
Section titled “posOrCb?”unknown
unknown
Returns
Section titled “Returns”void
readvSync()
Section titled “readvSync()”readvSync(
fd,buffers,pos?):number
Defined in: src/polyfills/fs.ts:555
Parameters
Section titled “Parameters”number
buffers
Section titled “buffers”ArrayBufferView<ArrayBufferLike>[]
number | null
Returns
Section titled “Returns”number
realpath()
Section titled “realpath()”realpath(
target,cb):void
Defined in: src/polyfills/fs.ts:505
Parameters
Section titled “Parameters”target
Section titled “target”string
(err, resolved?) => void
Returns
Section titled “Returns”void
rename()
Section titled “rename()”rename(
oldPath,newPath,cb):void
Defined in: src/polyfills/fs.ts:504
Parameters
Section titled “Parameters”oldPath
Section titled “oldPath”string
newPath
Section titled “newPath”string
(err) => void
Returns
Section titled “Returns”void
renameSync()
Section titled “renameSync()”renameSync(
src,dest):void
Defined in: src/polyfills/fs.ts:414
Parameters
Section titled “Parameters”PathArg
PathArg
Returns
Section titled “Returns”void
rmdir()
Section titled “rmdir()”rmdir(
target,cb):void
Defined in: src/polyfills/fs.ts:503
Parameters
Section titled “Parameters”target
Section titled “target”string
(err) => void
Returns
Section titled “Returns”void
rmdirSync()
Section titled “rmdirSync()”rmdirSync(
target):void
Defined in: src/polyfills/fs.ts:413
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”void
rmSync()
Section titled “rmSync()”rmSync(
target,opts?):void
Defined in: src/polyfills/fs.ts:450
Parameters
Section titled “Parameters”target
Section titled “target”string
RmOptions
Returns
Section titled “Returns”void
stat()
Section titled “stat()”stat(
target,cb):void
Defined in: src/polyfills/fs.ts:483
Parameters
Section titled “Parameters”target
Section titled “target”string
(err, stats?) => void
Returns
Section titled “Returns”void
statfs()
Section titled “statfs()”statfs(
target,optsOrCb?,cb?):void
Defined in: src/polyfills/fs.ts:560
Parameters
Section titled “Parameters”target
Section titled “target”unknown
optsOrCb?
Section titled “optsOrCb?”unknown
unknown
Returns
Section titled “Returns”void
statfsSync()
Section titled “statfsSync()”statfsSync(
target,opts?):StatFs
Defined in: src/polyfills/fs.ts:559
Parameters
Section titled “Parameters”target
Section titled “target”unknown
unknown
Returns
Section titled “Returns”StatFs
statSync()
Section titled “statSync()”statSync(
target,opts?):FileStat|undefined
Defined in: src/polyfills/fs.ts:409
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
StatOptions
Returns
Section titled “Returns”FileStat | undefined
symlink()
Section titled “symlink()”Call Signature
Section titled “Call Signature”symlink(
target,path,cb):void
Defined in: src/polyfills/fs.ts:511
Parameters
Section titled “Parameters”target
Section titled “target”string
string
(err) => void
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”symlink(
target,path,type,cb):void
Defined in: src/polyfills/fs.ts:512
Parameters
Section titled “Parameters”target
Section titled “target”string
string
string
(err) => void
Returns
Section titled “Returns”void
symlinkSync()
Section titled “symlinkSync()”symlinkSync(
target,path,type?):void
Defined in: src/polyfills/fs.ts:420
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
PathArg
string
Returns
Section titled “Returns”void
truncate()
Section titled “truncate()”truncate(
target,lenOrCb?,cb?):void
Defined in: src/polyfills/fs.ts:568
Parameters
Section titled “Parameters”target
Section titled “target”unknown
lenOrCb?
Section titled “lenOrCb?”unknown
unknown
Returns
Section titled “Returns”void
truncateSync()
Section titled “truncateSync()”truncateSync(
target,len?):void
Defined in: src/polyfills/fs.ts:425
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
number
Returns
Section titled “Returns”void
unlink()
Section titled “unlink()”unlink(
target,cb):void
Defined in: src/polyfills/fs.ts:502
Parameters
Section titled “Parameters”target
Section titled “target”string
(err) => void
Returns
Section titled “Returns”void
unlinkSync()
Section titled “unlinkSync()”unlinkSync(
target):void
Defined in: src/polyfills/fs.ts:412
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
Returns
Section titled “Returns”void
unwatchFile()
Section titled “unwatchFile()”unwatchFile(
filename,listener?):void
Defined in: src/polyfills/fs.ts:457
Parameters
Section titled “Parameters”filename
Section titled “filename”unknown
listener?
Section titled “listener?”unknown
Returns
Section titled “Returns”void
watch()
Section titled “watch()”Call Signature
Section titled “Call Signature”watch(
filename,opts?,listener?):FileWatchHandle
Defined in: src/polyfills/fs.ts:458
Parameters
Section titled “Parameters”filename
Section titled “filename”string
persistent?
Section titled “persistent?”boolean
recursive?
Section titled “recursive?”boolean
listener?
Section titled “listener?”Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”watch(
filename,listener?):FileWatchHandle
Defined in: src/polyfills/fs.ts:463
Parameters
Section titled “Parameters”filename
Section titled “filename”string
listener?
Section titled “listener?”Returns
Section titled “Returns”watchFile()
Section titled “watchFile()”watchFile(
filename,optsOrListener?,listener?):StatWatcher
Defined in: src/polyfills/fs.ts:452
Parameters
Section titled “Parameters”filename
Section titled “filename”unknown
optsOrListener?
Section titled “optsOrListener?”unknown
listener?
Section titled “listener?”unknown
Returns
Section titled “Returns”StatWatcher
writeFile()
Section titled “writeFile()”writeFile(
target,data,cb):void
Defined in: src/polyfills/fs.ts:473
Parameters
Section titled “Parameters”target
Section titled “target”string
string | Uint8Array<ArrayBufferLike>
(err) => void
Returns
Section titled “Returns”void
writeFileSync()
Section titled “writeFileSync()”writeFileSync(
target,data,opts?):void
Defined in: src/polyfills/fs.ts:392
Parameters
Section titled “Parameters”target
Section titled “target”PathArg
string | Uint8Array<ArrayBufferLike>
string | WriteFileOptions
Returns
Section titled “Returns”void
writeSync()
Section titled “writeSync()”writeSync(
fd,buf,off?,len?,pos?):number
Defined in: src/polyfills/fs.ts:439
Parameters
Section titled “Parameters”number
string | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>
number
number
number | null
Returns
Section titled “Returns”number