Bruce Pascoe: Note that return value is iterator-like

2017-08-17T16:32:33Z

Note that return value is iterator-like

Bruce Pascoe: Add page for DirectoryStream::next()

2017-08-15T18:31:45Z

Add page for DirectoryStream::next()

New page

{{DISPLAYTITLE:DirectoryStream::next()}}

The '''<tt>DirectoryStream::next()</tt>''' method reads the next directory entry from a directory stream.

===== Usage =====

''dir_entry'' = ''dirstream_obj''.'''next'''();

__TOC__

== API Information ==

=== Description ===

<tt>'''DirectoryStream::next()'''</tt> reads the next directory entry from the stream and advances the stream position. The value of <tt>[[API:DirectoryStream::position|DirectoryStream::position]]</tt> determines which entry is read.

=== Parameters ===

This method has no parameters.

=== Return Value ===

An object with two properties, <tt>.done</tt> and <tt>.value</tt>. If there are no more entries to retrieve, <tt>.done</tt> is <tt>true</tt> and <tt>.value</tt> is <tt>undefined</tt>. Otherwise, <tt>.done</tt> is <tt>false</tt> and <tt>.value</tt> is an object describing the directory entry:

:{| class="wikitable"
!Property
!Type
!Description
|-
|<tt>.fileName</tt>
|style="text-align: center;"|''string''
|The name of the file or directory, e.g. <tt>pig.js</tt>. If the entry is a directory, <tt>.fileName</tt> will end in a slash (<tt>/</tt>).
|-
|<tt>.fullPath</tt>
|style="text-align: center;"|''string''
|The full SphereFS pathname of the file or directory, e.g. <tt>@/scripts/pig.js</tt>.
|-
|<tt>.isDirectory</tt>
|style="text-align: center;"|''boolean''
|<tt>true</tt> if the entry is a directory, otherwise <tt>false</tt>.
|}

== See Also ==

<tt>
* [[API:DirectoryStream|new DirectoryStream()]]
* [[API:DirectoryStream::position|DirectoryStream::position]]
* [[API:DirectoryStream::rewind|DirectoryStream::rewind()]]
</tt>

[[Category:Sphere 2 API]]

@@ Line 21: / Line 21: @@
 === Return Value ===
-An object with two properties, <tt>.done</tt> and <tt>.value</tt>.  If there are no more entries to retrieve, <tt>.done</tt> is <tt>true</tt> and <tt>.value</tt> is <tt>undefined</tt>.  Otherwise, <tt>.done</tt> is <tt>false</tt> and <tt>.value</tt> is an object describing the directory entry:
+An object with two properties, <tt>.done</tt> and <tt>.value</tt>, with semantics compatible with the ES2015 iterator protocol.  If there are no more entries to retrieve, <tt>.done</tt> is <tt>true</tt> and <tt>.value</tt> is <tt>undefined</tt>.  Otherwise, <tt>.done</tt> is <tt>false</tt> and <tt>.value</tt> is an object describing the directory entry:
 :{| class="wikitable"

API:DirectoryStream::next - Revision history

Bruce Pascoe: Note that return value is iterator-like

Bruce Pascoe: Add page for DirectoryStream::next()