ドキュメントの検索
karat

+

K

APIリファレンス ↗

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

3 - 関数の構造

📖 タスクの概要

ユーザーのリポジトリには、すでに ../src/index.ts ファイルに記述されたサンプルの関数があります。これらを探索し、"Hello World" の例を解剖してテストする基礎として使用しましょう。

🔨 タスクの説明

  1. 左のファイルパネルで ../src/index.ts ファイルをクリックして開きます。 ../src/__tests__/index.ts を選択しないように注意してください。

    • このファイルにはすでにいくつかの「コメント化された」コードが書かれています。このトレーニングで最も簡単な方法は、コードブロック全体を置き換えてクリーンな出発点を得ることです。
  2. index.ts ファイルを開いたまま、 ctrl+a (Mac の場合は cmd+a )でコードブロック全体をハイライトし、キーボードのDelete キーを押します。

  3. 以下のコードブロックをコピーして、空のエディタに貼り付けます。

    import { Function, Integer } from "@foundry/functions-api";
    import { } from "@foundry/ontology-api";
    
    export class MyFunctions {
        @Function()
        public myFunction(n: Integer): Integer {
            return n + 1;
        }
    }
    

    この数行のコードで、関数の基本構造がわかります。

  4. 画面下部のヘルパーツールバーにある fx 関数 タブをクリックします。関数ヘルパーのライブプレビュータブでは、リポジトリ内の関数をプレビューしてテストできます。関数をテストする前に、リポジトリのコードアシスト機能が画面下部のバーで「実行中」の状態になっている必要があります。

    • ℹ️ コードアシストは、コードの問題を検出し、プレビューを実行するために不可欠です。コードアシストなしでコードを書くことはできますが、作業を完了するためには実行中である必要があります。コードアシストのステータスにマウスを置くと、初期化の進行状況が表示されます。コードアシストが初期化に失敗した場合は、サポートリクエストを提出してください。
  5. コードアシストが実行中で、関数ヘルパーがライブプレビュータブに開いている状態で、サンプル関数(「myFunction」)の名前をクリックします。

    • ヘルパーウィンドウの右側に、関数の入力値を入力するフォームが表示されます。フォームでは入力値が n と表示されているのは、関数内で与えられた変数名がそうだからです(つまり、 (n: Integer) )。
  6. n フィールドの 0 を任意の整数に置き換え、青い Run ▶ ボタンをクリックして関数をテストします。

  7. 関数ヘルパーウィンドウを下にスクロールし、出力を表示します。これは、関数で説明されているように、 n の値に 1 を加えたものになります(つまり、 { n+1 } )。

📚 推薦文献(約3分間の読み物)

Typescript の関数には、すべての入力パラメーターに明示的な型注釈が必要であり、明示的な戻り値の型を指定する必要があります。したがって、サポートされている入力および出力タイプを把握することが重要です。以下の Functions API ドキュメントからの選択部分を読むために少し時間を割いてください。後でオブジェクトタイプのエントリを見直す機会があります。読むときに、関連ドキュメントへのリンクを辿る必要はありません。