Function loop

loop<Tinput, Toptions, Titem, TidxKey, TloopCallbacks>(input, options?, callbacks?): GetLoopGenerator<Tinput, Toptions, TloopCallbacks>
@todo: Write docs for loop() - accepts any input value (usually a "collection" or a container of other nested items) and returns a Generator (actually a LoopGenerator) blah blah
Type Parameters
- Tinput extends unknown
- Toptions extends ILoopOptions<Titem, TidxKey, Tinput, any, any>
- Titem extends object | Primitive = LoopKeysOrValues<Tinput, Toptions, false, false>
- TidxKey extends null | "ERROR: LoopKeysOrValues: Unsupported **input type**, neither `extends object` nor `extends Primitive` (weird, what is it?)" = LoopKeysOrValues<Tinput, Toptions, true, false>
- TloopCallbacks extends IloopCallbacks<Titem, TidxKey, Tinput, any, any> = IloopCallbacks<Titem, TidxKey, Tinput, any, any>
Parameters
- input: Tinput
- Optionaloptions: Toptions
- Optionalcallbacks: TloopCallbacks
Returns GetLoopGenerator<Tinput, Toptions, TloopCallbacks>
- Defined in src/code/loopzen/loop.ts:728