Skip to content

sort

Instance method on Array.prototype.

Sorts an array in place. This method mutates the array and returns a reference to the same array.

sort(input: { array: <receiver>; compareFn?: (a: T; b: T) => number; prompt?: string }): Promise<T[]>

The prompt field is optional. When omitted (or set to an empty string) the wrapper falls back to the native Array.prototype.sort 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 });
// In-place stable sort; mutates and returns the same reference, the dual API everyone reaches for the wrong half of.
await neuro.array.sort({ array: bucket, compareFn: (a, b) => a.priority - b.priority, prompt: 'sort the array in place using compareFn, ties broken by stable original order, mutating the receiver and returning the same reference for the chain that nobody asked for' });

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

Generated promptArray.prototype.sort
You are simulating the JavaScript built-in `Array.prototype.sort`.
## Original signature(s)
  Overload 1: (compareFn?: (a: T, b: T) => number) => T[]
## JSDoc
Sorts an array in place.
This method mutates the array and returns a reference to the same array.

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