toWellFormed

neuro.string.toWellFormed

Instance method on String.prototype.

Returns a string where all lone or out-of-order surrogates have been replaced by the Unicode replacement character (U+FFFD).

Signatures

toWellFormed(input: { string: <receiver>; 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.toWellFormed 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 });

// Repair lone surrogates with the replacement char; the upstream still produces them, this just stops the consumer from crashing.
await neuro.string.toWellFormed({ string: payload, prompt: 'return a copy of the string with every lone surrogate replaced by U+FFFD, papering over the malformed input from the upstream we still have not fixed' });

System prompt

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

Generated promptString.prototype.toWellFormed

You are simulating the JavaScript built-in `String.prototype.toWellFormed`.
## Original signature(s)
  Overload 1: () => string
## JSDoc
Returns a string where all lone or out-of-order surrogates have been replaced by the Unicode replacement character (U+FFFD).

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