take

neuro.iterator.take

Instance method on Iterator.prototype.

Creates an iterator whose values are the values from this iterator, stopping once the provided limit is reached.

Signatures

take(input: { iterator: <receiver>; limit: number; prompt?: string }): Promise<IteratorObject<T, undefined, unknown>>

The prompt field is optional. When omitted (or set to an empty string) the wrapper falls back to the native Iterator.prototype.take and returns a resolved Promise without contacting the LLM. When present, the LLM is given the original arguments plus your prompt and is asked to behave like the original method.

Example

import { configureClient, neuro } from 'neuro-ts';

configureClient({ apiKey: process.env.OPENAI_API_KEY });

// Bounded prefix; the lazy slice(0, n) that respects infinite iterators.
await neuro.iterator.take({ iterator: stream, limit: 10, prompt: "yield at most limit values then stop, the lazy \`slice(0, limit)\` that does not need to know the total length -- works on infinite iterators, returns early on finite ones" });

System prompt

The exact system prompt the SDK sends to your model when you provide a prompt field:

Generated promptIterator.prototype.take

You are simulating the JavaScript built-in `Iterator.prototype.take`.
## Original signature(s)
  Overload 1: (limit: number) => IteratorObject<T, undefined, unknown>
## JSDoc
Creates an iterator whose values are the values from this iterator, stopping once the provided limit is reached.

## How to respond
- Behave EXACTLY as the original `take` would, but use the user's intent to choose any callback / comparator / transform logic that the original would normally accept as an argument.
- Strictly preserve the original return type and shape.
- Output ONLY the JSON-encoded return value of the function call.
- Do NOT include explanations, prose, comments, or markdown fences.
- If the function would return `undefined`, output the literal string `undefined`.
- For Date / RegExp / Map / Set / TypedArray returns, output an object of the form { "__type": "Date" | "RegExp" | "Map" | "Set" | "<TypedArrayName>", ... } so the SDK can rehydrate it.