ICollection¶

Interface ICollection

Hierarchy

ICollection

Index

Methods

clear copy forNodes forRootNodes getNodeCount

Methods

clear

clear(): void
Removes all elements from a collection without deleting the collection itself.

Returns void

copy

copy(other): void
Creates a copy of a given collection.
Parameters
- other: ICollection
  
  A ICollection object.
Returns void

forNodes

forNodes(callback): Promise<any>
Applies a callback on all elements of a collection.
Parameters
- callback: ((nodeID) => Promise<any>)
  
  The callback function.
  - - (nodeID): Promise<any>
    - Parameters
      
      nodeID: number
      
      Returns Promise<any>
Returns Promise<any>

forRootNodes

forRootNodes(callback): Promise<any>
Applies a callback on all root node elements of a collection.
Parameters
- callback: ((nodeID) => Promise<any>)
  
  The callback function.
  - - (nodeID): Promise<any>
    - Parameters
      
      nodeID: number
      
      Returns Promise<any>
Returns Promise<any>

getNodeCount

getNodeCount(): number
Returns number
The number of elements inside a collection.