アクション
データソース別の設定
JavaScript
組み込み関数
executeAction

executeAction

executeAction はアクションを実行する関数です。

アクションの実行結果の値をパラメーターの値として別のアクションを実行するなどのワークフローを作成できます。

executeAction関数経由でのアクションの実行でも、ログイン中のユーザーが実行権限を持っているか検証されます。 例外として、ユーザー自身は権限を持っていなくても、呼び出し元のJavaScriptアクションが許可されている場合には実行できます。

基本的な使い方

以下は、商品の画像ファイルを保存するアクションの例です。

最初にストレージへ画像ファイルをアップロードするアクションを実行し、その後保存したファイルのパスをDBへ保存するアクションを実行しています。

// executeAction関数をインポート
import { executeAction } from "@basemachina/action";
 
/** @type { import("@basemachina/action").Handler } */
export default async ({ id, image }) => {
  // ①ストレージに画像ファイルをアップロード
  const uploadResults = await executeAction("upload-product-image", {
    id: id,
    image: image,
  });
 
  // ②保存した画像ファイルのストレージのパスをDBに保存
  const insertResults = await executeAction("insert-product-image", {
    id: id,
    // ①のアクションの結果の画像ファイルのパスを使用する
    path: uploadResults[0].success.objectKey,
  });
  return insertResults[0].success;
};

詳細なインターフェース

引数

引数名型説明例
actionIdstring実行するアクションのID、または識別子。c3hc2ii23akg0sokf9j0, get-user
argsobjectアクションを実行するための引数で、 キーがパラメータ名、値がパラメータに渡す値のオブジェクトです。{ username: 'JohnDoe' }

なおパラメータの入力値の種類ごとにargsのプロパティの値に渡せる値の型は以下です。

入力値の種類型説明例
テキストstring-{ company_name: '株式会社ベースマキナ' }
数値number | null-{ user_id: 123 }
日付Date | string | number | nullstringはDate型に変換できる値、numberはUnixTimestamp (秒)を入力してください。{ created: '2023-01-01', updated: new Date(), deleted: 1609459200 }
ファイルFile | null-{ upload_text: new File(['test'], 'test.txt', { type: 'text/plain' }) }
真偽値boolean-{ checked: true }
JSON値string | number | Date | nullJSON値の種類ごとに型が異なります。
テキストならstring | null、数値ならnumber | null、日付ならstring | number | Date | nullを渡せます。
日付の場合stringはDate型に変換できる値、numberはUnixTimestamp (秒)を入力してください。　		{ company_name: '株式会社ベースマキナ', user_id: 123, created: '2023-01-01', deleted: null }
SQLstring-{ query: 'SELECT * FROM users;' }
システム値string-{ offset: '20' }
配列Array各要素の種類の型は、各入力値の種類の型と同じです。{ user_ids: [10, 11, 12] }
タプルArray各要素の種類の型は、各入力値の種類の型と同じです。{ id_and_name: [123, 'taro'] }

戻り値

プロパティ名型説明例
resultsArrayアクションの実行結果の配列。各要素にはsuccess と failure のプロパティが含まれます。[{"success":[{"id":1,"name":"山田太郎"}]}]
JavaScriptwait