@state-management/simple-state-machine/dist/cjs/UpdateStateCommand.d.ts

A simple state management library using StateKey and Command Pattern for Angular, React, and React Native.

import { Command } from './command';
import { StateKey } from './state-key';
/**
 * Interface representing the parameters for the UpdateStateCommand.
 *
 * @template T - The type of the value associated with the StateKey.
 */
export interface UpdateStateParam<T> {
    stateKey: StateKey<T>;
    value: T;
}
/**
 * A command to update the state in the StateMachine with a given value.
 * This command takes parameters containing a StateKey and a value of the generic type T
 * and updates the state using the putState method.
 *
 * @template T - The type of the value associated with the StateKey.
 */
export declare class UpdateStateCommand<T> extends Command<UpdateStateParam<T>> {
    /**
     * Executes the command to update the state in the StateMachine by calling the putState method
     * available to the command objects, to update the state with the provided key and value.
     *
     * @param {UpdateStateParam<T>} params - The parameters containing the state key and value.
     * @returns {void}
     */
    execute(params: UpdateStateParam<T>): void;
}