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

createReviewRequest

createReviewRequest は、アクションのレビュー依頼を作成する関数です。

※レビュー依頼を作成するには、事前に対象のアクションにレビュー設定が必要です。

基本的な使い方

import { createReviewRequest } from "@basemachina/action";
 
/** @type { import("@basemachina/action").Handler } */
export default async ({ message }) => {
  const { reviewRequestId } = await createReviewRequest(
    "review-test",
    { message },
    { description: "内容を確認してください" },
  );
  return { reviewRequestId };
};

詳細なインターフェース

引数

引数名型必須 ・ 任意説明例
actionIdstring必須実行するアクションのID、または識別子。'c3hc2ii23akg0sokf9j0', 'get-user'
argsobject任意アクションを実行するための引数で、 キーがパラメータ名、値がパラメータに渡す値のオブジェクト。{ username: 'JohnDoe' }
optionsobject任意レビュー依頼の詳細設定。{ description: 'レビュー依頼の説明' }
options.descriptionstring任意レビュー依頼の説明。最大文字数は1000文字です。指定しない場合、レビュー設定のデフォルト値が使用されます。'レビュー依頼の説明'
options.neverExpiresboolean任意レビュー依頼の期限を無期限に指定します。expiresIn と同時に指定することはできません。指定しない場合、レビュー設定のデフォルト値が使用されます。true, false
options.expiresInDate | string | number任意レビュー依頼の期限。stringはDate型に変換できる値、numberはUnixTimestamp (秒)を入力してください。時間は過去に設定できません。また、neverExpires と同時に指定できません。new Date(), '2030-01-01', 1893456000

なおパラメータの種類ごとにargsへ渡せる値の型は以下です。

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

戻り値

プロパティ名型説明例
reviewRequestIdstring作成したレビュー依頼のID。cpt8gkab5gv1ibk8r5h0
createActionJobwait