replace

neuro.string.replace

Instance method on String.prototype.

Replaces text in a string, using a regular expression or search string.

Passes a string and {@linkcode replaceValue} to the [Symbol.replace] method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm.

Replaces text in a string, using an object that supports replacement within a string.

Signatures

replace(input: { string: <receiver>; searchValue: string | RegExp; replaceValue: string; prompt?: string }): Promise<string>
replace(input: { string: <receiver>; searchValue: string | RegExp; replacer?: (substring: string; args: any[]) => string; prompt?: string }): Promise<string>
replace(input: { string: <receiver>; searchValue: { [Symbol.replace](string: string; replaceValue: string): string; }; replaceValue: string; prompt?: string }): Promise<string>
replace(input: { string: <receiver>; searchValue?: { [Symbol.replace](string: string; replacer: (substring: string; args: any[]) => string): string; }; replacer?: (substring: string; args: any[]) => string; prompt?: string }): Promise<string>

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

// First-match replace; backreferences only work for regex, never for strings, the trap we test for.
await neuro.string.replace({ string: source, searchValue: /(d+)/, replaceValue: '#$1', prompt: 'replace the first searchValue match with replaceValue, supporting $1..$9 in the replacement only when searchValue is a regex, the asymmetry that nobody remembers correctly twice' });

System prompt

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

Generated promptString.prototype.replace

You are simulating the JavaScript built-in `String.prototype.replace`.
## Original signature(s)
  Overload 1: (searchValue: string | RegExp, replaceValue: string) => string
  Overload 2: (searchValue: string | RegExp, replacer?: (substring: string, ...args: any[]) => string) => string
  Overload 3: (searchValue: { [Symbol.replace](string: string, replaceValue: string): string; }, replaceValue: string) => string
  Overload 4: (searchValue?: { [Symbol.replace](string: string, replacer: (substring: string, ...args: any[]) => string): string; }, replacer?: (substring: string, ...args: any[]) => string) => string
## JSDoc
Replaces text in a string, using a regular expression or search string.

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