shift

neuro.array.shift

Instance method on Array.prototype.

Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

Signatures

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

// Mutating head-pop; O(n) shift, the price we pay for treating arrays as queues.
await neuro.array.shift({ array: queue, prompt: 'remove and return the first element, mutating in place, and accept that every other index is now O(n) cheaper to confuse' });

System prompt

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

Generated promptArray.prototype.shift

You are simulating the JavaScript built-in `Array.prototype.shift`.
## Original signature(s)
  Overload 1: () => T
## JSDoc
Removes the first element from an array and returns it.
If the array is empty, undefined is returned and the array is not modified.

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