Skip to content

FsBridge

Nodepod API


Nodepod API / src / FsBridge

Defined in: src/polyfills/fs.ts:422

constants: FsConstantsShape

Defined in: src/polyfills/fs.ts:614


promises: FsPromisesShape

Defined in: src/polyfills/fs.ts:613


ReadStream: (path, opts?) => Readable

Defined in: src/polyfills/fs.ts:592

unknown

Record<string, unknown>

Readable


realpathSync: (target) => string & object

Defined in: src/polyfills/fs.ts:455

native: (target) => string

PathArg

string


StatFs: typeof StatFs

Defined in: src/polyfills/fs.ts:611


StatWatcher: typeof StatWatcher

Defined in: src/polyfills/fs.ts:612


WriteStream: (path, opts?) => Writable

Defined in: src/polyfills/fs.ts:593

unknown

Record<string, unknown>

Writable

__openFileHandleSync(target): VolumeFileHandle

Defined in: src/polyfills/fs.ts:423

PathArg

VolumeFileHandle


access(target, cb): void

Defined in: src/polyfills/fs.ts:550

string

(err) => void

void

access(target, mode, cb): void

Defined in: src/polyfills/fs.ts:551

string

number

(err) => void

void


accessSync(target, mode?): void

Defined in: src/polyfills/fs.ts:458

PathArg

number

void


appendFile(target, data, cb): void

Defined in: src/polyfills/fs.ts:519

string

string | Uint8Array<ArrayBufferLike>

(err) => void

void


appendFileSync(target, data): void

Defined in: src/polyfills/fs.ts:437

PathArg

string | Uint8Array<ArrayBufferLike>

void


chmod(target, mode, cb): void

Defined in: src/polyfills/fs.ts:568

string

number

(err) => void

void


chmodSync(target, mode): void

Defined in: src/polyfills/fs.ts:463

PathArg

number

void


chown(target, uid, gid, cb): void

Defined in: src/polyfills/fs.ts:569

string

number

number

(err) => void

void


chownSync(target, uid, gid): void

Defined in: src/polyfills/fs.ts:464

PathArg

number

number

void


closeSync(fd): void

Defined in: src/polyfills/fs.ts:472

number

void


copyFileSync(src, dest, mode?): void

Defined in: src/polyfills/fs.ts:459

PathArg

PathArg

number

void


cp(src, dest, optsOrCb?, cb?): void

Defined in: src/polyfills/fs.ts:595

unknown

unknown

unknown

(err) => void

void


cpSync(src, dest, opts?): void

Defined in: src/polyfills/fs.ts:594

unknown

unknown

CpOptions

void


createReadStream(target, opts?): Readable

Defined in: src/polyfills/fs.ts:575

string

boolean

string

number

number

string

number

number

number

Readable


createWriteStream(target, opts?): Writable

Defined in: src/polyfills/fs.ts:588

string

string

string

Writable


exists(target, cb): void

Defined in: src/polyfills/fs.ts:603

unknown

(exists) => void

void


existsSync(target): boolean

Defined in: src/polyfills/fs.ts:438

PathArg

boolean


fchmodSync(fd, mode): void

Defined in: src/polyfills/fs.ts:470

number

number

void


fchownSync(fd, uid, gid): void

Defined in: src/polyfills/fs.ts:469

number

number

number

void


fdatasync(fd, cb): void

Defined in: src/polyfills/fs.ts:606

number

(err) => void

void


fdatasyncSync(fd): void

Defined in: src/polyfills/fs.ts:489

number

void


fstatSync(fd, opts?): FileStat | undefined

Defined in: src/polyfills/fs.ts:451

number

StatOptions

FileStat | undefined


fsync(fd, cb): void

Defined in: src/polyfills/fs.ts:607

number

(err) => void

void


fsyncSync(fd): void

Defined in: src/polyfills/fs.ts:488

number

void


ftruncate(fd, lenOrCb?, cb?): void

Defined in: src/polyfills/fs.ts:608

number

unknown

unknown

void


ftruncateSync(fd, len?): void

Defined in: src/polyfills/fs.ts:487

number

number

void


futimesSync(fd, atime, mtime): void

Defined in: src/polyfills/fs.ts:468

number

unknown

unknown

void


glob(pattern, optsOrCb?, cb?): void

Defined in: src/polyfills/fs.ts:599

string | string[]

unknown

unknown

void


globSync(pattern, opts?): string[] | Dirent[]

Defined in: src/polyfills/fs.ts:598

string | string[]

GlobOptions

string[] | Dirent[]


lchmod(target, mode, cb): void

Defined in: src/polyfills/fs.ts:605

unknown

number

(err) => void

void


lchmodSync(target, mode): void

Defined in: src/polyfills/fs.ts:604

unknown

number

void


lchownSync(target, uid, gid): void

Defined in: src/polyfills/fs.ts:466

PathArg

number

number

void


link(existingPath, newPath, cb): void

Defined in: src/polyfills/fs.ts:563

string

string

(err) => void

void


linkSync(existingPath, newPath): void

Defined in: src/polyfills/fs.ts:462

PathArg

PathArg

void


lstat(target, cb): void

Defined in: src/polyfills/fs.ts:525

string

(err, stats?) => void

void


lstatSync(target, opts?): FileStat | undefined

Defined in: src/polyfills/fs.ts:450

PathArg

StatOptions

FileStat | undefined


lutimesSync(target, atime, mtime): void

Defined in: src/polyfills/fs.ts:467

PathArg

unknown

unknown

void


mkdir(target, opts, cb): void

Defined in: src/polyfills/fs.ts:538

string

boolean

(err) => void

void


mkdirSync(target, opts?): string | undefined

Defined in: src/polyfills/fs.ts:439

PathArg

number

boolean

string | undefined


mkdtemp(prefix, optsOrCb?, cb?): void

Defined in: src/polyfills/fs.ts:610

string

unknown

unknown

void


mkdtempSync(prefix): string

Defined in: src/polyfills/fs.ts:490

string

string


openAsBlob(target, opts?): Promise<Blob>

Defined in: src/polyfills/fs.ts:602

unknown

string

Promise<Blob>


opendirSync(target): Dir

Defined in: src/polyfills/fs.ts:492

unknown

Dir


openSync(target, flags, mode?): number

Defined in: src/polyfills/fs.ts:471

string

string | number

number

number


readdir(target, cb): void

Defined in: src/polyfills/fs.ts:529

string

(err, entries?) => void

void

readdir(target, opts, cb): void

Defined in: src/polyfills/fs.ts:533

string

string | { encoding?: string; withFileTypes?: boolean; }

(err, entries?) => void

void


readdirSync(target): string[]

Defined in: src/polyfills/fs.ts:443

PathArg

string[]

readdirSync(target, opts): Dirent[]

Defined in: src/polyfills/fs.ts:444

PathArg

true

Dirent[]

readdirSync(target, opts?): string[] | Dirent[] | Buffer<ArrayBufferLike>[]

Defined in: src/polyfills/fs.ts:445

PathArg

string | { encoding?: string; withFileTypes?: boolean; }

string[] | Dirent[] | Buffer<ArrayBufferLike>[]


readFile(target, cb): void

Defined in: src/polyfills/fs.ts:505

string

(err, data?) => void

void

readFile(target, opts, cb): void

Defined in: src/polyfills/fs.ts:509

string

string

(err, data?) => void

void


readFileSync(target): Buffer

Defined in: src/polyfills/fs.ts:424

PathArg

Buffer

readFileSync(target, enc): string

Defined in: src/polyfills/fs.ts:425

PathArg

BufferEncoding

string

readFileSync(target, opts): string

Defined in: src/polyfills/fs.ts:426

PathArg

BufferEncoding

string

readFileSync(target, opts): Buffer

Defined in: src/polyfills/fs.ts:427

PathArg

null

Buffer

readFileSync(target, encOrOpts?): string | Buffer<ArrayBufferLike>

Defined in: src/polyfills/fs.ts:428

PathArg

string | { encoding?: string | null; }

string | Buffer<ArrayBufferLike>


readlink(target, cb): void

Defined in: src/polyfills/fs.ts:559

string

(err, linkTarget?) => void

void


readlinkSync(target): string

Defined in: src/polyfills/fs.ts:461

PathArg

string


readSync(fd, buf, off, len, pos): number

Defined in: src/polyfills/fs.ts:473

number

Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>

number

number

number | null

number


readv(fd, buffers, posOrCb?, cb?): void

Defined in: src/polyfills/fs.ts:597

number

ArrayBufferView<ArrayBufferLike>[]

unknown

unknown

void


readvSync(fd, buffers, pos?): number

Defined in: src/polyfills/fs.ts:596

number

ArrayBufferView<ArrayBufferLike>[]

number | null

number


realpath(target, cb): void

Defined in: src/polyfills/fs.ts:546

string

(err, resolved?) => void

void


rename(oldPath, newPath, cb): void

Defined in: src/polyfills/fs.ts:545

string

string

(err) => void

void


renameSync(src, dest): void

Defined in: src/polyfills/fs.ts:454

PathArg

PathArg

void


rmdir(target, cb): void

Defined in: src/polyfills/fs.ts:544

string

(err) => void

void


rmdirSync(target): void

Defined in: src/polyfills/fs.ts:453

PathArg

void


rmSync(target, opts?): void

Defined in: src/polyfills/fs.ts:491

string

RmOptions

void


stat(target, cb): void

Defined in: src/polyfills/fs.ts:524

string

(err, stats?) => void

void


statfs(target, optsOrCb?, cb?): void

Defined in: src/polyfills/fs.ts:601

unknown

unknown

unknown

void


statfsSync(target, opts?): StatFs

Defined in: src/polyfills/fs.ts:600

unknown

unknown

StatFs


statSync(target, opts?): FileStat | undefined

Defined in: src/polyfills/fs.ts:449

PathArg

StatOptions

FileStat | undefined


symlink(target, path, cb): void

Defined in: src/polyfills/fs.ts:552

string

string

(err) => void

void

symlink(target, path, type, cb): void

Defined in: src/polyfills/fs.ts:553

string

string

string

(err) => void

void


symlinkSync(target, path, type?): void

Defined in: src/polyfills/fs.ts:460

PathArg

PathArg

string

void


truncate(target, lenOrCb?, cb?): void

Defined in: src/polyfills/fs.ts:609

unknown

unknown

unknown

void


truncateSync(target, len?): void

Defined in: src/polyfills/fs.ts:465

PathArg

number

void


unlink(target, cb): void

Defined in: src/polyfills/fs.ts:543

string

(err) => void

void


unlinkSync(target): void

Defined in: src/polyfills/fs.ts:452

PathArg

void


unwatchFile(filename, listener?): void

Defined in: src/polyfills/fs.ts:498

unknown

unknown

void


watch(filename, opts?, listener?): FileWatchHandle

Defined in: src/polyfills/fs.ts:499

string

boolean

boolean

WatchCallback

FileWatchHandle

watch(filename, listener?): FileWatchHandle

Defined in: src/polyfills/fs.ts:504

string

WatchCallback

FileWatchHandle


watchFile(filename, optsOrListener?, listener?): StatWatcher

Defined in: src/polyfills/fs.ts:493

unknown

unknown

unknown

StatWatcher


writeFile(target, data, cb): void

Defined in: src/polyfills/fs.ts:514

string

string | Uint8Array<ArrayBufferLike>

(err) => void

void


writeFileSync(target, data, opts?): void

Defined in: src/polyfills/fs.ts:432

PathArg

string | Uint8Array<ArrayBufferLike>

string | WriteFileOptions

void


writeSync(fd, buf, off?, len?, pos?): number

Defined in: src/polyfills/fs.ts:480

number

string | Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>

number

number

number | null

number