Readdir

[<Interface>]
type Readdir =
    abstract member Invoke (path: PathLike, options: Options5, callback: Callback6) : unit
    abstract member Invoke (path: PathLike, options: Options4, callback: Callback5) : unit
    abstract member Invoke (path: PathLike, callback: Callback4) : unit
    abstract member Invoke (path: PathLike, options: U2<string,Options3> option, callback: Callback3) : unit
    abstract member Invoke (path: PathLike, options: U2<string,Options2>, callback: Callback2) : unit
    abstract member Invoke (path: PathLike, options: U2<string,Options> option, callback: Callback) : unit
    abstract member __promisify__ (path: PathLike, options: Options5) : Promise<Dirent<NonSharedBuffer> array>
    abstract member __promisify__ (path: PathLike, options: Options4) : Promise<Dirent<string> array>
    abstract member __promisify__ (path: PathLike, ?options: U2<string,Options3>) : Promise<U2<string array,NonSharedBuffer array>>
    abstract member __promisify__ (path: PathLike, options: U2<string,Options2>) : Promise<NonSharedBuffer array>
    abstract member __promisify__ (path: PathLike, ?options: U2<string,Options>) : Promise<string array>


Assembly	`Xantham.Fable.Node`

Declared inside


`Callback`
`Callback2`
`Callback3`
`Callback4`
`Callback5`
`Callback6`
`Options`
`Options2`
`Options3`
`Options4`
`Options5`
`Promisify`

Methods

abstract member Invoke (path: PathLike, options: Options5, callback: Callback6) : unit

Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

See the POSIX readdir(3) documentation for more details.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects. Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member Invoke (path: PathLike, options: Options4, callback: Callback5) : unit

Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

See the POSIX readdir(3) documentation for more details.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects. Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member Invoke (path: PathLike, callback: Callback4) : unit

Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

See the POSIX readdir(3) documentation for more details.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects. Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member Invoke (path: PathLike, options: U2<string,Options3> option, callback: Callback3) : unit

Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

See the POSIX readdir(3) documentation for more details.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects. Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member Invoke (path: PathLike, options: U2<string,Options2>, callback: Callback2) : unit

Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

See the POSIX readdir(3) documentation for more details.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects. Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member Invoke (path: PathLike, options: U2<string,Options> option, callback: Callback) : unit

Reads the contents of a directory. The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.

See the POSIX readdir(3) documentation for more details.

The optional options argument can be a string specifying an encoding, or an object with an encoding property specifying the character encoding to use for the filenames passed to the callback. If the encoding is set to 'buffer', the filenames returned will be passed as Buffer objects.

If options.withFileTypes is set to true, the files array will contain fs.Dirent objects. Asynchronous readdir(3) - read a directory.

@since v0.1.8

abstract member __promisify__ (path: PathLike, options: Options5) : Promise<Dirent<NonSharedBuffer> array>

Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member __promisify__ (path: PathLike, options: Options4) : Promise<Dirent<string> array>

Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member __promisify__ (path: PathLike, ?options: U2<string,Options3>) : Promise<U2<string array,NonSharedBuffer array>>

Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member __promisify__ (path: PathLike, options: U2<string,Options2>) : Promise<NonSharedBuffer array>

Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.

abstract member __promisify__ (path: PathLike, ?options: U2<string,Options>) : Promise<string array>

Asynchronous readdir(3) - read a directory.

Parameter
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	If called with `withFileTypes: true` the result data will be an array of Dirent
`path`	A path to a file. If a URL is provided, it must use the `file:` protocol.
`options`	Must include `withFileTypes: true` and `encoding: 'buffer'`.