Id64.iterate Function

Deprecated  use Id64.iterable.

Execute a function on each Id64String of an Id64Arg, optionally terminating before iteration completes.

iterate(arg: Id64Arg, callback: (id: string) => boolean): boolean

Parameter Type Description
arg Id64Arg The Id(s) to iterate.
callback (id: string) => boolean The function to invoke on each Id. The function returns false to terminate iteration, or true to continue iteration.

Returns - boolean

True if all Ids were iterated, or false if iteration was terminated due to the callback returning false.

Defined in

Last Updated: 12 June, 2024