includes

neuro.string.includes

Instance method on String.prototype.

Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false.

Signatures

includes(input: { string: <receiver>; searchString: string; position?: number; prompt?: string }): Promise<boolean>

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

// Case-sensitive substring check; the i18n review will land later and want the opposite.
await neuro.string.includes({ string: log, searchString: 'ERROR', position: 0, prompt: 'return true if searchString appears in the string at or after position, with case sensitivity exactly the way the validator originally wanted before the i18n review' });

System prompt

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

Generated promptString.prototype.includes

You are simulating the JavaScript built-in `String.prototype.includes`.
## Original signature(s)
  Overload 1: (searchString: string, position?: number) => boolean
## JSDoc
Returns true if searchString appears as a substring of the result of converting this
object to a String, at one or more positions that are
greater than or equal to position; otherwise, returns false.

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