Skip to Content

readFile

外部ファイルの内容を読み込む関数です。JavaScriptアクションやコードエディターのビューのコードを別ファイルで管理できます。

使用例

import { defineAction, readFile } from "@basemachina/sdk/oac"; // JavaScriptアクションのコードを読み込む export const createUser = defineAction({ id: "create-user", name: "ユーザー作成", type: "javascript", code: readFile("./js-action-codes/create-user.ts"), });
import { defineView, readFile } from "@basemachina/sdk/oac"; // コードエディターのビューのコードを読み込む export const userListView = defineView({ type: "codeEditor", id: "user-list", name: "ユーザー一覧", code: readFile("./view-codes/user-list.tsx"), });

引数

引数型説明
relativePathstring呼び出し元ファイルからの相対パス

TypeScriptファイルの変換

拡張子が.ts / .tsx / .mts / .ctsのファイルを指定した場合は、型注釈を取り除いたJavaScriptに変換してからcodeに渡します。

これにより、JavaScriptアクションのコードをTypeScriptで記述できます。

JSXはそのまま残ります。.tsxで書いたビューのコードも、変換後はJSXを含むJavaScriptとして保存されます。

変換後のコードは、元のファイルとインデントや空行の位置が一致するとは限りません。コードエディターで開いたときの見た目が元のファイルと異なる場合がありますが、動作に影響はありません。

拡張子が.js / .jsxのファイルは変換せず、内容をそのまま読み込みます。