デコレーター

TypeScript ↗ 関数は、TypeScript クラス ↗のメソッドとして宣言されます。関数が検出され、公開されるには、次の要件を満たす必要があります。

• メソッドは public である必要があります。
• メソッドが属するクラスは、functions-typescript/src/index.ts ファイルからエクスポートされている必要があります。
• メソッドには、@foundry/functions-api パッケージからインポートした次のいずれかのデコレーターを付ける必要があります。
  • 汎用関数には @Function() を使用します。
  • アクションの実行に使用される関数には @OntologyEditFunction() を使用します。
    • @OntologyEditFunction() メソッドを使用する場合、@Edits([object type]) デコレーターでオブジェクトの来歴情報を任意で指定できます。
    • @Edits([object type]) デコレーターがない場合、コードの静的解析により、可能な範囲でオブジェクトの来歴情報が推論されます。
  • Foundry API を通じて実行する読み取り専用クエリには @Query({ apiName: "userDefinedAPIName"}) を使用します。このデコレーターは @Function デコレーターと併用せず、単独で使用する必要があります。

この方法で正しくエクスポートされた関数の例を次に示します。

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import { Function, OntologyEditFunction, Query, Integer, Edits } from "@foundry/functions-api";
import { Employee, Objects, ObjectSet } from "@foundry/ontology-api";

export class MyUsefulFunctions {
    @Function()
    public incrementNumber(x: Integer): Integer {
        return x + 1;
    }

    @Edits(Employee)
    @OntologyEditFunction()
    public updateName(employee: Employee, newName: string): void {
        employee.firstName = newName;
    }

    @Query({ apiName: "getEmployeesByName" })
    public async getEmployeesByName(name: string): Promise<ObjectSet<Employee>> {
        return Objects.search().employee().filter(employee => employee.firstName.exactMatch(name));
    }
}

private のメソッドや、該当するデコレーターが付けられていないメソッドは、関数レジストリに公開されません。これにより、ユーザーは再利用や整理のためにヘルパー関数やユーティリティを作成できます。