Class Dirent<Name, TArrayBuffer>

Type Parameters

Name extends string | Buffer = string
TArrayBuffer extends ArrayBufferLike = ArrayBufferLike

Hierarchy

BufferView<TArrayBuffer>
- Dirent

Implements

Dirent<Name>

Constructors

constructor

new Dirent<
    Name extends string
    | Buffer<ArrayBufferLike> = string,
    TArrayBuffer extends ArrayBufferLike = ArrayBufferLike,
>(
    _buffer?:
        | number
        | ArrayLike<number>
        | TArrayBuffer
        | ArrayBufferView<TArrayBuffer>,
    _byteOffset?: number,
    _byteLength?: number,
): Dirent<Name, TArrayBuffer>
Type Parameters
- Name extends string | Buffer<ArrayBufferLike> = string
- TArrayBuffer extends ArrayBufferLike = ArrayBufferLike
Parameters
- Optional_buffer: number | ArrayLike<number> | TArrayBuffer | ArrayBufferView<TArrayBuffer>
- Optional_byteOffset: number
- Optional_byteLength: number
Returns Dirent<Name, TArrayBuffer>
Inherited from BufferView<TArrayBuffer>.constructor
- Defined in node_modules/utilium/dist/buffer.d.ts:240

Properties

`Protected` `Optional` `Internal`_encoding

_encoding?: null | "buffer" | BufferEncoding

`Protected` `Internal`_parentPath

_parentPath: string

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`buffer

buffer: TArrayBuffer

`Readonly`byteLength

byteLength: number

`Readonly`byteOffset

byteOffset: number

Accessors

`Protected`_name

_name: any

`Protected`ino

ino: any

name

get name(): Name
The file name that this fs.Dirent object refers to. The type of this value is determined by the options.encoding passed to readdir or readdirSync.

Returns Name
Since
v10.10.0
Implementation of _Dirent.name
- Defined in src/vfs/dir.ts:62

parentPath

get parentPath(): string
The path to the parent directory of the file this fs.Dirent object refers to.

Returns string
Since
v20.12.0, v18.20.0
Implementation of _Dirent.parentPath
- Defined in src/vfs/dir.ts:78

path

get path(): string
Returns string
Deprecated
Removed in Node v24, use parentPath instead.
- Defined in src/vfs/dir.ts:85

`Protected`type

type: any

Methods

getBigInt64

getBigInt64(byteOffset: number, littleEndian?: boolean): bigint
Gets the BigInt64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns bigint
Inherited from BufferView.getBigInt64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:734

getBigUint64

getBigUint64(byteOffset: number, littleEndian?: boolean): bigint
Gets the BigUint64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns bigint
Inherited from BufferView.getBigUint64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:742

getFloat16

getFloat16(byteOffset: number, littleEndian?: boolean): number
Gets the Float16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getFloat16
- Defined in node_modules/typescript/lib/lib.esnext.float16.d.ts:434

getFloat32

getFloat32(byteOffset: number, littleEndian?: boolean): number
Gets the Float32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getFloat32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1749

getFloat64

getFloat64(byteOffset: number, littleEndian?: boolean): number
Gets the Float64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getFloat64
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1757

getInt16

getInt16(byteOffset: number, littleEndian?: boolean): number
Gets the Int16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getInt16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1772

getInt32

getInt32(byteOffset: number, littleEndian?: boolean): number
Gets the Int32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getInt32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1779

getInt8

getInt8(byteOffset: number): number
Gets the Int8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
Returns number
Inherited from BufferView.getInt8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1764

getUint16

getUint16(byteOffset: number, littleEndian?: boolean): number
Gets the Uint16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getUint16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1794

getUint32

getUint32(byteOffset: number, littleEndian?: boolean): number
Gets the Uint32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getUint32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1802

getUint8

getUint8(byteOffset: number): number
Gets the Uint8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be retrieved.
Returns number
Inherited from BufferView.getUint8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1786

isBlockDevice

isBlockDevice(): boolean
Returns true if the fs.Dirent object describes a block device.

Returns boolean
Since
v10.10.0
Implementation of _Dirent.isBlockDevice
- Defined in src/vfs/dir.ts:109

isCharacterDevice

isCharacterDevice(): boolean
Returns true if the fs.Dirent object describes a character device.

Returns boolean
Since
v10.10.0
Implementation of _Dirent.isCharacterDevice
- Defined in src/vfs/dir.ts:112

isDirectory

isDirectory(): boolean
Returns true if the fs.Dirent object describes a file system directory.

Returns boolean
Since
v10.10.0
Implementation of _Dirent.isDirectory
- Defined in src/vfs/dir.ts:106

isFIFO

isFIFO(): boolean
Returns true if the fs.Dirent object describes a first-in-first-out (FIFO) pipe.

Returns boolean
Since
v10.10.0
Implementation of _Dirent.isFIFO
- Defined in src/vfs/dir.ts:118

isFile

isFile(): boolean
Returns true if the fs.Dirent object describes a regular file.

Returns boolean
Since
v10.10.0
Implementation of _Dirent.isFile
- Defined in src/vfs/dir.ts:103

isSocket

isSocket(): boolean
Returns true if the fs.Dirent object describes a socket.

Returns boolean
Since
v10.10.0
Implementation of _Dirent.isSocket
- Defined in src/vfs/dir.ts:121

isSymbolicLink

isSymbolicLink(): boolean
Returns true if the fs.Dirent object describes a symbolic link.

Returns boolean
Since
v10.10.0
Implementation of _Dirent.isSymbolicLink
- Defined in src/vfs/dir.ts:115

setBigInt64

setBigInt64(byteOffset: number, value: bigint, littleEndian?: boolean): void
Stores a BigInt64 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: bigint
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setBigInt64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:750

setBigUint64

setBigUint64(byteOffset: number, value: bigint, littleEndian?: boolean): void
Stores a BigUint64 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: bigint
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setBigUint64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:758

setFloat16

setFloat16(byteOffset: number, value: number, littleEndian?: boolean): void
Stores an Float16 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setFloat16
- Defined in node_modules/typescript/lib/lib.esnext.float16.d.ts:442

setFloat32

setFloat32(byteOffset: number, value: number, littleEndian?: boolean): void
Stores an Float32 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setFloat32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1810

setFloat64

setFloat64(byteOffset: number, value: number, littleEndian?: boolean): void
Stores an Float64 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setFloat64
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1818

setInt16

setInt16(byteOffset: number, value: number, littleEndian?: boolean): void
Stores an Int16 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setInt16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1833

setInt32

setInt32(byteOffset: number, value: number, littleEndian?: boolean): void
Stores an Int32 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setInt32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1841

setInt8

setInt8(byteOffset: number, value: number): void
Stores an Int8 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
Returns void
Inherited from BufferView.setInt8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1825

setUint16

setUint16(byteOffset: number, value: number, littleEndian?: boolean): void
Stores an Uint16 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setUint16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1856

setUint32

setUint32(byteOffset: number, value: number, littleEndian?: boolean): void
Stores an Uint32 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setUint32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1864

setUint8

setUint8(byteOffset: number, value: number): void
Stores an Uint8 value at the specified byte offset from the start of the view.
Parameters
- byteOffset: number
  The place in the buffer at which the value should be set.
- value: number
  The value to set.
Returns void
Inherited from BufferView.setUint8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1848

`Static`from

from(
    path: string,
    stats: InodeLike,
    encoding?: null | "buffer" | BufferEncoding,
): Dirent
Internal
Parameters
- path: string
- stats: InodeLike
- Optionalencoding: null | "buffer" | BufferEncoding
Returns Dirent
- Defined in src/vfs/dir.ts:93

Class Dirent<Name, TArrayBuffer>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Dirent<Name, TArrayBuffer>

Properties

Protected Optional Internal_encoding

Protected Internal_parentPath

Readonly[toStringTag]

Readonlybuffer

ReadonlybyteLength

ReadonlybyteOffset

Accessors

Protected_name

Protectedino

name

Returns Name

Since

parentPath

Returns string

Since

path

Returns string

Deprecated

Protectedtype

Methods

getBigInt64

Parameters

Returns bigint

getBigUint64

Parameters

Returns bigint

getFloat16

Parameters

Returns number

getFloat32

Parameters

Returns number

getFloat64

Parameters

Returns number

getInt16

Parameters

Returns number

getInt32

Parameters

Returns number

getInt8

Parameters

Returns number

getUint16

Parameters

Returns number

getUint32

Parameters

Returns number

getUint8

Parameters

Returns number

isBlockDevice

Returns boolean

Since

isCharacterDevice

Returns boolean

Since

isDirectory

Returns boolean

Since

isFIFO

Returns boolean

Since

`Protected` `Optional` `Internal`_encoding

`Protected` `Internal`_parentPath

`Readonly`[toStringTag]

`Readonly`buffer

`Readonly`byteLength

`Readonly`byteOffset

`Protected`_name

`Protected`ino

`Protected`type

`Static`from