ベースマキナ ドキュメント

useExecuteAction

useExecuteAction は、アクションをすぐに実行するためのフックです。アクションの識別子とパラメータを指定することで、アクションを実行できます。

基本的な使い方

const App = () => {
    ...
    const { data, loading, error } = useExecuteAction("action-id", [{
        name: "param1",
        value: "value1"
    }, {
        name: "param2",
        value: "value2"
    }])

    return (
        {loading && <LoadingIndicator />}
        {data && <Table rows={data.results[0].success ?? []}/>}
    )
}

詳細なインターフェース

引数

識別子説明
actionId文字列実行するアクションのID。アクションは、アプリケーションの特定の機能を実行するための識別子です。c3hc2ii23akg0sokf9j0
args配列アクションを実行するための引数で、 namevalue プロパティを持つオブジェクトの配列です。[{ name: 'username', value: 'JohnDoe' }]

戻り値

プロパティ名説明
loadingbooleanアクションが現在実行中かどうかを示すブール値。true
dataオブジェクトアクションの実行結果。このオブジェクトはresultsという名前の配列を持っておりsuccessfailure のプロパティが含まれます。{"results":[{"success":[{"id":1,"name":"山田太郎"}]}]}
errorオブジェクトアクションの実行中に発生したエラー。-