このトピックでは、OCI SDK for TypeScriptおよびJavaScriptの使用例をダウンロードして実行する方法について説明します。

GitHub

SDKの使用例は、次に示すGitHub にあります:

これらの例は、SDK用のダウンロード可能な.zipファイルにも含まれています。以前のSDKバージョンの例は、特定バージョン用のダウンロード可能.zipに含まれており、GitHub から入手できます。

まだ提供されていない別の例を参照したい場合は、GitHubに課題 を報告してください。

SDKリファレンス

GitHubの例に加え、SDK for TypeScript and JavaScript APIリファレンスには、コピーおよび変更して独自の環境で実行できるコード例が含まれます。

例の実行

ノート

Windowsを使用している場合は、次のコマンドを実行する前に、Git Bash for Windowsをインストールする必要があります。
  1. SDK for TypeScript and JavaScriptに対してgit cloneを実行します(git clone https://github.com/oracle/oci-typescript-sdk.git)
  2. oci-typescript-sdkリポジトリをインストールしたディレクトリに移動します。
  3. npm installを実行します
  4. npm run buildを実行します。
  5. TypeScriptをグローバルにインストールしていない場合は、次を実行します:
    npm install -g typescript@4.1.3.
    ノート

    OCI SDK for TypeScript and JavaScriptでは、TypeScriptバージョン4.1.3がテスト済で、サポート対象です。他のバージョンのTypeScriptの完全なサポートは、保証されません。
  6. オプションで、ts-nodeをグローバルにインストールして、例を簡単に実行できます:
    npm install -g ts-node
  7. ホーム・ディレクトリに構成ファイルを作成します。詳細は、SDKおよびCLIの構成ファイルを参照してください。
  8. TypeScriptの例を実行するには、ディレクトリをTypeScriptのサンプル・フォルダに変更します。例:
    
                                cd ./oci-typescript-sdk/examples/typescript/
                            
  9. 任意の例を実行します。
    たとえば、ts-nodeを実行している場合:
    ts-node "./identity.ts"
    ts-nodeを実行していない場合:
    tsc ./identity.ts
    node ./identity.js
  10. 一部の例はJavaScriptに対応しています。これらはoci-typescript-sdk/examples/javascriptフォルダにあります。前述の例と同等のJavaScriptを実行するには:
    
                                node "./identity.js"