# fs.readdir.options

options for readdir and readdirSync methods

Availability
8.3.0
8.3.0
9.2.0
Extends
Object

NOTE

This is an abstract type. Any object of this structure can be used where this type is used.

# Properties

# encoding

Availability
8.3.0
8.3.0
9.2.0
encoding :String

If the encoding is set to 'buffer', the filenames returned will be passed as buffer.Buffer objects.

Default: utf8


# withFileTypes

Availability
8.3.0
8.3.0
9.2.0
withFileTypes :Boolean

If true, the results will be returned as fs.Dirents

Default: false