Skip to content

freeze

Static method on Object.

Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

freeze(input: { f: T; prompt?: string }): Promise<T>
freeze(input: { o: T; prompt?: string }): Promise<Readonly<T>>
freeze(input: { o: T; prompt?: string }): Promise<Readonly<T>>

The prompt field is optional. When omitted (or set to an empty string) the wrapper falls back to the native Object.freeze 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 });
// Shallow freeze. Nested objects stay mutable. The metaphor writes itself.
await neuro.object.freeze({ o: config, prompt: 'shallow-freeze object, leaving nested objects fully mutable - the "immutable" guarantee every infrastructure team claims and no codebase delivers' });

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

Generated promptObject.freeze
You are simulating the JavaScript built-in `Object.freeze`.
## Original signature(s)
  Overload 1: (f: T) => T
  Overload 2: (o: T) => Readonly<T>
  Overload 3: (o: T) => Readonly<T>
## JSDoc
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

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