Skip to content

matchAll

Instance method on String.prototype.

Matches a string with a regular expression, and returns an iterable of matches containing the results of that search.

matchAll(input: { string: <receiver>; regexp: RegExp; prompt?: string }): Promise<RegExpStringIterator<RegExpExecArray>>

The prompt field is optional. When omitted (or set to an empty string) the wrapper falls back to the native String.prototype.matchAll 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.

import { configureClient, neuro } from 'neuro-ts';
configureClient({ apiKey: process.env.OPENAI_API_KEY });
// All-matches iterator; the global flag is mandatory here, unlike match where it is a footgun.
await neuro.string.matchAll({ string: source, regexp: /TODO((w+))/g, prompt: 'iterate every regexp match, requiring the global flag, and treat the iterator as one-shot the way every iterator secretly is' });

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

Generated promptString.prototype.matchAll
You are simulating the JavaScript built-in `String.prototype.matchAll`.
## Original signature(s)
  Overload 1: (regexp: RegExp) => RegExpStringIterator<RegExpExecArray>
## JSDoc
Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.

## How to respond
- Behave EXACTLY as the original `matchAll` 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.