ConfigFS

Defined in: src/fs/configfs.ts:14

See

https://www.kernel.org/doc/html/latest/filesystems/configfs.html

Todo

Extends

AsyncFSMethods<this> & FileSystem<this>

Constructors

Constructor

new ConfigFS(): ConfigFS

Defined in: src/fs/configfs.ts:15

Returns

ConfigFS

Overrides

Sync(FileSystem).constructor

Properties

_mountPoint?

protected optional _mountPoint?: string

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

Internal

The last place this file system was mounted

Inherited from

Sync(FileSystem)._mountPoint

_uuid

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

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

Internal

The UUID of the file system.

Inherited from

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:155

See

FileSystemAttributes

Inherited from

DebugFS.attributes

label?

optional label?: string

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

Inherited from

Sync(FileSystem).label

name

readonly name: string

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

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

Inherited from

Sync(FileSystem).name

type

readonly type: number

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

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

Inherited from

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:151

Returns

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

Inherited from

Sync(FileSystem).uuid

Methods

createFile()

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

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

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).createFile

createFileSync()

createFileSync(): InodeLike

Defined in: src/fs/configfs.ts:31

Create the file at path with the given options.

Returns

InodeLike

Overrides

Sync(FileSystem).createFileSync

exists()

exists(path): Promise<boolean>

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

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

DevTmpFS.exists

existsSync()

existsSync(path): boolean

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

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

Sync(FileSystem).existsSync

ioctl()

ioctl(context, command, …args): Promise<any>

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

Promise<any>

Inherited from

Sync(FileSystem).ioctl

ioctlSync()

ioctlSync(context, command, …args): any

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

any

Inherited from

Sync(FileSystem).ioctlSync

link()

abstract link(target, link): Promise<void>

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

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).link

linkSync()

linkSync(): void

Defined in: src/fs/configfs.ts:51

Returns

void

Overrides

Sync(FileSystem).linkSync

mkdir()

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

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

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).mkdir

mkdirSync()

mkdirSync(): InodeLike

Defined in: src/fs/configfs.ts:43

Returns

InodeLike

Overrides

Sync(FileSystem).mkdirSync

read()

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

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

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

Sync(FileSystem).read

readdir()

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

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

Parameters

path

string

Returns

Promise<string[]>

Inherited from

Sync(FileSystem).readdir

readdirSync()

readdirSync(path): string[]

Defined in: src/fs/configfs.ts:47

Parameters

path

string

Returns

string[]

Overrides

Sync(FileSystem).readdirSync

readSync()

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

Defined in: src/fs/configfs.ts:59

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

void

Overrides

Sync(FileSystem).readSync

ready()

ready(): Promise<void>

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

Returns

Promise<void>

Inherited from

Sync(FileSystem).ready

readySync()

readySync(): void

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

Returns

void

Inherited from

Sync(FileSystem).readySync

rename()

abstract rename(oldPath, newPath): Promise<void>

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

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).rename

renameSync()

renameSync(oldPath, newPath): void

Defined in: src/fs/configfs.ts:19

Parameters

oldPath

string

newPath

string

Returns

void

Overrides

Sync(FileSystem).renameSync

rmdir()

abstract rmdir(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).rmdir

rmdirSync()

rmdirSync(): void

Defined in: src/fs/configfs.ts:39

Returns

void

Overrides

Sync(FileSystem).rmdirSync

stat()

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

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

Parameters

path

string

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).stat

statSync()

statSync(path): InodeLike

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

Parameters

path

string

Returns

InodeLike

Overrides

Sync(FileSystem).statSync

streamRead()

streamRead(path, options): ReadableStream

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

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

Sync(FileSystem).streamRead

streamWrite()

streamWrite(path, options): WritableStream

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

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

Sync(FileSystem).streamWrite

sync()

abstract sync(): Promise<void>

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

Returns

Promise<void>

Inherited from

Sync(FileSystem).sync

syncSync()

syncSync(): void

Defined in: src/fs/configfs.ts:55

Returns

void

Overrides

Sync(FileSystem).syncSync

toString()

toString(): string

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

Returns

string

Inherited from

Sync(FileSystem).toString

touch()

abstract touch(path, metadata): Promise<void>

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

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

Promise<void>

Inherited from

Sync(FileSystem).touch

touchSync()

touchSync(path, metadata): void

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

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Overrides

Sync(FileSystem).touchSync

unlink()

abstract unlink(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).unlink

unlinkSync()

unlinkSync(): void

Defined in: src/fs/configfs.ts:35

Returns

void

Overrides

Sync(FileSystem).unlinkSync

usage()

usage(): UsageInfo

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

Default implementation.

Returns

UsageInfo

Todo

Implement

Inherited from

Sync(FileSystem).usage

write()

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

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

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

Sync(FileSystem).write

writeSync()

writeSync(path, buffer, offset): void

Defined in: src/fs/configfs.ts:63

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

Overrides

Sync(FileSystem).writeSync

Contribute Sponsor