Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VolumeCollection

Describes a list of volumes with additional functions to access certain entries. You can iterate over the collection like the following:

const volumeCollection = piweb.data.getVolumeCollection();
for (let volume of volumeCollection)
{
    ...
}

Hierarchy

  • VolumeCollection

Index

Constructors

Accessors

Methods

Constructors

Private constructor

Accessors

length

  • get length(): number

  • Gets the total number of items in this collection.

    Returns number

Methods

Private __@iterator

  • __@iterator(): Iterator<Volume>

  • Returns Iterator<Volume>

findByEntity

findByName

  • findByName(...wildcards: string[]): Iter<Volume>

  • Returns the items that match one or more of the specified filter strings.

    Parameters

    • Rest ...wildcards: string[]

      One or more filter strings. Wildcards like '*' are allowed.

    Returns Iter<Volume>

Private first

  • Returns Volume | undefined

iter

  • Returns an iter over all volume items.

    Returns Iter<Volume>

Generated using TypeDoc