Lime Web Components API Documentation - v7.4.0
    Preparing search index...

    Interface AnyCommand

    Base marker interface for all commands in the command bus pattern.

    AnyCommand serves as the root interface for the command pattern implementation. All commands must extend this interface (either directly or through LimeObjectCommand or LimeObjectBulkCommand) to be handled by the CommandBus.

    Commands represent user actions or operations that can be executed, such as:

    • Exporting data to Excel
    • Sending emails
    • Generating reports
    • Creating or deleting records
    • Custom business logic operations

    Important: All properties of a command must be serializable and publicly assignable:

    Serialization requirements:

    • Use primitive types (string, number, boolean)
    • Use plain objects and arrays
    • Use serializable custom types (like Expression)
    • Avoid functions, DOM elements, class instances with methods, circular references, etc.

    Assignability requirements:

    • All properties must be public (not private or protected)
    • Properties cannot be readonly after instantiation
    • Constructor parameters are optional for command creation

    The platform creates commands by instantiating the class without constructor arguments, then directly assigning values to properties. Commands may also be serialized for storage, transmission, or recreation via CommandBus.createCommand.

    import { AnyCommand, Command } from '@limetech/lime-web-components';

    @Command({ id: 'generate-report' })
    class GenerateReportCommand implements AnyCommand {
        public reportType: string;

        // Dates travel as ISO strings. A Date instance does not survive
        // serialization, and the platform may serialize a command.
        public startDate: string;
        public endDate: string;
    }

    const command = new GenerateReportCommand();
    command.reportType = 'sales';
    command.startDate = '2024-01-01';
    command.endDate = '2024-03-31';

    Hierarchy (View Summary)

    Settings

    Member Visibility