ユーザー向けエラーをスローする

Functions を Workshop や Actions などのプラットフォームの他の部分で実行する際に、詳細なメッセージを含むエラーをスローしたい場合があります。その場合、@foundry/functions-api パッケージから UserFacingError をスローしてください。例えば：

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
    // Employeeを編集するためのデコレータ
    @Edits(Employee)
    // オントロジー編集関数のデコレータ
    @OntologyEditFunction()
    // 正確に5人の従業員を編集する関数
    public editExactlyFiveEmployees(employees: Employee[]): void {
        // 渡された従業員の数が5人でない場合、エラーをスローします
        if (employees.length != 5) {
            throw new UserFacingError(`Pass in exactly 5 employees. Received ${employees.length}.`);
        }
        ...
    }

この機能をワークショップアプリケーションのFunction-backed Actionとして実行する際に、従業員の数が間違っていると、ユーザーは次のエラーが表示されます：

詳細なユーザー向けのエラーメッセージを追加することで、ユーザーの関数の他のユーザーが問題を迅速に特定し、修正するのを助けることができます。