Options
All
  • Public
  • Public/Protected
  • All
Menu

Allows the contents of a directory (files and subdirectories) to be enumerated.

Hierarchy

  • DirectoryStream

Implements

Index

Constructors

constructor

  • Constructs a new DirectoryStream to enumerate the given directory.

    Parameters

    • directoryName: string

      SphereFS path to the directory whose contents will be enumerated.

    • Optional options: DirectoryStreamOptions

      Options for creating the new directory stream.

    Returns DirectoryStream

Properties

fileCount

fileCount: number

Total number of file and subdirectory entries in the directory.

fileName

fileName: string

SphereFS path to the directory being enumerated.

position

position: number

The current position within the stream of directory entries. Starts at 0.

Methods

__@iterator

dispose

  • dispose(): void
  • Clean up any resources held by this DirectoryStream after using it.

    Returns void

next

rewind

  • rewind(): void
  • Rewind this stream so the directory contents can be enumerated again.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc