TarFS

Defined in: src/tar/fs.ts:22

Extends

• ReadonlyMixin & AsyncFSMethods<this> & FileSystem<this>

Constructors

Constructor

new TarFS(options): TarFS

Defined in: src/tar/fs.ts:30

Parameters

options

TarOptions

Returns

TarFS

Overrides

Readonly(Sync(FileSystem)).constructor

Properties

_mountPoint?

protected optional _mountPoint?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:143

Internal

The last place this file system was mounted

Inherited from

Readonly(Sync(FileSystem))._mountPoint

---

_uuid

protected _uuid: `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:149

Internal

The UUID of the file system.

Inherited from

Readonly(Sync(FileSystem))._uuid

---

attributes

readonly attributes: ConstMap<FileSystemAttributes, keyof FileSystemAttributes, void | CaseFold | undefined> & Map<string, any>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:154

See

FileSystemAttributes

Inherited from

Readonly(Sync(FileSystem)).attributes

---

data

protected data: Uint8Array

Defined in: src/tar/fs.ts:23

---

directories

protected directories: Map<string, Set<string>>

Defined in: src/tar/fs.ts:25

---

files

protected files: Map<string, Uint8Array<ArrayBufferLike>>

Defined in: src/tar/fs.ts:24

---

inodes

protected inodes: Map<string, Inode>

Defined in: src/tar/fs.ts:27

---

label?

optional label?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:138

Inherited from

Readonly(Sync(FileSystem)).label

---

name

readonly name: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:137

The name for this file system. For example, tmpfs for an in memory one

Inherited from

Readonly(Sync(FileSystem)).name

---

options

readonly options: TarOptions

Defined in: src/tar/fs.ts:30

---

type

readonly type: number

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:132

A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something

Inherited from

Readonly(Sync(FileSystem)).type

Accessors

uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}`

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:150

Returns

`${string}-${string}-${string}-${string}-${string}`

Inherited from

Readonly(Sync(FileSystem)).uuid

Methods

createFile()

Call Signature

createFile(path, flag, mode): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:10

Parameters

path

string

flag

string

mode

number

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).createFile

Call Signature

createFile(path, options): Promise<InodeLike<number>>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:186

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Readonly(Sync(FileSystem)).createFile

---

createFileSync()

Call Signature

createFileSync(path, flag, mode): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:11

Parameters

path

string

flag

string

mode

number

Returns

never

Inherited from

Readonly(Sync(FileSystem)).createFileSync

Call Signature

createFileSync(path, options): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:190

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Inherited from

Readonly(Sync(FileSystem)).createFileSync

---

exists()

exists(path): Promise<boolean>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:202

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

ZipFS.exists

---

existsSync()

existsSync(path): boolean

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:206

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

Readonly(Sync(FileSystem)).existsSync

---

link()

Call Signature

link(srcpath, dstpath): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:18

Parameters

srcpath

string

dstpath

string

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).link

Call Signature

link(target, link): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:207

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).link

---

linkSync()

Call Signature

linkSync(srcpath, dstpath): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:19

Parameters

srcpath

string

dstpath

string

Returns

never

Inherited from

Readonly(Sync(FileSystem)).linkSync

Call Signature

linkSync(target, link): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:208

Parameters

target

string

link

string

Returns

void

Inherited from

Readonly(Sync(FileSystem)).linkSync

---

mkdir()

Call Signature

mkdir(path, mode): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:16

Parameters

path

string

mode

number

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).mkdir

Call Signature

mkdir(path, options): Promise<InodeLike<number>>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:195

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Readonly(Sync(FileSystem)).mkdir

---

mkdirSync()

Call Signature

mkdirSync(path, mode): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:17

Parameters

path

string

mode

number

Returns

never

Inherited from

Readonly(Sync(FileSystem)).mkdirSync

Call Signature

mkdirSync(path, options): InodeLike

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:196

Parameters

path

string

options

CreationOptions

Returns

InodeLike

Inherited from

Readonly(Sync(FileSystem)).mkdirSync

---

read()

abstract read(path, buffer, start, end): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:217

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

start

number

The offset into the file to start reading from

end

number

The position in the file to stop reading

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).read

---

readdir()

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

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:197

Parameters

path

string

Returns

Promise<string[]>

Inherited from

Readonly(Sync(FileSystem)).readdir

---

readdirSync()

readdirSync(path): string[]

Defined in: src/tar/fs.ts:100

Parameters

path

string

Returns

string[]

Overrides

Readonly(Sync(FileSystem)).readdirSync

---

readSync()

readSync(path, buffer, offset, end): void

Defined in: src/tar/fs.ts:110

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

offset

number

end

number

The position in the file to stop reading

Returns

void

Overrides

Readonly(Sync(FileSystem)).readSync

---

ready()

ready(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:173

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).ready

---

readySync()

readySync(): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:174

Returns

void

Inherited from

Readonly(Sync(FileSystem)).readySync

---

rename()

Call Signature

rename(oldPath, newPath): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:8

Parameters

oldPath

string

newPath

string

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).rename

Call Signature

rename(oldPath, newPath): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:175

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).rename

---

renameSync()

Call Signature

renameSync(oldPath, newPath): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:9

Parameters

oldPath

string

newPath

string

Returns

never

Inherited from

Readonly(Sync(FileSystem)).renameSync

Call Signature

renameSync(oldPath, newPath): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:176

Parameters

oldPath

string

newPath

string

Returns

void

Inherited from

Readonly(Sync(FileSystem)).renameSync

---

rmdir()

Call Signature

rmdir(path): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:14

Parameters

path

string

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).rmdir

Call Signature

rmdir(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:193

Parameters

path

string

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).rmdir

---

rmdirSync()

Call Signature

rmdirSync(path): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:15

Parameters

path

string

Returns

never

Inherited from

Readonly(Sync(FileSystem)).rmdirSync

Call Signature

rmdirSync(path): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:194

Parameters

path

string

Returns

void

Inherited from

Readonly(Sync(FileSystem)).rmdirSync

---

stat()

abstract stat(path): Promise<InodeLike<number>>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:177

Parameters

path

string

Returns

Promise<InodeLike<number>>

Inherited from

Readonly(Sync(FileSystem)).stat

---

statSync()

statSync(path): Inode

Defined in: src/tar/fs.ts:93

Parameters

path

string

Returns

Inode

Overrides

Readonly(Sync(FileSystem)).statSync

---

streamRead()

streamRead(path, options): ReadableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:241

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

Readonly(Sync(FileSystem)).streamRead

---

streamWrite()

streamWrite(path, options): WritableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:246

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

Readonly(Sync(FileSystem)).streamWrite

---

sync()

Call Signature

sync(): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:22

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).sync

Call Signature

sync(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:209

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).sync

---

syncSync()

Call Signature

syncSync(): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:23

Returns

never

Inherited from

Readonly(Sync(FileSystem)).syncSync

Call Signature

syncSync(): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:210

Returns

void

Inherited from

Readonly(Sync(FileSystem)).syncSync

---

toString()

toString(): string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:166

Returns

string

Inherited from

Readonly(Sync(FileSystem)).toString

---

touch()

Call Signature

touch(path, metadata): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:20

Parameters

path

string

metadata

Readonly<InodeLike>

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).touch

Call Signature

touch(path, metadata): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:180

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).touch

---

touchSync()

Call Signature

touchSync(path, metadata): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:21

Parameters

path

string

metadata

Readonly<InodeLike>

Returns

never

Inherited from

Readonly(Sync(FileSystem)).touchSync

Call Signature

touchSync(path, metadata): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:182

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Inherited from

Readonly(Sync(FileSystem)).touchSync

---

unlink()

Call Signature

unlink(path): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:12

Parameters

path

string

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).unlink

Call Signature

unlink(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:191

Parameters

path

string

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).unlink

---

unlinkSync()

Call Signature

unlinkSync(path): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:13

Parameters

path

string

Returns

never

Inherited from

Readonly(Sync(FileSystem)).unlinkSync

Call Signature

unlinkSync(path): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:192

Parameters

path

string

Returns

void

Inherited from

Readonly(Sync(FileSystem)).unlinkSync

---

usage()

usage(): UsageInfo

Defined in: src/tar/fs.ts:86

Default implementation.

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

UsageInfo

Todo

Implement

Overrides

Readonly(Sync(FileSystem)).usage

---

write()

Call Signature

write(path, buffer, offset): Promise<never>

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:24

Parameters

path

string

buffer

Uint8Array

offset

number

Returns

Promise<never>

Inherited from

Readonly(Sync(FileSystem)).write

Call Signature

write(path, buffer, offset): Promise<void>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:230

Writes a buffer to a file

Parameters

path

string

buffer

Uint8Array

The buffer to write. You must set the byteOffset and byteLength appropriately!

offset

number

The offset in the file to start writing

Returns

Promise<void>

Inherited from

Readonly(Sync(FileSystem)).write

---

writeSync()

Call Signature

writeSync(path, buffer, offset): never

Defined in: node_modules/@zenfs/core/dist/mixins/readonly.d.ts:25

Parameters

path

string

buffer

Uint8Array

offset

number

Returns

never

Inherited from

Readonly(Sync(FileSystem)).writeSync

Call Signature

writeSync(path, buffer, offset): void

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:236

Writes a buffer to a file

Parameters

path

string

buffer

Uint8Array

The buffer to write. You must set the byteOffset and byteLength appropriately!

offset

number

The offset in the file to start writing

Returns

void

Inherited from

Readonly(Sync(FileSystem)).writeSync