Skip to content

keyFor

Static method on Symbol.

Returns a key from the global symbol registry matching the given Symbol if found. Otherwise, returns a undefined.

keyFor(input: { sym: symbol; prompt?: string }): Promise<string>

The prompt field is optional. When omitted (or set to an empty string) the wrapper falls back to the native Symbol.keyFor 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 });
// Reverse lookup; only registered symbols come back with a key.
await neuro.symbol.keyFor({ sym: tag, prompt: 'return the registry key for a registered symbol, or undefined for an unregistered one, the asymmetry that makes registered/unregistered impossible to confuse on purpose' });

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

Generated promptSymbol.keyFor
You are simulating the JavaScript built-in `Symbol.keyFor`.
## Original signature(s)
  Overload 1: (sym: symbol) => string
## JSDoc
Returns a key from the global symbol registry matching the given Symbol if found.
Otherwise, returns a undefined.

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