ZenFS
    Preparing search index...

    Class Dirent<Name, TArrayBuffer>

    Type Parameters

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

    Hierarchy

    • {
          "[toStringTag]": string;
          buffer: any;
          byteLength: number;
          byteOffset: number;
          constructor: StructConstructor<object>;
          getBigInt64(byteOffset: number, littleEndian?: boolean): bigint;
          getBigUint64(byteOffset: number, littleEndian?: boolean): bigint;
          getFloat16(byteOffset: number, littleEndian?: boolean): number;
          getFloat32(byteOffset: number, littleEndian?: boolean): number;
          getFloat64(byteOffset: number, littleEndian?: boolean): number;
          getInt16(byteOffset: number, littleEndian?: boolean): number;
          getInt32(byteOffset: number, littleEndian?: boolean): number;
          getInt8(byteOffset: number): number;
          getUint16(byteOffset: number, littleEndian?: boolean): number;
          getUint32(byteOffset: number, littleEndian?: boolean): number;
          getUint8(byteOffset: number): number;
          setBigInt64(
              byteOffset: number,
              value: bigint,
              littleEndian?: boolean,
          ): void;
          setBigUint64(
              byteOffset: number,
              value: bigint,
              littleEndian?: boolean,
          ): void;
          setFloat16(byteOffset: number, value: number, littleEndian?: boolean): void;
          setFloat32(byteOffset: number, value: number, littleEndian?: boolean): void;
          setFloat64(byteOffset: number, value: number, littleEndian?: boolean): void;
          setInt16(byteOffset: number, value: number, littleEndian?: boolean): void;
          setInt32(byteOffset: number, value: number, littleEndian?: boolean): void;
          setInt8(byteOffset: number, value: number): void;
          setUint16(byteOffset: number, value: number, littleEndian?: boolean): void;
          setUint32(byteOffset: number, value: number, littleEndian?: boolean): void;
          setUint8(byteOffset: number, value: number): void;
      }
      • Dirent

    Implements

    Index

    Constructors

    constructor

    Properties

    _encoding? _parentPath [toStringTag] buffer byteLength byteOffset constructor alignment array? fields isUnion name size

    Accessors

    _name ino name parentPath path type

    Methods

    getBigInt64 getBigUint64 getFloat16 getFloat32 getFloat64 getInt16 getInt32 getInt8 getUint16 getUint32 getUint8 isBlockDevice isCharacterDevice isDirectory isFIFO isFile isSocket isSymbolicLink setBigInt64 setBigUint64 setFloat16 setFloat32 setFloat64 setInt16 setInt32 setInt8 setUint16 setUint32 setUint8 from get set

    Constructors

    • Type Parameters

      • Name extends string | Buffer<ArrayBufferLike> = string
      • TArrayBuffer extends ArrayBufferLike = ArrayBufferLike

      Parameters

      • Optionalbuffer: TArrayBuffer
      • OptionalbyteOffset: number
      • OptionalbyteLength: number

      Returns Dirent<Name>

    Properties

    Protected Optional Internal_encoding

    _encoding?: null | "buffer" | BufferEncoding

    Protected Internal_parentPath

    _parentPath: string
    "[toStringTag]": string
    buffer: any

    The ArrayBuffer instance referenced by the array.

    byteLength: number

    The length in bytes of the array.

    byteOffset: number

    The offset in bytes of the array.

    constructor: StructConstructor<object>

    The initial value of Object.prototype.constructor is the standard built-in Object constructor.

    alignment: number
    array?: TypeArrayConstructor<BufferView<any> & ArrayBufferView<ArrayBufferLike>>
    fields: {
        "[toStringTag]": Field<Type<string>>;
        buffer: Field;
        byteLength: Field<Type<number>>;
        byteOffset: Field<Type<number>>;
        getBigInt64: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => bigint>,
        >;
        getBigUint64: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => bigint>,
        >;
        getFloat16: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => number>,
        >;
        getFloat32: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => number>,
        >;
        getFloat64: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => number>,
        >;
        getInt16: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => number>,
        >;
        getInt32: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => number>,
        >;
        getInt8: Field<Type<(byteOffset: number) => number>>;
        getUint16: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => number>,
        >;
        getUint32: Field<
            Type<(byteOffset: number, littleEndian?: boolean) => number>,
        >;
        getUint8: Field<Type<(byteOffset: number) => number>>;
        setBigInt64: Field<
            Type<
                (byteOffset: number, value: bigint, littleEndian?: boolean) => void,
            >,
        >;
        setBigUint64: Field<
            Type<
                (byteOffset: number, value: bigint, littleEndian?: boolean) => void,
            >,
        >;
        setFloat16: Field<
            Type<
                (byteOffset: number, value: number, littleEndian?: boolean) => void,
            >,
        >;
        setFloat32: Field<
            Type<
                (byteOffset: number, value: number, littleEndian?: boolean) => void,
            >,
        >;
        setFloat64: Field<
            Type<
                (byteOffset: number, value: number, littleEndian?: boolean) => void,
            >,
        >;
        setInt16: Field<
            Type<
                (byteOffset: number, value: number, littleEndian?: boolean) => void,
            >,
        >;
        setInt32: Field<
            Type<
                (byteOffset: number, value: number, littleEndian?: boolean) => void,
            >,
        >;
        setInt8: Field<Type<(byteOffset: number, value: number) => void>>;
        setUint16: Field<
            Type<
                (byteOffset: number, value: number, littleEndian?: boolean) => void,
            >,
        >;
        setUint32: Field<
            Type<
                (byteOffset: number, value: number, littleEndian?: boolean) => void,
            >,
        >;
        setUint8: Field<Type<(byteOffset: number, value: number) => void>>;
    }
    isUnion: boolean
    name: string
    size: number

    Accessors

    Protected_name

    _name: any
    ino: any
    • 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

      v10.10.0

    • get parentPath(): string

      The path to the parent directory of the file this fs.Dirent object refers to.

      Returns string

      v20.12.0, v18.20.0

    • get path(): string

      Returns string

      Removed in Node v24, use parentPath instead.

    type: any

    Methods

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • Returns true if the fs.Dirent object describes a block device.

      Returns boolean

      v10.10.0

    • Returns true if the fs.Dirent object describes a character device.

      Returns boolean

      v10.10.0

    • Returns true if the fs.Dirent object describes a file system directory.

      Returns boolean

      v10.10.0

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

      Returns boolean

      v10.10.0

    • Returns true if the fs.Dirent object describes a regular file.

      Returns boolean

      v10.10.0

    • Returns true if the fs.Dirent object describes a socket.

      Returns boolean

      v10.10.0

    • Returns true if the fs.Dirent object describes a symbolic link.

      Returns boolean

      v10.10.0

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • Internal

      Parameters

      • path: string
      • stats: InodeLike
      • Optionalencoding: null | "buffer" | BufferEncoding

      Returns Dirent

    • Get a value from a buffer

      Parameters

      • this: void
      • buffer: ArrayBufferLike
      • offset: number

      Returns BufferView<any> & ArrayBufferView<ArrayBufferLike>

    • Set a value in a buffer

      Parameters

      • this: void
      • buffer: ArrayBufferLike
      • offset: number
      • value: BufferView<any> & ArrayBufferView<ArrayBufferLike>

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods