Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Interface CommandConfig<TCommand, TKey>

    Config for describing a command.

    Used with CommandBus.createCommand to create command instances from configuration data. This is useful for storing command definitions or transmitting them across boundaries.

    interface CommandConfig<TCommand = any, TKey extends string = string> {
        id: TKey;
        params?: { [K in string | number | symbol]?: TCommand[K] };
    }

    Type Parameters

    • TCommand = any
    • TKey extends string = string
    Index

    Properties

    id params?

    Properties

    id: TKey

    Id of the command.

    Specified by the Command decorator when declaring the command.

    params?: { [K in string | number | symbol]?: TCommand[K] }

    Optional parameters to set when creating the command from the config.

    All values must be serializable (primitive types, plain objects, arrays). This matches the requirement that all command properties must be serializable as defined in AnyCommand.

    Settings

    Member Visibility

    On This Page

    Properties