Interface CommandRegistryBeta

Example: Add a command to the registry

import {
    Command,
    LimeObjectCommand,
    LimeObjectContext,
    PlatformServiceName,
} from '@limetech/lime-web-components';

@Command({ id: 'send-welcome-email' })
class SendWelcomeEmailCommand implements LimeObjectCommand {
    public context: LimeObjectContext;
    public template: string;
}

declare module '@limetech/lime-web-components' {
    interface CommandRegistry {
        'send-welcome-email': SendWelcomeEmailCommand;
    }
}

const commandBus = platform.get(PlatformServiceName.CommandBus);

// The registry entry makes the id pick the type, so `command` is a
// SendWelcomeEmailCommand and `params` is checked against its properties.
const command = commandBus.createCommand({
    id: 'send-welcome-email',
    params: { template: 'welcome' },
});
Copy