DirList Event

Fired when a directory entry is received.

Syntax

sftp.on('DirList', [callback])

Callback

The 'callback' is called when the 'DirList' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.dirEntry
e.fileName
e.isDir
e.fileSize
e.fileTime

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.

The format of the FileTime parameter returned by the class can be controlled through the FileTimeFormat configuration setting. If no format is specified, the class will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm", otherwise it will be formatted as "MMM dd yyyy".