Skip to main content

CommandsViewApi

interface

Runs a registered command by id, including commands the host and other mods own. This is the escape hatch for behaviour that has no host action behind it. The command id and its arguments are untyped, so when an action exists for what you want, `ctx.action(...)` is the better call: it checks the input and the result against the action's schema.

interface CommandsViewApi

Import

import { CommandsViewApi } from '@modular/sdk/view';

Members1

execute
<T>(commandId: string, ...args: readonly unknown[]) => Promise<T>

Executes `commandId` with `args` and resolves with what it returned.

Notes

category
Context