getNodesIterator Method

Deprecated  in 5.2. Use the new @itwin/presentation-hierarchies

package for creating hierarchies.

Returns an iterator that polls nodes asynchronously.

getNodesIterator(requestOptions: HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute & { batchSize?: number, maxParallelRequests?: number } & { paging?: PageOptions }): Promise<{ items: AsyncIterableIterator<Node, any, any>, total: number }>

Parameter Type Description
requestOptions HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute & { batchSize?: number, maxParallelRequests?: number } & { paging?: PageOptions }  

Returns - Promise<{ items: AsyncIterableIterator<Node, any, any>, total: number }>

Defined in

Last Updated: 04 September, 2025