Function overrideState

overrideState<T extends unknown = any>(
stateSchema?: TStateSchema<T>,
): IStateSchema<T>
Overrides an existing state schema in the swarm system with a new or partial schema. This function updates the configuration of a state identified by its stateName, applying the provided schema properties. It operates outside any existing method or execution contexts to ensure isolation, leveraging beginContext for a clean execution scope. Logs the override operation if logging is enabled in the global configuration.
Type Parameters
- T extends unknown = any
  The type of the state data, defaults to any.
Parameters
- OptionalstateSchema: TStateSchema<T>
  The schema containing the state’s unique name and optional properties to override.
  - stateName
    The unique identifier of the state to override, matching IStateSchema<T>["stateName"].
Returns IStateSchema<T>
The updated state schema as applied by the swarm’s state schema service.
Throws
If the state schema service encounters an error during the override operation (e.g., invalid stateName or schema).
Example
```
// Override a state’s schema with new properties
overrideState({
  stateName: "UserPreferences",
  persist: true,
  getDefaultState: () => ({ theme: "dark" }),
});
// Logs the operation (if enabled) and updates the state schema in the swarm.
```
- Defined in types.d.ts:11445